accessible/generic/ARIAGridAccessible.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_ARIAGridAccessible_h_
   7 #define MOZILLA_A11Y_ARIAGridAccessible_h_
   8
   9 #include "HyperTextAccessibleWrap.h"
  10 #include "TableAccessible.h"
  11 #include "TableCellAccessible.h"
  12
  13 namespace mozilla {
  14 namespace a11y {
  15
  16 /**
  17  * Accessible for ARIA grid and treegrid.
  18  */
  19 class ARIAGridAccessible : public HyperTextAccessibleWrap,
  20                            public TableAccessible {
  21  public:
  22   ARIAGridAccessible(nsIContent* aContent, DocAccessible* aDoc);
  23
  24   NS_INLINE_DECL_REFCOUNTING_INHERITED(ARIAGridAccessible,
  25                                        HyperTextAccessibleWrap)
  26
  27   // LocalAccessible
  28   virtual a11y::role NativeRole() const override;
  29   virtual already_AddRefed<nsIPersistentProperties> NativeAttributes() override;
  30   virtual TableAccessible* AsTable() override { return this; }
  31
  32   // TableAccessible
  33   virtual uint32_t ColCount() const override;
  34   virtual uint32_t RowCount() override;
  35   virtual LocalAccessible* CellAt(uint32_t aRowIndex,
  36                                   uint32_t aColumnIndex) override;
  37   virtual bool IsColSelected(uint32_t aColIdx) override;
  38   virtual bool IsRowSelected(uint32_t aRowIdx) override;
  39   virtual bool IsCellSelected(uint32_t aRowIdx, uint32_t aColIdx) override;
  40   virtual uint32_t SelectedCellCount() override;
  41   virtual uint32_t SelectedColCount() override;
  42   virtual uint32_t SelectedRowCount() override;
  43   virtual void SelectedCells(nsTArray<LocalAccessible*>* aCells) override;
  44   virtual void SelectedCellIndices(nsTArray<uint32_t>* aCells) override;
  45   virtual void SelectedColIndices(nsTArray<uint32_t>* aCols) override;
  46   virtual void SelectedRowIndices(nsTArray<uint32_t>* aRows) override;
  47   virtual void SelectCol(uint32_t aColIdx) override;
  48   virtual void SelectRow(uint32_t aRowIdx) override;
  49   virtual void UnselectCol(uint32_t aColIdx) override;
  50   virtual void UnselectRow(uint32_t aRowIdx) override;
  51   virtual LocalAccessible* AsAccessible() override { return this; }
  52
  53  protected:
  54   virtual ~ARIAGridAccessible() {}
  55
  56   /**
  57    * Set aria-selected attribute value on DOM node of the given accessible.
  58    *
  59    * @param  aAccessible  [in] accessible
  60    * @param  aIsSelected  [in] new value of aria-selected attribute
  61    * @param  aNotify      [in, optional] specifies if DOM should be notified
  62    *                       about attribute change (used internally).
  63    */
  64   nsresult SetARIASelected(LocalAccessible* aAccessible, bool aIsSelected,
  65                            bool aNotify = true);
  66 };
  67
  68 /**
  69  * Accessible for ARIA row.
  70  */
  71 class ARIARowAccessible : public HyperTextAccessibleWrap {
  72  public:
  73   ARIARowAccessible(nsIContent* aContent, DocAccessible* aDoc);
  74
  75   NS_INLINE_DECL_REFCOUNTING_INHERITED(ARIARowAccessible,
  76                                        HyperTextAccessibleWrap)
  77
  78   // LocalAccessible
  79   virtual a11y::role NativeRole() const override;
  80   virtual mozilla::a11y::GroupPos GroupPosition() override;
  81
  82  protected:
  83   virtual ~ARIARowAccessible() {}
  84
  85   // LocalAccessible
  86   virtual ENameValueFlag NativeName(nsString& aName) const override;
  87 };
  88
  89 /**
  90  * Accessible for ARIA gridcell and rowheader/columnheader.
  91  */
  92 class ARIAGridCellAccessible : public HyperTextAccessibleWrap,
  93                                public TableCellAccessible {
  94  public:
  95   ARIAGridCellAccessible(nsIContent* aContent, DocAccessible* aDoc);
  96
  97   NS_INLINE_DECL_REFCOUNTING_INHERITED(ARIAGridCellAccessible,
  98                                        HyperTextAccessibleWrap)
  99
 100   // LocalAccessible
 101   virtual a11y::role NativeRole() const override;
 102   virtual TableCellAccessible* AsTableCell() override { return this; }
 103   virtual void ApplyARIAState(uint64_t* aState) const override;
 104   virtual already_AddRefed<nsIPersistentProperties> NativeAttributes() override;
 105   virtual mozilla::a11y::GroupPos GroupPosition() override;
 106
 107  protected:
 108   virtual ~ARIAGridCellAccessible() {}
 109
 110   /**
 111    * Return a containing row.
 112    */
 113   LocalAccessible* Row() const {
 114     LocalAccessible* row = LocalParent();
 115     return row && row->IsTableRow() ? row : nullptr;
 116   }
 117
 118   /**
 119    * Return index of the given row.
 120    * Returns -1 upon error.
 121    */
 122   int32_t RowIndexFor(LocalAccessible* aRow) const;
 123
 124   // TableCellAccessible
 125   virtual TableAccessible* Table() const override;
 126   virtual uint32_t ColIdx() const override;
 127   virtual uint32_t RowIdx() const override;
 128   virtual bool Selected() override;
 129 };
 130
 131 }  // namespace a11y
 132 }  // namespace mozilla
 133
 134 #endif