accessible/src/msaa/nsDocAccessibleWrap.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Original Author: Aaron Leventhal (aaronl@netscape.com)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 /* For documentation of the accessibility architecture,
  40  * see http://lxr.mozilla.org/seamonkey/source/accessible/accessible-docs.html
  41  */
  42
  43 #ifndef _nsDocAccessibleWrap_H_
  44 #define _nsDocAccessibleWrap_H_
  45
  46 #include "ISimpleDOMDocument.h"
  47 #include "nsDocAccessible.h"
  48 #include "nsIDocShellTreeItem.h"
  49
  50 class nsDocAccessibleWrap: public nsDocAccessible,
  51                            public ISimpleDOMDocument
  52 {
  53 public:
  54     nsDocAccessibleWrap(nsIDOMNode *aNode, nsIWeakReference *aShell);
  55     virtual ~nsDocAccessibleWrap();
  56
  57     // IUnknown
  58     STDMETHODIMP_(ULONG) AddRef();
  59     STDMETHODIMP_(ULONG) Release();
  60     STDMETHODIMP      QueryInterface(REFIID, void**);
  61
  62     void GetXPAccessibleFor(const VARIANT& varChild, nsIAccessible **aXPAccessible);
  63
  64     // ISimpleDOMDocument
  65     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_URL(
  66         /* [out] */ BSTR __RPC_FAR *url);
  67
  68     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_title(
  69         /* [out] */ BSTR __RPC_FAR *title);
  70
  71     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_mimeType(
  72         /* [out] */ BSTR __RPC_FAR *mimeType);
  73
  74     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_docType(
  75         /* [out] */ BSTR __RPC_FAR *docType);
  76
  77     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_nameSpaceURIForID(
  78         /* [in] */ short nameSpaceID,
  79         /* [out] */ BSTR __RPC_FAR *nameSpaceURI);
  80
  81     virtual /* [id] */ HRESULT STDMETHODCALLTYPE put_alternateViewMediaTypes(
  82         /* [in] */ BSTR __RPC_FAR *commaSeparatedMediaTypes);
  83
  84     // IAccessible
  85     // Override get_accChild so that it can get any child via the unique ID
  86     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accChild(
  87         /* [in] */ VARIANT varChild,
  88         /* [retval][out] */ IDispatch __RPC_FAR *__RPC_FAR *ppdispChild);
  89
  90     // Override get_accValue to provide URL when no other value is available
  91     virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accValue(
  92         /* [optional][in] */ VARIANT varChild,
  93         /* [retval][out] */ BSTR __RPC_FAR *pszValue);
  94
  95     NS_IMETHOD FireAnchorJumpEvent();
  96 };
  97
  98 #endif