accessible/src/generic/ARIAGridAccessible.h

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/accessible/src/generic/ARIAGridAccessible.h	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,150 @@
     1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
     1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.8 +
     1.9 +#ifndef MOZILLA_A11Y_ARIAGridAccessible_h_
    1.10 +#define MOZILLA_A11Y_ARIAGridAccessible_h_
    1.11 +
    1.12 +#include "nsIAccessibleTable.h"
    1.13 +
    1.14 +#include "HyperTextAccessibleWrap.h"
    1.15 +#include "TableAccessible.h"
    1.16 +#include "TableCellAccessible.h"
    1.17 +#include "xpcAccessibleTable.h"
    1.18 +#include "xpcAccessibleTableCell.h"
    1.19 +
    1.20 +namespace mozilla {
    1.21 +namespace a11y {
    1.22 +
    1.23 +/**
    1.24 + * Accessible for ARIA grid and treegrid.
    1.25 + */
    1.26 +class ARIAGridAccessible : public AccessibleWrap,
    1.27 +                           public xpcAccessibleTable,
    1.28 +                           public nsIAccessibleTable,
    1.29 +                           public TableAccessible
    1.30 +{
    1.31 +public:
    1.32 +  ARIAGridAccessible(nsIContent* aContent, DocAccessible* aDoc);
    1.33 +
    1.34 +  // nsISupports
    1.35 +  NS_DECL_ISUPPORTS_INHERITED
    1.36 +
    1.37 +  // nsIAccessibleTable
    1.38 +  NS_FORWARD_NSIACCESSIBLETABLE(xpcAccessibleTable::)
    1.39 +
    1.40 +  // Accessible
    1.41 +  virtual TableAccessible* AsTable() { return this; }
    1.42 +  virtual void Shutdown();
    1.43 +
    1.44 +  // TableAccessible
    1.45 +  virtual uint32_t ColCount();
    1.46 +  virtual uint32_t RowCount();
    1.47 +  virtual Accessible* CellAt(uint32_t aRowIndex, uint32_t aColumnIndex);
    1.48 +  virtual bool IsColSelected(uint32_t aColIdx);
    1.49 +  virtual bool IsRowSelected(uint32_t aRowIdx);
    1.50 +  virtual bool IsCellSelected(uint32_t aRowIdx, uint32_t aColIdx);
    1.51 +  virtual uint32_t SelectedCellCount();
    1.52 +  virtual uint32_t SelectedColCount();
    1.53 +  virtual uint32_t SelectedRowCount();
    1.54 +  virtual void SelectedCells(nsTArray<Accessible*>* aCells);
    1.55 +  virtual void SelectedCellIndices(nsTArray<uint32_t>* aCells);
    1.56 +  virtual void SelectedColIndices(nsTArray<uint32_t>* aCols);
    1.57 +  virtual void SelectedRowIndices(nsTArray<uint32_t>* aRows);
    1.58 +  virtual void SelectCol(uint32_t aColIdx);
    1.59 +  virtual void SelectRow(uint32_t aRowIdx);
    1.60 +  virtual void UnselectCol(uint32_t aColIdx);
    1.61 +  virtual void UnselectRow(uint32_t aRowIdx);
    1.62 +  virtual Accessible* AsAccessible() { return this; }
    1.63 +
    1.64 +protected:
    1.65 +
    1.66 +  /**
    1.67 +   * Return true if the given row index is valid.
    1.68 +   */
    1.69 +  bool IsValidRow(int32_t aRow);
    1.70 +
    1.71 +  /**
    1.72 +   * Retrn true if the given column index is valid.
    1.73 +   */
    1.74 +  bool IsValidColumn(int32_t aColumn);
    1.75 +
    1.76 +  /**
    1.77 +   * Return row accessible at the given row index.
    1.78 +   */
    1.79 +  Accessible* GetRowAt(int32_t aRow);
    1.80 +
    1.81 +  /**
    1.82 +   * Return cell accessible at the given column index in the row.
    1.83 +   */
    1.84 +  Accessible* GetCellInRowAt(Accessible* aRow, int32_t aColumn);
    1.85 +
    1.86 +  /**
    1.87 +   * Set aria-selected attribute value on DOM node of the given accessible.
    1.88 +   *
    1.89 +   * @param  aAccessible  [in] accessible
    1.90 +   * @param  aIsSelected  [in] new value of aria-selected attribute
    1.91 +   * @param  aNotify      [in, optional] specifies if DOM should be notified
    1.92 +   *                       about attribute change (used internally).
    1.93 +   */
    1.94 +  nsresult SetARIASelected(Accessible* aAccessible, bool aIsSelected,
    1.95 +                           bool aNotify = true);
    1.96 +};
    1.97 +
    1.98 +
    1.99 +/**
   1.100 + * Accessible for ARIA gridcell and rowheader/columnheader.
   1.101 + */
   1.102 +class ARIAGridCellAccessible : public HyperTextAccessibleWrap,
   1.103 +                               public nsIAccessibleTableCell,
   1.104 +                               public TableCellAccessible,
   1.105 +                               public xpcAccessibleTableCell
   1.106 +{
   1.107 +public:
   1.108 +  ARIAGridCellAccessible(nsIContent* aContent, DocAccessible* aDoc);
   1.109 +
   1.110 +  // nsISupports
   1.111 +  NS_DECL_ISUPPORTS_INHERITED
   1.112 +
   1.113 +  // nsIAccessibleTableCell
   1.114 +  NS_FORWARD_NSIACCESSIBLETABLECELL(xpcAccessibleTableCell::)
   1.115 +
   1.116 +  // Accessible
   1.117 +  virtual TableCellAccessible* AsTableCell() { return this; }
   1.118 +  virtual void Shutdown();
   1.119 +  virtual void ApplyARIAState(uint64_t* aState) const;
   1.120 +  virtual already_AddRefed<nsIPersistentProperties> NativeAttributes() MOZ_OVERRIDE;
   1.121 +
   1.122 +protected:
   1.123 +
   1.124 +  /**
   1.125 +   * Return a containing row.
   1.126 +   */
   1.127 +  Accessible* Row() const
   1.128 +  {
   1.129 +    Accessible* row = Parent();
   1.130 +    return row && row->Role() == roles::ROW ? row : nullptr;
   1.131 +  }
   1.132 +
   1.133 +  /**
   1.134 +   * Return a table for the given row.
   1.135 +   */
   1.136 +  Accessible* TableFor(Accessible* aRow) const;
   1.137 +
   1.138 +  /**
   1.139 +   * Return index of the given row.
   1.140 +   */
   1.141 +  int32_t RowIndexFor(Accessible* aRow) const;
   1.142 +
   1.143 +  // TableCellAccessible
   1.144 +  virtual TableAccessible* Table() const MOZ_OVERRIDE;
   1.145 +  virtual uint32_t ColIdx() const MOZ_OVERRIDE;
   1.146 +  virtual uint32_t RowIdx() const MOZ_OVERRIDE;
   1.147 +  virtual bool Selected() MOZ_OVERRIDE;
   1.148 +};
   1.149 +
   1.150 +} // namespace a11y
   1.151 +} // namespace mozilla
   1.152 +
   1.153 +#endif

mercurial