Back to index

lightning-sunbird  0.9+nobinonly
nsDocAccessibleWrap.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 /* For documentation of the accessibility architecture, 
00040  * see http://lxr.mozilla.org/seamonkey/source/accessible/accessible-docs.html
00041  */
00042 
00043 #ifndef _nsDocAccessibleWrap_H_
00044 #define _nsDocAccessibleWrap_H_
00045 
00046 #include "ISimpleDOMDocument.h"
00047 #include "nsDocAccessible.h"
00048 #include "nsIDocShellTreeItem.h"
00049 
00050 class nsDocAccessibleWrap: public nsDocAccessible,
00051                            public ISimpleDOMDocument
00052 {
00053 public:
00054     nsDocAccessibleWrap(nsIDOMNode *aNode, nsIWeakReference *aShell);
00055     virtual ~nsDocAccessibleWrap();
00056 
00057     // IUnknown
00058     STDMETHODIMP_(ULONG) AddRef();
00059     STDMETHODIMP_(ULONG) Release();
00060     STDMETHODIMP      QueryInterface(REFIID, void**);
00061 
00062     static PRInt32 GetChildIDFor(nsIAccessible* aAccessible);
00063 
00064     void GetXPAccessibleFor(const VARIANT& varChild, nsIAccessible **aXPAccessible);
00065 
00066     // ISimpleDOMDocument
00067     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_URL( 
00068         /* [out] */ BSTR __RPC_FAR *url);
00069     
00070     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_title( 
00071         /* [out] */ BSTR __RPC_FAR *title);
00072     
00073     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_mimeType( 
00074         /* [out] */ BSTR __RPC_FAR *mimeType);
00075     
00076     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_docType( 
00077         /* [out] */ BSTR __RPC_FAR *docType);
00078     
00079     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_nameSpaceURIForID( 
00080         /* [in] */ short nameSpaceID,
00081         /* [out] */ BSTR __RPC_FAR *nameSpaceURI);
00082 
00083     virtual /* [id] */ HRESULT STDMETHODCALLTYPE put_alternateViewMediaTypes( 
00084         /* [in] */ BSTR __RPC_FAR *commaSeparatedMediaTypes);
00085 
00086     // IAccessible
00087     // Override get_accChild so that it can get any child via the unique ID
00088     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accChild( 
00089         /* [in] */ VARIANT varChild,
00090         /* [retval][out] */ IDispatch __RPC_FAR *__RPC_FAR *ppdispChild);
00091 
00092     NS_IMETHOD Shutdown();
00093     NS_IMETHOD FireToolkitEvent(PRUint32 aEvent, nsIAccessible* aAccessible, void* aData);
00094     NS_IMETHOD FireDocLoadingEvent(PRBool isFinished);
00095     NS_IMETHOD FireAnchorJumpEvent();
00096 
00097 private:
00098     static void DocLoadCallback(nsITimer *aTimer, void *aClosure);
00099     already_AddRefed<nsIAccessible> GetFirstLeafAccessible(nsIDOMNode *aStartNode);
00100     nsCOMPtr<nsITimer> mDocLoadTimer;
00101     PRPackedBool mWasAnchor;
00102 };
00103 
00104 #endif