accessible/xul/XULFormControlAccessible.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_XULFormControlAccessible_H_
   7 #define MOZILLA_A11Y_XULFormControlAccessible_H_
   8
   9 // NOTE: alphabetically ordered
  10 #include "AccessibleWrap.h"
  11 #include "FormControlAccessible.h"
  12 #include "HyperTextAccessibleWrap.h"
  13 #include "XULSelectControlAccessible.h"
  14
  15 namespace mozilla {
  16 namespace a11y {
  17
  18 /**
  19  * Used for XUL progressmeter element.
  20  */
  21 typedef ProgressMeterAccessible<100> XULProgressMeterAccessible;
  22
  23 /**
  24  * Used for XUL button.
  25  *
  26  * @note  Don't inherit from LeafAccessible - it doesn't allow children
  27  *         and a button can have a dropmarker child.
  28  */
  29 class XULButtonAccessible : public AccessibleWrap
  30 {
  31 public:
  32   enum { eAction_Click = 0 };
  33   XULButtonAccessible(nsIContent* aContent, DocAccessible* aDoc);
  34
  35   // nsISupports
  36   NS_DECL_ISUPPORTS_INHERITED
  37
  38   // nsIAccessible
  39   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
  40   NS_IMETHOD DoAction(uint8_t index);
  41
  42   // Accessible
  43   virtual mozilla::a11y::role NativeRole();
  44   virtual uint64_t NativeState();
  45
  46   // ActionAccessible
  47   virtual uint8_t ActionCount();
  48
  49   // Widgets
  50   virtual bool IsWidget() const;
  51   virtual bool IsActiveWidget() const;
  52   virtual bool AreItemsOperable() const;
  53   virtual Accessible* ContainerWidget() const;
  54
  55   virtual bool IsAcceptableChild(Accessible* aPossibleChild) const MOZ_OVERRIDE;
  56
  57 protected:
  58   virtual ~XULButtonAccessible();
  59
  60   // XULButtonAccessible
  61   bool ContainsMenu();
  62 };
  63
  64
  65 /**
  66  * Used for XUL checkbox element.
  67  */
  68 class XULCheckboxAccessible : public LeafAccessible
  69 {
  70 public:
  71   enum { eAction_Click = 0 };
  72   XULCheckboxAccessible(nsIContent* aContent, DocAccessible* aDoc);
  73
  74   // nsIAccessible
  75   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
  76   NS_IMETHOD DoAction(uint8_t index);
  77
  78   // Accessible
  79   virtual mozilla::a11y::role NativeRole();
  80   virtual uint64_t NativeState();
  81
  82   // ActionAccessible
  83   virtual uint8_t ActionCount();
  84 };
  85
  86 /**
  87  * Used for XUL dropmarker element.
  88  */
  89 class XULDropmarkerAccessible : public LeafAccessible
  90 {
  91 public:
  92   enum { eAction_Click = 0 };
  93   XULDropmarkerAccessible(nsIContent* aContent, DocAccessible* aDoc);
  94
  95   // nsIAccessible
  96   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
  97   NS_IMETHOD DoAction(uint8_t index);
  98
  99   // Accessible
 100   virtual mozilla::a11y::role NativeRole();
 101   virtual uint64_t NativeState();
 102
 103   // ActionAccessible
 104   virtual uint8_t ActionCount();
 105
 106 private:
 107   bool DropmarkerOpen(bool aToggleOpen);
 108 };
 109
 110 /**
 111  * Used for XUL groupbox element.
 112  */
 113 class XULGroupboxAccessible MOZ_FINAL : public AccessibleWrap
 114 {
 115 public:
 116   XULGroupboxAccessible(nsIContent* aContent, DocAccessible* aDoc);
 117
 118   // Accessible
 119   virtual mozilla::a11y::role NativeRole();
 120   virtual Relation RelationByType(RelationType aType) MOZ_OVERRIDE;
 121
 122 protected:
 123   // Accessible
 124   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
 125 };
 126
 127 /**
 128  * Used for XUL radio element (radio button).
 129  */
 130 class XULRadioButtonAccessible : public RadioButtonAccessible
 131 {
 132
 133 public:
 134   XULRadioButtonAccessible(nsIContent* aContent, DocAccessible* aDoc);
 135
 136   // Accessible
 137   virtual uint64_t NativeState();
 138   virtual uint64_t NativeInteractiveState() const;
 139
 140   // Widgets
 141   virtual Accessible* ContainerWidget() const;
 142 };
 143
 144 /**
 145  * Used for XUL radiogroup element.
 146  */
 147 class XULRadioGroupAccessible : public XULSelectControlAccessible
 148 {
 149 public:
 150   XULRadioGroupAccessible(nsIContent* aContent, DocAccessible* aDoc);
 151
 152   // Accessible
 153   virtual mozilla::a11y::role NativeRole();
 154   virtual uint64_t NativeInteractiveState() const;
 155
 156   // Widgets
 157   virtual bool IsWidget() const;
 158   virtual bool IsActiveWidget() const;
 159   virtual bool AreItemsOperable() const;
 160 };
 161
 162 /**
 163  * Used for XUL statusbar element.
 164  */
 165 class XULStatusBarAccessible : public AccessibleWrap
 166 {
 167 public:
 168   XULStatusBarAccessible(nsIContent* aContent, DocAccessible* aDoc);
 169
 170   // Accessible
 171   virtual mozilla::a11y::role NativeRole();
 172 };
 173
 174 /**
 175  * Used for XUL toolbarbutton element.
 176  */
 177 class XULToolbarButtonAccessible : public XULButtonAccessible
 178 {
 179 public:
 180   XULToolbarButtonAccessible(nsIContent* aContent, DocAccessible* aDoc);
 181
 182   // Accessible
 183   virtual void GetPositionAndSizeInternal(int32_t *aPosInSet,
 184                                           int32_t *aSetSize);
 185
 186   // nsXULToolbarButtonAccessible
 187   static bool IsSeparator(Accessible* aAccessible);
 188 };
 189
 190 /**
 191  * Used for XUL toolbar element.
 192  */
 193 class XULToolbarAccessible : public AccessibleWrap
 194 {
 195 public:
 196   XULToolbarAccessible(nsIContent* aContent, DocAccessible* aDoc);
 197
 198   // Accessible
 199   virtual mozilla::a11y::role NativeRole();
 200
 201 protected:
 202   // Accessible
 203   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
 204 };
 205
 206 /**
 207  * Used for XUL toolbarseparator element.
 208  */
 209 class XULToolbarSeparatorAccessible : public LeafAccessible
 210 {
 211 public:
 212   XULToolbarSeparatorAccessible(nsIContent* aContent,
 213                                 DocAccessible* aDoc);
 214
 215   // Accessible
 216   virtual mozilla::a11y::role NativeRole();
 217   virtual uint64_t NativeState();
 218 };
 219
 220 } // namespace a11y
 221 } // namespace mozilla
 222
 223 #endif
 224