Back to index

lightning-sunbird  0.9+nobinonly
nsDocAccessible.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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) 2003
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Original Author: Aaron Leventhal (aaronl@netscape.com)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef _nsDocAccessible_H_
00040 #define _nsDocAccessible_H_
00041 
00042 #include "nsBaseWidgetAccessible.h"
00043 #include "nsIAccessibleDocument.h"
00044 #include "nsPIAccessibleDocument.h"
00045 #include "nsIAccessibleEvent.h"
00046 #include "nsIArray.h"
00047 #include "nsIDocument.h"
00048 #include "nsIDocumentObserver.h"
00049 #include "nsIEditor.h"
00050 #include "nsIObserver.h"
00051 #include "nsIScrollPositionListener.h"
00052 #include "nsITimer.h"
00053 #include "nsIWeakReference.h"
00054 
00055 class nsIScrollableView;
00056 
00057 const PRUint32 kDefaultCacheSize = 256;
00058 
00059 class nsDocAccessible : public nsBlockAccessible,
00060                         public nsIAccessibleDocument,
00061                         public nsPIAccessibleDocument,
00062                         public nsIDocumentObserver,
00063                         public nsIObserver,
00064                         public nsIScrollPositionListener,
00065                         public nsSupportsWeakReference
00066 {  
00067   NS_DECL_ISUPPORTS_INHERITED
00068   NS_DECL_NSIACCESSIBLEDOCUMENT
00069   NS_DECL_NSPIACCESSIBLEDOCUMENT
00070   NS_DECL_NSIOBSERVER
00071 
00072   public:
00073     nsDocAccessible(nsIDOMNode *aNode, nsIWeakReference* aShell);
00074     virtual ~nsDocAccessible();
00075 
00076     NS_IMETHOD GetRole(PRUint32 *aRole);
00077     NS_IMETHOD GetName(nsAString& aName);
00078     NS_IMETHOD GetValue(nsAString& aValue);
00079     NS_IMETHOD GetState(PRUint32 *aState);
00080     NS_IMETHOD GetFocusedChild(nsIAccessible **aFocusedChild);
00081     NS_IMETHOD GetParent(nsIAccessible **aParent);
00082 
00083     // ----- nsIScrollPositionListener ---------------------------
00084     NS_IMETHOD ScrollPositionWillChange(nsIScrollableView *aView, nscoord aX, nscoord aY);
00085     NS_IMETHOD ScrollPositionDidChange(nsIScrollableView *aView, nscoord aX, nscoord aY);
00086 
00087     // nsIDocumentObserver
00088     NS_DECL_NSIDOCUMENTOBSERVER
00089 
00090     NS_IMETHOD FireToolkitEvent(PRUint32 aEvent, nsIAccessible* aAccessible, void* aData);
00091     static void FlushEventsCallback(nsITimer *aTimer, void *aClosure);
00092 
00093     // nsIAccessNode
00094     NS_IMETHOD Shutdown();
00095     NS_IMETHOD Init();
00096 
00097     // nsPIAccessNode
00098     NS_IMETHOD_(nsIFrame *) GetFrame(void);
00099 
00100   protected:
00101     virtual void GetBoundsRect(nsRect& aRect, nsIFrame** aRelativeFrame);
00102     virtual nsresult AddEventListeners();
00103     virtual nsresult RemoveEventListeners();
00104     void AddScrollListener();
00105     void RemoveScrollListener();
00106     void RefreshNodes(nsIDOMNode *aStartNode, PRUint32 aChangeEvent);
00107     static void ScrollTimerCallback(nsITimer *aTimer, void *aClosure);
00108     virtual void CheckForEditor();
00109     nsresult FireDelayedToolkitEvent(PRUint32 aEvent, nsIDOMNode *aDOMNode,
00110                                      void *aData, PRBool aAllowDupes = PR_FALSE);
00111 
00112     nsInterfaceHashtable<nsVoidHashKey, nsIAccessNode> mAccessNodeCache;
00113     void *mWnd;
00114     nsCOMPtr<nsIDocument> mDocument;
00115     nsCOMPtr<nsITimer> mScrollWatchTimer;
00116     nsCOMPtr<nsITimer> mFireEventTimer;
00117     nsCOMPtr<nsIEditor> mEditor; // Editor, if there is one
00118     PRUint16 mScrollPositionChangedTicks; // Used for tracking scroll events
00119     PRPackedBool mIsContentLoaded;
00120     nsCOMArray<nsIAccessibleEvent> mEventsToFire;
00121 };
00122 
00123 #endif