accessible/html/HTMLTableAccessible.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_HTMLTableAccessible_h__
   7 #define mozilla_a11y_HTMLTableAccessible_h__
   8
   9 #include "HyperTextAccessible.h"
  10
  11 class nsITableCellLayout;
  12 class nsTableCellFrame;
  13 class nsTableWrapperFrame;
  14
  15 namespace mozilla {
  16
  17 namespace a11y {
  18
  19 class HTMLTableAccessible;
  20
  21 /**
  22  * HTML table cell accessible (html:td).
  23  */
  24 class HTMLTableCellAccessible : public HyperTextAccessible {
  25  public:
  26   HTMLTableCellAccessible(nsIContent* aContent, DocAccessible* aDoc);
  27
  28   // nsISupports
  29   NS_INLINE_DECL_REFCOUNTING_INHERITED(HTMLTableCellAccessible,
  30                                        HyperTextAccessible)
  31
  32   // LocalAccessible
  33   virtual a11y::role NativeRole() const override;
  34   virtual uint64_t NativeState() const override;
  35   virtual uint64_t NativeInteractiveState() const override;
  36   virtual already_AddRefed<AccAttributes> NativeAttributes() override;
  37
  38  protected:
  39   virtual void DOMAttributeChanged(int32_t aNameSpaceID, nsAtom* aAttribute,
  40                                    int32_t aModType,
  41                                    const nsAttrValue* aOldValue,
  42                                    uint64_t aOldState) override;
  43   // HTMLTableCellAccessible
  44  public:
  45   HTMLTableAccessible* Table() const;
  46   uint32_t ColExtent() const;
  47   uint32_t RowExtent() const;
  48
  49   static HTMLTableCellAccessible* GetFrom(LocalAccessible* aAcc) {
  50     if (aAcc->IsHTMLTableCell()) {
  51       return static_cast<HTMLTableCellAccessible*>(aAcc);
  52     }
  53     return nullptr;
  54   }
  55
  56  protected:
  57   virtual ~HTMLTableCellAccessible() {}
  58 };
  59
  60 /**
  61  * HTML table row/column header accessible (html:th or html:td@scope).
  62  */
  63 class HTMLTableHeaderCellAccessible : public HTMLTableCellAccessible {
  64  public:
  65   HTMLTableHeaderCellAccessible(nsIContent* aContent, DocAccessible* aDoc);
  66
  67   // LocalAccessible
  68   virtual a11y::role NativeRole() const override;
  69 };
  70
  71 /**
  72  * HTML table row accessible (html:tr).
  73  */
  74 class HTMLTableRowAccessible : public HyperTextAccessible {
  75  public:
  76   HTMLTableRowAccessible(nsIContent* aContent, DocAccessible* aDoc)
  77       : HyperTextAccessible(aContent, aDoc) {
  78     mType = eHTMLTableRowType;
  79     mGenericTypes |= eTableRow;
  80   }
  81
  82   NS_INLINE_DECL_REFCOUNTING_INHERITED(HTMLTableRowAccessible,
  83                                        HyperTextAccessible)
  84
  85  protected:
  86   virtual ~HTMLTableRowAccessible() {}
  87
  88   // LocalAccessible
  89   virtual ENameValueFlag NativeName(nsString& aName) const override;
  90 };
  91
  92 /**
  93  * HTML table accessible (html:table).
  94  */
  95
  96 // To turn on table debugging descriptions define SHOW_LAYOUT_HEURISTIC
  97 // This allow release trunk builds to be used by testers to refine the
  98 // data vs. layout heuristic
  99 // #define SHOW_LAYOUT_HEURISTIC
 100
 101 class HTMLTableAccessible : public HyperTextAccessible {
 102  public:
 103   HTMLTableAccessible(nsIContent* aContent, DocAccessible* aDoc)
 104       : HyperTextAccessible(aContent, aDoc) {
 105     mType = eHTMLTableType;
 106     mGenericTypes |= eTable;
 107   }
 108
 109   NS_INLINE_DECL_REFCOUNTING_INHERITED(HTMLTableAccessible, HyperTextAccessible)
 110
 111   // HTMLTableAccessible
 112   LocalAccessible* Caption() const;
 113   uint32_t ColCount() const;
 114   uint32_t RowCount();
 115   bool IsProbablyLayoutTable();
 116
 117   static HTMLTableAccessible* GetFrom(LocalAccessible* aAcc) {
 118     if (aAcc->IsHTMLTable()) {
 119       return static_cast<HTMLTableAccessible*>(aAcc);
 120     }
 121     return nullptr;
 122   }
 123
 124   // LocalAccessible
 125   virtual void Description(nsString& aDescription) const override;
 126   virtual uint64_t NativeState() const override;
 127   virtual already_AddRefed<AccAttributes> NativeAttributes() override;
 128   virtual Relation RelationByType(RelationType aRelationType) const override;
 129
 130   virtual bool InsertChildAt(uint32_t aIndex, LocalAccessible* aChild) override;
 131
 132  protected:
 133   virtual ~HTMLTableAccessible() {}
 134
 135   // LocalAccessible
 136   virtual ENameValueFlag NativeName(nsString& aName) const override;
 137
 138   virtual void DOMAttributeChanged(int32_t aNameSpaceID, nsAtom* aAttribute,
 139                                    int32_t aModType,
 140                                    const nsAttrValue* aOldValue,
 141                                    uint64_t aOldState) override;
 142
 143   // HTMLTableAccessible
 144
 145 #ifdef SHOW_LAYOUT_HEURISTIC
 146   nsString mLayoutHeuristic;
 147 #endif
 148
 149  private:
 150   /**
 151    * Get table wrapper frame, or return null if there is no inner table.
 152    */
 153   nsTableWrapperFrame* GetTableWrapperFrame() const;
 154 };
 155
 156 /**
 157  * HTML caption accessible (html:caption).
 158  */
 159 class HTMLCaptionAccessible : public HyperTextAccessible {
 160  public:
 161   HTMLCaptionAccessible(nsIContent* aContent, DocAccessible* aDoc)
 162       : HyperTextAccessible(aContent, aDoc) {
 163     mType = eHTMLCaptionType;
 164   }
 165
 166   // LocalAccessible
 167   virtual a11y::role NativeRole() const override;
 168   virtual Relation RelationByType(RelationType aRelationType) const override;
 169
 170  protected:
 171   virtual ~HTMLCaptionAccessible() {}
 172 };
 173
 174 }  // namespace a11y
 175 }  // namespace mozilla
 176
 177 #endif