accessible/xul/XULListboxAccessible.h

   1 /* -*- Mode: C++; tab-width: 4; 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_XULListboxAccessible_h__
   7 #define mozilla_a11y_XULListboxAccessible_h__
   8
   9 #include "BaseAccessibles.h"
  10 #include "nsIAccessibleTable.h"
  11 #include "TableAccessible.h"
  12 #include "TableCellAccessible.h"
  13 #include "xpcAccessibleTable.h"
  14 #include "xpcAccessibleTableCell.h"
  15 #include "XULMenuAccessible.h"
  16 #include "XULSelectControlAccessible.h"
  17
  18 class nsIWeakReference;
  19
  20 namespace mozilla {
  21 namespace a11y {
  22
  23 /**
  24  * XULColumAccessible are accessible for list and tree columns elements
  25  * (xul:treecols and xul:listcols).
  26  */
  27 class XULColumAccessible : public AccessibleWrap
  28 {
  29 public:
  30   XULColumAccessible(nsIContent* aContent, DocAccessible* aDoc);
  31
  32   // Accessible
  33   virtual a11y::role NativeRole();
  34   virtual uint64_t NativeState();
  35 };
  36
  37 /**
  38  * XULColumnItemAccessible are accessibles for list and tree column elements
  39  * (xul:listcol and xul:treecol).
  40  */
  41 class XULColumnItemAccessible : public LeafAccessible
  42 {
  43 public:
  44   XULColumnItemAccessible(nsIContent* aContent, DocAccessible* aDoc);
  45
  46   // nsIAccessible
  47   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
  48   NS_IMETHOD DoAction(uint8_t aIndex);
  49
  50   // Accessible
  51   virtual a11y::role NativeRole();
  52   virtual uint64_t NativeState();
  53
  54   // ActionAccessible
  55   virtual uint8_t ActionCount();
  56
  57   enum { eAction_Click = 0 };
  58 };
  59
  60 /*
  61  * A class the represents the XUL Listbox widget.
  62  */
  63 class XULListboxAccessible : public XULSelectControlAccessible,
  64                              public xpcAccessibleTable,
  65                              public nsIAccessibleTable,
  66                              public TableAccessible
  67 {
  68 public:
  69   XULListboxAccessible(nsIContent* aContent, DocAccessible* aDoc);
  70
  71   NS_DECL_ISUPPORTS_INHERITED
  72
  73   // nsIAccessibleTable
  74   NS_FORWARD_NSIACCESSIBLETABLE(xpcAccessibleTable::)
  75
  76   // TableAccessible
  77   virtual uint32_t ColCount();
  78   virtual uint32_t RowCount();
  79   virtual Accessible* CellAt(uint32_t aRowIndex, uint32_t aColumnIndex);
  80   virtual bool IsColSelected(uint32_t aColIdx);
  81   virtual bool IsRowSelected(uint32_t aRowIdx);
  82   virtual bool IsCellSelected(uint32_t aRowIdx, uint32_t aColIdx);
  83   virtual uint32_t SelectedCellCount();
  84   virtual uint32_t SelectedColCount();
  85   virtual uint32_t SelectedRowCount();
  86   virtual void SelectedCells(nsTArray<Accessible*>* aCells);
  87   virtual void SelectedCellIndices(nsTArray<uint32_t>* aCells);
  88   virtual void SelectedColIndices(nsTArray<uint32_t>* aCols);
  89   virtual void SelectedRowIndices(nsTArray<uint32_t>* aRows);
  90   virtual void SelectRow(uint32_t aRowIdx);
  91   virtual void UnselectRow(uint32_t aRowIdx);
  92   virtual Accessible* AsAccessible() { return this; }
  93
  94   // Accessible
  95   virtual void Shutdown();
  96   virtual void Value(nsString& aValue);
  97   virtual TableAccessible* AsTable() { return this; }
  98   virtual a11y::role NativeRole();
  99   virtual uint64_t NativeState();
 100
 101   // Widgets
 102   virtual bool IsWidget() const;
 103   virtual bool IsActiveWidget() const;
 104   virtual bool AreItemsOperable() const;
 105
 106   virtual Accessible* ContainerWidget() const;
 107
 108 protected:
 109   virtual ~XULListboxAccessible() {}
 110
 111   bool IsMulticolumn();
 112 };
 113
 114 /**
 115   * Listitems -- used in listboxes
 116   */
 117 class XULListitemAccessible : public XULMenuitemAccessible
 118 {
 119 public:
 120   enum { eAction_Click = 0 };
 121
 122   NS_DECL_ISUPPORTS_INHERITED
 123
 124   XULListitemAccessible(nsIContent* aContent, DocAccessible* aDoc);
 125
 126   // nsIAccessible
 127   NS_IMETHOD GetActionName(uint8_t index, nsAString& aName);
 128   // Don't use XUL menuitems's description attribute
 129
 130   // Accessible
 131   virtual void Description(nsString& aDesc);
 132   virtual a11y::role NativeRole();
 133   virtual uint64_t NativeState();
 134   virtual uint64_t NativeInteractiveState() const;
 135   virtual bool CanHaveAnonChildren();
 136
 137   // Widgets
 138   virtual Accessible* ContainerWidget() const;
 139
 140 protected:
 141   virtual ~XULListitemAccessible();
 142
 143   // Accessible
 144   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
 145
 146   // XULListitemAccessible
 147
 148   /**
 149    * Return listbox accessible for the listitem.
 150    */
 151   Accessible* GetListAccessible();
 152
 153 private:
 154   bool mIsCheckbox;
 155 };
 156
 157 /**
 158  * Class represents xul:listcell.
 159  */
 160 class XULListCellAccessible : public HyperTextAccessibleWrap,
 161                               public nsIAccessibleTableCell,
 162                               public TableCellAccessible,
 163                               public xpcAccessibleTableCell
 164 {
 165 public:
 166   XULListCellAccessible(nsIContent* aContent, DocAccessible* aDoc);
 167
 168   // nsISupports
 169   NS_DECL_ISUPPORTS_INHERITED
 170
 171   // nsIAccessibleTableCell
 172   NS_FORWARD_NSIACCESSIBLETABLECELL(xpcAccessibleTableCell::)
 173
 174   // Accessible
 175   virtual TableCellAccessible* AsTableCell() { return this; }
 176   virtual void Shutdown();
 177   virtual already_AddRefed<nsIPersistentProperties> NativeAttributes() MOZ_OVERRIDE;
 178   virtual a11y::role NativeRole();
 179
 180   // TableCellAccessible
 181   virtual TableAccessible* Table() const MOZ_OVERRIDE;
 182   virtual uint32_t ColIdx() const MOZ_OVERRIDE;
 183   virtual uint32_t RowIdx() const MOZ_OVERRIDE;
 184   virtual void ColHeaderCells(nsTArray<Accessible*>* aHeaderCells) MOZ_OVERRIDE;
 185   virtual bool Selected() MOZ_OVERRIDE;
 186
 187 protected:
 188   virtual ~XULListCellAccessible() {}
 189 };
 190
 191 } // namespace a11y
 192 } // namespace mozilla
 193
 194 #endif