accessible/src/base/nsOuterDocAccessible.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 #ifndef _nsOuterDocAccessible_H_
  40 #define _nsOuterDocAccessible_H_
  41
  42 #include "nsAccessibleWrap.h"
  43 #include "nsIAccessible.h"
  44
  45 class nsIWeakReference;
  46
  47 class nsOuterDocAccessible : public nsAccessibleWrap
  48 {
  49   // XXX: why is it private?
  50   // CVS comment: <aaronl@netscape.com> 2003-04-01 14:15 Fixing bustage
  51   NS_DECL_ISUPPORTS_INHERITED
  52
  53 public:
  54   nsOuterDocAccessible(nsIDOMNode* aNode,
  55                        nsIWeakReference* aShell);
  56
  57   // nsIAccessible
  58   NS_IMETHOD GetRole(PRUint32 *aRole);
  59
  60   NS_IMETHOD GetChildAtPoint(PRInt32 aX, PRInt32 aY,
  61                              nsIAccessible **aAccessible);
  62   NS_IMETHOD GetDeepestChildAtPoint(PRInt32 aX, PRInt32 aY,
  63                                     nsIAccessible **aAccessible);
  64
  65   NS_IMETHOD GetNumActions(PRUint8 *aNumActions);
  66   NS_IMETHOD GetActionName(PRUint8 aIndex, nsAString& aName);
  67   NS_IMETHOD GetActionDescription(PRUint8 aIndex, nsAString& aDescription);
  68   NS_IMETHOD DoAction(PRUint8 aIndex);
  69
  70   // nsAccessible
  71   virtual nsresult GetStateInternal(PRUint32 *aState, PRUint32 *aExtraState);
  72   virtual nsresult GetAttributesInternal(nsIPersistentProperties *aAttributes);
  73
  74 protected:
  75   // nsAccessible
  76   void CacheChildren();
  77 };
  78
  79 #endif