Back to index

lightning-sunbird  0.9+nobinonly
nsCaretAccessible.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef __nsCaretAccessible_h__
00039 #define __nsCaretAccessible_h__
00040 
00041 #include "nsBaseWidgetAccessible.h"
00042 #include "nsIWeakReference.h"
00043 #include "nsIDOMNode.h"
00044 #include "nsIAccessibleCaret.h"
00045 #include "nsISelectionListener.h"
00046 #include "nsRect.h"
00047 
00048 class nsRootAccessible;
00049 
00050 /*
00051  * This special accessibility class is for the caret, which is really the currently focused selection.
00052  * There is only 1 visible caret per top level window (nsRootAccessible)
00053  * The caret accesible does not exist within the normal accessible tree; it lives in a different world.
00054  * In MSAA, it is retrieved with via the WM_GETOBJECT message with lParam = OBJID_CARET, 
00055  * (as opposed to the root accessible tree for a window which is retrieved with OBJID_CLIENT)
00056  * The caret accessible is owned by the nsRootAccessible for the top level window that it's in.
00057  */
00058 
00059 class nsCaretAccessible : public nsLeafAccessible, public nsIAccessibleCaret, public nsISelectionListener
00060 {
00061 public:
00062   NS_DECL_ISUPPORTS_INHERITED
00063 
00064   nsCaretAccessible(nsIDOMNode* aDocumentNode, nsIWeakReference* aShell, nsRootAccessible *aRootAccessible);
00065 
00066   /* ----- nsIAccessible ----- */
00067   NS_IMETHOD GetParent(nsIAccessible **_retval);
00068   NS_IMETHOD GetRole(PRUint32 *_retval);
00069   NS_IMETHOD GetState(PRUint32 *_retval);
00070   NS_IMETHOD GetBounds(PRInt32 *x, PRInt32 *y, PRInt32 *width, PRInt32 *height);
00071   NS_IMETHOD GetNextSibling(nsIAccessible **_retval);
00072   NS_IMETHOD GetPreviousSibling(nsIAccessible **_retval);
00073 
00074   /* ----- nsIAccessibleCaret ------ */
00075   NS_IMETHOD AttachNewSelectionListener(nsIDOMNode *aFocusedNode);
00076   NS_IMETHOD RemoveSelectionListener();
00077 
00078   /* ----- nsISelectionListener ---- */
00079   NS_DECL_NSISELECTIONLISTENER
00080 
00081   /* ----- nsIAccessNode ----- */
00082   NS_IMETHOD Init()
00083   {
00084 #ifdef DEBUG
00085     mIsInitialized = PR_TRUE;
00086 #endif
00087     return NS_OK;
00088   }
00089   NS_IMETHOD Shutdown();
00090 
00091 private:
00092   nsRect mCaretRect;
00093   PRBool mVisible;
00094   nsCOMPtr<nsIDOMNode> mCurrentDOMNode;
00095   // mListener is not a com pointer. It's a copy of the listener in the nsRootAccessible owner. 
00096   //See nsRootAccessible.h for details of the lifetime if this listener
00097   nsRootAccessible *mRootAccessible;
00098   nsCOMPtr<nsIWeakReference> mDomSelectionWeak;
00099 };
00100 
00101 #endif