accessible/generic/OuterDocAccessible.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef MOZILLA_A11Y_OUTERDOCACCESSIBLE_H_
   7 #define MOZILLA_A11Y_OUTERDOCACCESSIBLE_H_
   8
   9 #include "AccessibleWrap.h"
  10
  11 namespace mozilla {
  12 namespace a11y {
  13
  14 /**
  15  * Used for <browser>, <frame>, <iframe>, <page> or editor> elements.
  16  *
  17  * In these variable names, "outer" relates to the OuterDocAccessible as
  18  * opposed to the DocAccessibleWrap which is "inner". The outer node is
  19  * a something like tags listed above, whereas the inner node corresponds to
  20  * the inner document root.
  21  */
  22
  23 class OuterDocAccessible MOZ_FINAL : public AccessibleWrap
  24 {
  25 public:
  26   OuterDocAccessible(nsIContent* aContent, DocAccessible* aDoc);
  27
  28   NS_DECL_ISUPPORTS_INHERITED
  29
  30   // nsIAccessible
  31   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
  32   NS_IMETHOD GetActionDescription(uint8_t aIndex, nsAString& aDescription);
  33   NS_IMETHOD DoAction(uint8_t aIndex);
  34
  35   // Accessible
  36   virtual void Shutdown();
  37   virtual mozilla::a11y::role NativeRole();
  38   virtual Accessible* ChildAtPoint(int32_t aX, int32_t aY,
  39                                    EWhichChildAtPoint aWhichChild);
  40
  41   virtual void InvalidateChildren();
  42   virtual bool InsertChildAt(uint32_t aIdx, Accessible* aChild) MOZ_OVERRIDE;
  43   virtual bool RemoveChild(Accessible* aAccessible);
  44
  45   // ActionAccessible
  46   virtual uint8_t ActionCount();
  47
  48 protected:
  49   virtual ~OuterDocAccessible();
  50
  51   // Accessible
  52   virtual void CacheChildren();
  53 };
  54
  55 } // namespace a11y
  56 } // namespace mozilla
  57
  58 #endif