OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef UI_ACCESSIBILITY_AX_TREE_SOURCE_H_ | 5 #ifndef UI_ACCESSIBILITY_AX_TREE_SOURCE_H_ |
6 #define UI_ACCESSIBILITY_AX_TREE_SOURCE_H_ | 6 #define UI_ACCESSIBILITY_AX_TREE_SOURCE_H_ |
7 | 7 |
| 8 #include <vector> |
| 9 |
8 #include "ui/accessibility/ax_node_data.h" | 10 #include "ui/accessibility/ax_node_data.h" |
9 | 11 |
10 namespace ui { | 12 namespace ui { |
11 | 13 |
12 // An AXTreeSource is an abstract interface for a serializable | 14 // An AXTreeSource is an abstract interface for a serializable |
13 // accessibility tree. The tree may be in some other format or | 15 // accessibility tree. The tree may be in some other format or |
14 // may be computed dynamically, but maintains the properties that | 16 // may be computed dynamically, but maintains the properties that |
15 // it's a strict tree, it has a unique id for each node, and all | 17 // it's a strict tree, it has a unique id for each node, and all |
16 // of the accessibility information about a node can be serialized | 18 // of the accessibility information about a node can be serialized |
17 // as an AXNodeData. This is the primary interface to use when | 19 // as an AXNodeData. This is the primary interface to use when |
18 // an accessibility tree will be sent over an IPC before being | 20 // an accessibility tree will be sent over an IPC before being |
19 // consumed. | 21 // consumed. |
20 template<class AXNodeSource> | 22 template<typename AXNodeSource> |
21 class AX_EXPORT AXTreeSource { | 23 class AX_EXPORT AXTreeSource { |
22 public: | 24 public: |
23 virtual ~AXTreeSource() {} | 25 virtual ~AXTreeSource() {} |
24 virtual AXNodeSource* GetRoot() const = 0; | 26 |
25 virtual AXNodeSource* GetFromId(int32 id) const = 0; | 27 // Get the root of the tree. |
26 virtual int32 GetId(const AXNodeSource* node) const = 0; | 28 virtual AXNodeSource GetRoot() const = 0; |
27 virtual int GetChildCount(const AXNodeSource* node) const = 0; | 29 |
28 virtual AXNodeSource* GetChildAtIndex(const AXNodeSource* node, int index) | 30 // Get a node by its id. If no node by that id exists in the tree, return a |
29 const = 0; | 31 // null node, i.e. one that will return false if you call IsValid on it. |
30 virtual AXNodeSource* GetParent(const AXNodeSource* node) const = 0; | 32 virtual AXNodeSource GetFromId(int32 id) const = 0; |
| 33 |
| 34 // Return the id of a node. All ids must be positive integers. |
| 35 virtual int32 GetId(AXNodeSource node) const = 0; |
| 36 |
| 37 // Append all children of |node| to |out_children|. |
| 38 virtual void GetChildren(AXNodeSource node, |
| 39 std::vector<AXNodeSource>* out_children) const = 0; |
| 40 |
| 41 // Get the parent of |node|. |
| 42 virtual AXNodeSource GetParent(AXNodeSource node) const = 0; |
| 43 |
| 44 // Returns true if |node| is valid, and false if it's a null pointer or a |
| 45 // node object representing the null pointer. |
| 46 virtual bool IsValid(AXNodeSource node) const = 0; |
| 47 |
| 48 // Returns true if two nodes are equal. |
| 49 virtual bool IsEqual(AXNodeSource node1, |
| 50 AXNodeSource node2) const = 0; |
| 51 |
| 52 // Return a AXNodeSource representing null. |
| 53 virtual AXNodeSource GetNull() const = 0; |
31 | 54 |
32 // Serialize one node in the tree. | 55 // Serialize one node in the tree. |
33 virtual void SerializeNode( | 56 virtual void SerializeNode(AXNodeSource node, AXNodeData* out_data) const = 0; |
34 const AXNodeSource* node, AXNodeData* out_data) const = 0; | |
35 | 57 |
36 protected: | 58 protected: |
37 AXTreeSource() {} | 59 AXTreeSource() {} |
38 }; | 60 }; |
39 | 61 |
40 } // namespace ui | 62 } // namespace ui |
41 | 63 |
42 #endif // UI_ACCESSIBILITY_AX_TREE_SOURCE_H_ | 64 #endif // UI_ACCESSIBILITY_AX_TREE_SOURCE_H_ |
OLD | NEW |