| // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_ |
| #define CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_ |
| |
| #include <map> |
| #include <utility> |
| #include <vector> |
| |
| #include "base/basictypes.h" |
| #include "base/strings/string16.h" |
| #include "base/strings/string_split.h" |
| #include "build/build_config.h" |
| #include "content/common/content_export.h" |
| #include "third_party/WebKit/public/web/WebAXEnums.h" |
| #include "ui/accessibility/ax_node.h" |
| #include "ui/accessibility/ax_node_data.h" |
| #include "ui/accessibility/ax_text_utils.h" |
| |
| #if defined(OS_MACOSX) && __OBJC__ |
| @class BrowserAccessibilityCocoa; |
| #endif |
| |
| namespace content { |
| class BrowserAccessibilityManager; |
| #if defined(OS_WIN) |
| class BrowserAccessibilityWin; |
| #elif defined(OS_LINUX) && !defined(OS_CHROMEOS) && defined(USE_X11) |
| class BrowserAccessibilityAuraLinux; |
| #endif |
| |
| //////////////////////////////////////////////////////////////////////////////// |
| // |
| // BrowserAccessibility |
| // |
| // A BrowserAccessibility object represents one node in the accessibility |
| // tree on the browser side. It exactly corresponds to one WebAXObject from |
| // Blink. It's owned by a BrowserAccessibilityManager. |
| // |
| // There are subclasses of BrowserAccessibility for each platform where |
| // we implement native accessibility APIs. This base class is used occasionally |
| // for tests. |
| // |
| //////////////////////////////////////////////////////////////////////////////// |
| class CONTENT_EXPORT BrowserAccessibility { |
| public: |
| // Creates a platform specific BrowserAccessibility. Ownership passes to the |
| // caller. |
| static BrowserAccessibility* Create(); |
| |
| virtual ~BrowserAccessibility(); |
| |
| // Called only once, immediately after construction. The constructor doesn't |
| // take any arguments because in the Windows subclass we use a special |
| // function to construct a COM object. |
| virtual void Init(BrowserAccessibilityManager* manager, ui::AXNode* node); |
| |
| // Called after the object is first initialized and again every time |
| // its data changes. |
| virtual void OnDataChanged() {} |
| |
| virtual void OnSubtreeWillBeDeleted() {} |
| |
| // Called when the location changed. |
| virtual void OnLocationChanged() {} |
| |
| // Return true if this object is equal to or a descendant of |ancestor|. |
| bool IsDescendantOf(const BrowserAccessibility* ancestor) const; |
| |
| // Returns true if this object is used only for representing text. |
| bool IsTextOnlyObject() const; |
| |
| // Returns true if this is a leaf node on this platform, meaning any |
| // children should not be exposed to this platform's native accessibility |
| // layer. Each platform subclass should implement this itself. |
| // The definition of a leaf may vary depending on the platform, |
| // but a leaf node should never have children that are focusable or |
| // that might send notifications. |
| virtual bool PlatformIsLeaf() const; |
| |
| // Returns the number of children of this object, or 0 if PlatformIsLeaf() |
| // returns true. |
| uint32 PlatformChildCount() const; |
| |
| // Return a pointer to the child at the given index, or NULL for an |
| // invalid index. Returns NULL if PlatformIsLeaf() returns true. |
| BrowserAccessibility* PlatformGetChild(uint32 child_index) const; |
| |
| // Returns true if an ancestor of this node (not including itself) is a |
| // leaf node, meaning that this node is not actually exposed to the |
| // platform. |
| bool PlatformIsChildOfLeaf() const; |
| |
| BrowserAccessibility* GetPreviousSibling() const; |
| BrowserAccessibility* GetNextSibling() const; |
| |
| // Returns nullptr if there are no children. |
| BrowserAccessibility* PlatformDeepestFirstChild() const; |
| // Returns nullptr if there are no children. |
| BrowserAccessibility* PlatformDeepestLastChild() const; |
| |
| // Returns the bounds of this object in coordinates relative to the |
| // top-left corner of the overall web area. |
| gfx::Rect GetLocalBoundsRect() const; |
| |
| // Returns the bounds of this object in screen coordinates. |
| gfx::Rect GetGlobalBoundsRect() const; |
| |
| // Returns the bounds of the given range in coordinates relative to the |
| // top-left corner of the overall web area. Only valid when the |
| // role is WebAXRoleStaticText. |
| gfx::Rect GetLocalBoundsForRange(int start, int len) const; |
| |
| // Same as GetLocalBoundsForRange, in screen coordinates. Only valid when |
| // the role is WebAXRoleStaticText. |
| gfx::Rect GetGlobalBoundsForRange(int start, int len) const; |
| |
| // Searches in the given text and from the given offset until the start of |
| // the next or previous word is found and returns its position. |
| // In case there is no word boundary before or after the given offset, it |
| // returns one past the last character, i.e. the text's length. |
| // If the given offset is already at the start of a word, returns the start |
| // of the next word if the search is forwards and the given offset if it is |
| // backwards. |
| // If the start offset is equal to -1 and the search is in the forwards |
| // direction, returns the start boundary of the first word. |
| // Start offsets that are not in the range -1 to text length are invalid. |
| int GetWordStartBoundary( |
| int start, ui::TextBoundaryDirection direction) const; |
| |
| // Returns the deepest descendant that contains the specified point |
| // (in global screen coordinates). |
| BrowserAccessibility* BrowserAccessibilityForPoint(const gfx::Point& point); |
| |
| // Marks this object for deletion, releases our reference to it, and |
| // nulls out the pointer to the underlying AXNode. May not delete |
| // the object immediately due to reference counting. |
| // |
| // Reference counting is used on some platforms because the |
| // operating system may hold onto a reference to a BrowserAccessibility |
| // object even after we're through with it. When a BrowserAccessibility |
| // has had Destroy() called but its reference count is not yet zero, |
| // instance_active() returns false and queries on this object return failure. |
| virtual void Destroy(); |
| |
| // Subclasses should override this to support platform reference counting. |
| virtual void NativeAddReference() { } |
| |
| // Subclasses should override this to support platform reference counting. |
| virtual void NativeReleaseReference(); |
| |
| // |
| // Accessors |
| // |
| |
| BrowserAccessibilityManager* manager() const { return manager_; } |
| bool instance_active() const { return node_ != NULL; } |
| ui::AXNode* node() const { return node_; } |
| |
| // These access the internal accessibility tree, which doesn't necessarily |
| // reflect the accessibility tree that should be exposed on each platform. |
| // Use PlatformChildCount and PlatformGetChild to implement platform |
| // accessibility APIs. |
| uint32 InternalChildCount() const; |
| BrowserAccessibility* InternalGetChild(uint32 child_index) const; |
| |
| BrowserAccessibility* GetParent() const; |
| int32 GetIndexInParent() const; |
| |
| int32 GetId() const; |
| const ui::AXNodeData& GetData() const; |
| gfx::Rect GetLocation() const; |
| int32 GetRole() const; |
| int32 GetState() const; |
| |
| typedef base::StringPairs HtmlAttributes; |
| const HtmlAttributes& GetHtmlAttributes() const; |
| |
| // Returns true if this is a native platform-specific object, vs a |
| // cross-platform generic object. Don't call ToBrowserAccessibilityXXX if |
| // IsNative returns false. |
| virtual bool IsNative() const; |
| |
| #if defined(OS_MACOSX) && __OBJC__ |
| BrowserAccessibilityCocoa* ToBrowserAccessibilityCocoa(); |
| #elif defined(OS_WIN) |
| BrowserAccessibilityWin* ToBrowserAccessibilityWin(); |
| #elif defined(OS_LINUX) && !defined(OS_CHROMEOS) && defined(USE_X11) |
| BrowserAccessibilityAuraLinux* ToBrowserAccessibilityAuraLinux(); |
| #endif |
| |
| // Accessing accessibility attributes: |
| // |
| // There are dozens of possible attributes for an accessibility node, |
| // but only a few tend to apply to any one object, so we store them |
| // in sparse arrays of <attribute id, attribute value> pairs, organized |
| // by type (bool, int, float, string, int list). |
| // |
| // There are three accessors for each type of attribute: one that returns |
| // true if the attribute is present and false if not, one that takes a |
| // pointer argument and returns true if the attribute is present (if you |
| // need to distinguish between the default value and a missing attribute), |
| // and another that returns the default value for that type if the |
| // attribute is not present. In addition, strings can be returned as |
| // either std::string or base::string16, for convenience. |
| |
| bool HasBoolAttribute(ui::AXBoolAttribute attr) const; |
| bool GetBoolAttribute(ui::AXBoolAttribute attr) const; |
| bool GetBoolAttribute(ui::AXBoolAttribute attr, bool* value) const; |
| |
| bool HasFloatAttribute(ui::AXFloatAttribute attr) const; |
| float GetFloatAttribute(ui::AXFloatAttribute attr) const; |
| bool GetFloatAttribute(ui::AXFloatAttribute attr, float* value) const; |
| |
| bool HasIntAttribute(ui::AXIntAttribute attribute) const; |
| int GetIntAttribute(ui::AXIntAttribute attribute) const; |
| bool GetIntAttribute(ui::AXIntAttribute attribute, int* value) const; |
| |
| bool HasStringAttribute( |
| ui::AXStringAttribute attribute) const; |
| const std::string& GetStringAttribute(ui::AXStringAttribute attribute) const; |
| bool GetStringAttribute(ui::AXStringAttribute attribute, |
| std::string* value) const; |
| |
| bool GetString16Attribute(ui::AXStringAttribute attribute, |
| base::string16* value) const; |
| base::string16 GetString16Attribute( |
| ui::AXStringAttribute attribute) const; |
| |
| bool HasIntListAttribute(ui::AXIntListAttribute attribute) const; |
| const std::vector<int32>& GetIntListAttribute( |
| ui::AXIntListAttribute attribute) const; |
| bool GetIntListAttribute(ui::AXIntListAttribute attribute, |
| std::vector<int32>* value) const; |
| |
| // Retrieve the value of a html attribute from the attribute map and |
| // returns true if found. |
| bool GetHtmlAttribute(const char* attr, base::string16* value) const; |
| bool GetHtmlAttribute(const char* attr, std::string* value) const; |
| |
| // Utility method to handle special cases for ARIA booleans, tristates and |
| // booleans which have a "mixed" state. |
| // |
| // Warning: the term "Tristate" is used loosely by the spec and here, |
| // as some attributes support a 4th state. |
| // |
| // The following attributes are appropriate to use with this method: |
| // aria-selected (selectable) |
| // aria-grabbed (grabbable) |
| // aria-expanded (expandable) |
| // aria-pressed (toggleable/pressable) -- supports 4th "mixed" state |
| // aria-checked (checkable) -- supports 4th "mixed state" |
| bool GetAriaTristate(const char* attr_name, |
| bool* is_defined, |
| bool* is_mixed) const; |
| |
| // Returns true if the bit corresponding to the given state enum is 1. |
| bool HasState(ui::AXState state_enum) const; |
| |
| // Returns true if this node is an cell or an table header. |
| bool IsCellOrTableHeaderRole() const; |
| |
| // Returns true if this node is an editable text field of any kind. |
| bool IsEditableText() const; |
| |
| // True if this is a web area, and its grandparent is a presentational iframe. |
| bool IsWebAreaForPresentationalIframe() const; |
| |
| // Is any control, like a button, text field, etc. |
| bool IsControl() const; |
| |
| protected: |
| BrowserAccessibility(); |
| |
| // The manager of this tree of accessibility objects. |
| BrowserAccessibilityManager* manager_; |
| |
| // The underlying node. |
| ui::AXNode* node_; |
| |
| private: |
| // Return the sum of the lengths of all static text descendants, |
| // including this object if it's static text. |
| int GetStaticTextLenRecursive() const; |
| |
| // If a bounding rectangle is empty, compute it based on the union of its |
| // children, since most accessibility APIs don't like elements with no |
| // bounds, but "virtual" elements in the accessibility tree that don't |
| // correspond to a layed-out element sometimes don't have bounds. |
| void FixEmptyBounds(gfx::Rect* bounds) const; |
| |
| // Convert the bounding rectangle of an element (which is relative to |
| // its nearest scrollable ancestor) to local bounds (which are relative |
| // to the top of the web accessibility tree). |
| gfx::Rect ElementBoundsToLocalBounds(gfx::Rect bounds) const; |
| |
| DISALLOW_COPY_AND_ASSIGN(BrowserAccessibility); |
| }; |
| |
| } // namespace content |
| |
| #endif // CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_ |