accessible/html/HTMLFormControlAccessible.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_HTMLFormControlAccessible_H_
   7 #define MOZILLA_A11Y_HTMLFormControlAccessible_H_
   8
   9 #include "FormControlAccessible.h"
  10 #include "HyperTextAccessibleWrap.h"
  11
  12 namespace mozilla {
  13 namespace a11y {
  14
  15 /**
  16  * Accessible for HTML progress element.
  17  */
  18 typedef ProgressMeterAccessible<1> HTMLProgressMeterAccessible;
  19
  20 /**
  21  * Accessible for HTML input@type="checkbox".
  22  */
  23 class HTMLCheckboxAccessible : public LeafAccessible
  24 {
  25
  26 public:
  27   enum { eAction_Click = 0 };
  28
  29   HTMLCheckboxAccessible(nsIContent* aContent, DocAccessible* aDoc) :
  30     LeafAccessible(aContent, aDoc)
  31   {
  32     // Ignore "CheckboxStateChange" DOM event in lieu of document observer
  33     // state change notification.
  34     mStateFlags |= eIgnoreDOMUIEvent;
  35   }
  36
  37   // nsIAccessible
  38   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
  39   NS_IMETHOD DoAction(uint8_t index);
  40
  41   // Accessible
  42   virtual mozilla::a11y::role NativeRole();
  43   virtual uint64_t NativeState();
  44
  45   // ActionAccessible
  46   virtual uint8_t ActionCount();
  47
  48   // Widgets
  49   virtual bool IsWidget() const;
  50 };
  51
  52
  53 /**
  54  * Accessible for HTML input@type="radio" element.
  55  */
  56 class HTMLRadioButtonAccessible : public RadioButtonAccessible
  57 {
  58
  59 public:
  60   HTMLRadioButtonAccessible(nsIContent* aContent, DocAccessible* aDoc) :
  61     RadioButtonAccessible(aContent, aDoc)
  62   {
  63     // Ignore "RadioStateChange" DOM event in lieu of document observer
  64     // state change notification.
  65     mStateFlags |= eIgnoreDOMUIEvent;
  66   }
  67
  68   // Accessible
  69   virtual uint64_t NativeState();
  70   virtual void GetPositionAndSizeInternal(int32_t *aPosInSet,
  71                                           int32_t *aSetSize);
  72 };
  73
  74
  75 /**
  76  * Accessible for HTML input@type="button", @type="submit", @type="image"
  77  * and HTML button elements.
  78  */
  79 class HTMLButtonAccessible : public HyperTextAccessibleWrap
  80 {
  81
  82 public:
  83   enum { eAction_Click = 0 };
  84
  85   HTMLButtonAccessible(nsIContent* aContent, DocAccessible* aDoc);
  86
  87   // nsIAccessible
  88   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
  89   NS_IMETHOD DoAction(uint8_t index);
  90
  91   // Accessible
  92   virtual mozilla::a11y::role NativeRole();
  93   virtual uint64_t State();
  94   virtual uint64_t NativeState();
  95
  96   // ActionAccessible
  97   virtual uint8_t ActionCount();
  98
  99   // Widgets
 100   virtual bool IsWidget() const;
 101
 102 protected:
 103   // Accessible
 104   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
 105 };
 106
 107
 108 /**
 109  * Accessible for HTML input@type="text", input@type="password", textarea and
 110  * other HTML text controls.
 111  */
 112 class HTMLTextFieldAccessible MOZ_FINAL : public HyperTextAccessibleWrap
 113 {
 114
 115 public:
 116   enum { eAction_Click = 0 };
 117
 118   HTMLTextFieldAccessible(nsIContent* aContent, DocAccessible* aDoc);
 119
 120   NS_DECL_ISUPPORTS_INHERITED
 121
 122   // nsIAccessible
 123   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
 124   NS_IMETHOD DoAction(uint8_t index);
 125
 126   // HyperTextAccessible
 127   virtual already_AddRefed<nsIEditor> GetEditor() const;
 128
 129   // Accessible
 130   virtual void Value(nsString& aValue);
 131   virtual void ApplyARIAState(uint64_t* aState) const;
 132   virtual mozilla::a11y::role NativeRole();
 133   virtual uint64_t NativeState();
 134   virtual already_AddRefed<nsIPersistentProperties> NativeAttributes() MOZ_OVERRIDE;
 135
 136   // ActionAccessible
 137   virtual uint8_t ActionCount();
 138
 139   // Widgets
 140   virtual bool IsWidget() const;
 141   virtual Accessible* ContainerWidget() const;
 142
 143 protected:
 144   virtual ~HTMLTextFieldAccessible() {}
 145
 146   // Accessible
 147   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
 148
 149   /**
 150    * Return a XUL widget element this input is part of.
 151    */
 152   nsIContent* XULWidgetElm() const { return mContent->GetBindingParent(); }
 153 };
 154
 155
 156 /**
 157  * Accessible for input@type="file" element.
 158  */
 159 class HTMLFileInputAccessible : public HyperTextAccessibleWrap
 160 {
 161 public:
 162   HTMLFileInputAccessible(nsIContent* aContent, DocAccessible* aDoc);
 163
 164   // Accessible
 165   virtual mozilla::a11y::role NativeRole();
 166   virtual nsresult HandleAccEvent(AccEvent* aAccEvent);
 167 };
 168
 169
 170 /**
 171  * Used for HTML input@type="number".
 172  */
 173 class HTMLSpinnerAccessible : public AccessibleWrap
 174 {
 175 public:
 176   HTMLSpinnerAccessible(nsIContent* aContent, DocAccessible* aDoc) :
 177     AccessibleWrap(aContent, aDoc)
 178   {
 179     mStateFlags |= eHasNumericValue;
 180 }
 181
 182   // Accessible
 183   virtual mozilla::a11y::role NativeRole() MOZ_OVERRIDE;
 184   virtual void Value(nsString& aValue) MOZ_OVERRIDE;
 185
 186   virtual double MaxValue() const MOZ_OVERRIDE;
 187   virtual double MinValue() const MOZ_OVERRIDE;
 188   virtual double CurValue() const MOZ_OVERRIDE;
 189   virtual double Step() const MOZ_OVERRIDE;
 190   virtual bool SetCurValue(double aValue) MOZ_OVERRIDE;
 191 };
 192
 193
 194 /**
 195   * Used for input@type="range" element.
 196   */
 197 class HTMLRangeAccessible : public LeafAccessible
 198 {
 199 public:
 200   HTMLRangeAccessible(nsIContent* aContent, DocAccessible* aDoc) :
 201     LeafAccessible(aContent, aDoc)
 202   {
 203     mStateFlags |= eHasNumericValue;
 204   }
 205
 206   // Accessible
 207   virtual void Value(nsString& aValue);
 208   virtual mozilla::a11y::role NativeRole();
 209
 210   // Value
 211   virtual double MaxValue() const MOZ_OVERRIDE;
 212   virtual double MinValue() const MOZ_OVERRIDE;
 213   virtual double CurValue() const MOZ_OVERRIDE;
 214   virtual double Step() const MOZ_OVERRIDE;
 215   virtual bool SetCurValue(double aValue) MOZ_OVERRIDE;
 216
 217   // Widgets
 218   virtual bool IsWidget() const;
 219 };
 220
 221
 222 /**
 223  * Accessible for HTML fieldset element.
 224  */
 225 class HTMLGroupboxAccessible : public HyperTextAccessibleWrap
 226 {
 227 public:
 228   HTMLGroupboxAccessible(nsIContent* aContent, DocAccessible* aDoc);
 229
 230   // Accessible
 231   virtual mozilla::a11y::role NativeRole();
 232   virtual Relation RelationByType(RelationType aType) MOZ_OVERRIDE;
 233
 234 protected:
 235   // Accessible
 236   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
 237
 238   // HTMLGroupboxAccessible
 239   nsIContent* GetLegend();
 240 };
 241
 242
 243 /**
 244  * Accessible for HTML legend element.
 245  */
 246 class HTMLLegendAccessible : public HyperTextAccessibleWrap
 247 {
 248 public:
 249   HTMLLegendAccessible(nsIContent* aContent, DocAccessible* aDoc);
 250
 251   // Accessible
 252   virtual mozilla::a11y::role NativeRole();
 253   virtual Relation RelationByType(RelationType aType) MOZ_OVERRIDE;
 254 };
 255
 256 /**
 257  * Accessible for HTML5 figure element.
 258  */
 259 class HTMLFigureAccessible : public HyperTextAccessibleWrap
 260 {
 261 public:
 262   HTMLFigureAccessible(nsIContent* aContent, DocAccessible* aDoc);
 263
 264   // Accessible
 265   virtual already_AddRefed<nsIPersistentProperties> NativeAttributes() MOZ_OVERRIDE;
 266   virtual mozilla::a11y::role NativeRole();
 267   virtual Relation RelationByType(RelationType aType) MOZ_OVERRIDE;
 268
 269 protected:
 270   // Accessible
 271   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
 272
 273   // HTMLLegendAccessible
 274   nsIContent* Caption() const;
 275 };
 276
 277
 278 /**
 279  * Accessible for HTML5 figcaption element.
 280  */
 281 class HTMLFigcaptionAccessible : public HyperTextAccessibleWrap
 282 {
 283 public:
 284   HTMLFigcaptionAccessible(nsIContent* aContent, DocAccessible* aDoc);
 285
 286   // Accessible
 287   virtual mozilla::a11y::role NativeRole();
 288   virtual Relation RelationByType(RelationType aType) MOZ_OVERRIDE;
 289 };
 290
 291 } // namespace a11y
 292 } // namespace mozilla
 293
 294 #endif