The Tor Browser / file revision

 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

 /* This Source Code Form is subject to the terms of the Mozilla Public

  * License, v. 2.0. If a copy of the MPL was not distributed with this

  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

 #ifndef mozilla_a11y_HTMLTableAccessible_h__

 #define mozilla_a11y_HTMLTableAccessible_h__

 #include "HyperTextAccessibleWrap.h"

 #include "nsIAccessibleTable.h"

 #include "TableAccessible.h"

 #include "TableCellAccessible.h"

 #include "xpcAccessibleTable.h"

 #include "xpcAccessibleTableCell.h"

 class nsITableLayout;

 class nsITableCellLayout;

 namespace mozilla {

 namespace a11y {

 /**

  * HTML table cell accessible (html:td).

  */

 class HTMLTableCellAccessible : public HyperTextAccessibleWrap,

                                 public nsIAccessibleTableCell,

                                 public TableCellAccessible,

                                 public xpcAccessibleTableCell

 {

 public:

   HTMLTableCellAccessible(nsIContent* aContent, DocAccessible* aDoc);

   // nsISupports

   NS_DECL_ISUPPORTS_INHERITED

   // nsIAccessibleTableCell

   NS_FORWARD_NSIACCESSIBLETABLECELL(xpcAccessibleTableCell::)

   // Accessible

   virtual TableCellAccessible* AsTableCell() { return this; }

   virtual void Shutdown();

   virtual a11y::role NativeRole();

   virtual uint64_t NativeState();

   virtual uint64_t NativeInteractiveState() const;

   virtual already_AddRefed<nsIPersistentProperties> NativeAttributes() MOZ_OVERRIDE;

   // TableCellAccessible

   virtual TableAccessible* Table() const MOZ_OVERRIDE;

   virtual uint32_t ColIdx() const MOZ_OVERRIDE;

   virtual uint32_t RowIdx() const MOZ_OVERRIDE;

   virtual uint32_t ColExtent() const MOZ_OVERRIDE;

   virtual uint32_t RowExtent() const MOZ_OVERRIDE;

   virtual void ColHeaderCells(nsTArray<Accessible*>* aCells) MOZ_OVERRIDE;

   virtual void RowHeaderCells(nsTArray<Accessible*>* aCells) MOZ_OVERRIDE;

   virtual bool Selected() MOZ_OVERRIDE;

 protected:

   /**

    * Return host table accessible.

    */

   already_AddRefed<nsIAccessibleTable> GetTableAccessible();

   /**

    * Return nsITableCellLayout of the table cell frame.

    */

   nsITableCellLayout* GetCellLayout() const;

   /**

    * Return row and column indices of the cell.

    */

   nsresult GetCellIndexes(int32_t& aRowIdx, int32_t& aColIdx) const;

 };

 /**

  * HTML table row/column header accessible (html:th or html:td@scope).

  */

 class HTMLTableHeaderCellAccessible : public HTMLTableCellAccessible

 {

 public:

   HTMLTableHeaderCellAccessible(nsIContent* aContent, DocAccessible* aDoc);

   // Accessible

   virtual a11y::role NativeRole();

 };

 /**

  * HTML table row accessible (html:tr).

  */

 class HTMLTableRowAccessible : public AccessibleWrap

 {

 public:

   HTMLTableRowAccessible(nsIContent* aContent, DocAccessible* aDoc) :

     AccessibleWrap(aContent, aDoc)

   {

     mType = eHTMLTableRowType;

     mGenericTypes |= eTableRow;

   }

   virtual ~HTMLTableRowAccessible() { }

   NS_DECL_ISUPPORTS_INHERITED

   // Accessible

   virtual a11y::role NativeRole();

 };

 /**

  * HTML table accessible (html:table).

  */

 // To turn on table debugging descriptions define SHOW_LAYOUT_HEURISTIC

 // This allow release trunk builds to be used by testers to refine the

 // data vs. layout heuristic

 // #define SHOW_LAYOUT_HEURISTIC

 class HTMLTableAccessible : public AccessibleWrap,

                             public xpcAccessibleTable,

                             public nsIAccessibleTable,

                             public TableAccessible

 {

 public:

   HTMLTableAccessible(nsIContent* aContent, DocAccessible* aDoc) :

     AccessibleWrap(aContent, aDoc), xpcAccessibleTable(this)

   {

     mType = eHTMLTableType;

     mGenericTypes |= eTable;

   }

   NS_DECL_ISUPPORTS_INHERITED

   // nsIAccessible Table

   NS_FORWARD_NSIACCESSIBLETABLE(xpcAccessibleTable::)

   // TableAccessible

   virtual Accessible* Caption();

   virtual void Summary(nsString& aSummary);

   virtual uint32_t ColCount();

   virtual uint32_t RowCount();

   virtual Accessible* CellAt(uint32_t aRowIndex, uint32_t aColumnIndex);

   virtual int32_t CellIndexAt(uint32_t aRowIdx, uint32_t aColIdx);

   virtual int32_t ColIndexAt(uint32_t aCellIdx);

   virtual int32_t RowIndexAt(uint32_t aCellIdx);

   virtual void RowAndColIndicesAt(uint32_t aCellIdx, int32_t* aRowIdx,

                                   int32_t* aColIdx);

   virtual uint32_t ColExtentAt(uint32_t aRowIdx, uint32_t aColIdx);

   virtual uint32_t RowExtentAt(uint32_t aRowIdx, uint32_t aColIdx);

   virtual bool IsColSelected(uint32_t aColIdx);

   virtual bool IsRowSelected(uint32_t aRowIdx);

   virtual bool IsCellSelected(uint32_t aRowIdx, uint32_t aColIdx);

   virtual uint32_t SelectedCellCount();

   virtual uint32_t SelectedColCount();

   virtual uint32_t SelectedRowCount();

   virtual void SelectedCells(nsTArray<Accessible*>* aCells);

   virtual void SelectedCellIndices(nsTArray<uint32_t>* aCells);

   virtual void SelectedColIndices(nsTArray<uint32_t>* aCols);

   virtual void SelectedRowIndices(nsTArray<uint32_t>* aRows);

   virtual void SelectCol(uint32_t aColIdx);

   virtual void SelectRow(uint32_t aRowIdx);

   virtual void UnselectCol(uint32_t aColIdx);

   virtual void UnselectRow(uint32_t aRowIdx);

   virtual bool IsProbablyLayoutTable();

   virtual Accessible* AsAccessible() { return this; }

   // Accessible

   virtual void Shutdown();

   virtual TableAccessible* AsTable() { return this; }

   virtual void Description(nsString& aDescription);

   virtual a11y::role NativeRole();

   virtual uint64_t NativeState();

   virtual already_AddRefed<nsIPersistentProperties> NativeAttributes() MOZ_OVERRIDE;

   virtual Relation RelationByType(RelationType aRelationType) MOZ_OVERRIDE;

 protected:

   // Accessible

   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;

   virtual void CacheChildren();

   // HTMLTableAccessible

   /**

    * Add row or column to selection.

    *

    * @param aIndex   [in] index of row or column to be selected

    * @param aTarget  [in] indicates what should be selected, either row or column

    *                  (see nsISelectionPrivate)

    */

   nsresult AddRowOrColumnToSelection(int32_t aIndex, uint32_t aTarget);

   /**

    * Removes rows or columns at the given index or outside it from selection.

    *

    * @param  aIndex    [in] row or column index

    * @param  aTarget   [in] indicates whether row or column should unselected

    * @param  aIsOuter  [in] indicates whether all rows or column excepting

    *                    the given one should be unselected or the given one

    *                    should be unselected only

    */

   nsresult RemoveRowsOrColumnsFromSelection(int32_t aIndex,

                                             uint32_t aTarget,

                                             bool aIsOuter);

   /**

    * Return true if table has an element with the given tag name.

    *

    * @param  aTagName     [in] tag name of searched element

    * @param  aAllowEmpty  [in, optional] points if found element can be empty

    *                       or contain whitespace text only.

    */

   bool HasDescendant(const nsAString& aTagName, bool aAllowEmpty = true);

 #ifdef SHOW_LAYOUT_HEURISTIC

   nsString mLayoutHeuristic;

 #endif

 };

 /**

  * HTML caption accessible (html:caption).

  */

 class HTMLCaptionAccessible : public HyperTextAccessibleWrap

 {

 public:

   HTMLCaptionAccessible(nsIContent* aContent, DocAccessible* aDoc) :

     HyperTextAccessibleWrap(aContent, aDoc) { }

   virtual ~HTMLCaptionAccessible() { }

   // nsIAccessible

   // Accessible

   virtual a11y::role NativeRole();

   virtual Relation RelationByType(RelationType aRelationType) MOZ_OVERRIDE;

 };

 } // namespace a11y

 } // namespace mozilla

 #endif