Home | History | Annotate | Download | only in accessibility
      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
      3 // found in the LICENSE file.
      4 
      5 #ifndef UI_ACCESSIBILITY_AX_TREE_SOURCE_H_
      6 #define UI_ACCESSIBILITY_AX_TREE_SOURCE_H_
      7 
      8 #include "ui/accessibility/ax_node_data.h"
      9 
     10 namespace ui {
     11 
     12 // An AXTreeSource is an abstract interface for a serializable
     13 // accessibility tree. The tree may be in some other format or
     14 // 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
     16 // of the accessibility information about a node can be serialized
     17 // as an AXNodeData. This is the primary interface to use when
     18 // an accessibility tree will be sent over an IPC before being
     19 // consumed.
     20 template<class AXNodeSource>
     21 class AX_EXPORT AXTreeSource {
     22  public:
     23   virtual ~AXTreeSource() {}
     24   virtual AXNodeSource* GetRoot() const = 0;
     25   virtual AXNodeSource* GetFromId(int32 id) const = 0;
     26   virtual int32 GetId(const AXNodeSource* node) const = 0;
     27   virtual int GetChildCount(const AXNodeSource* node) const = 0;
     28   virtual AXNodeSource* GetChildAtIndex(const AXNodeSource* node, int index)
     29       const = 0;
     30   virtual AXNodeSource* GetParent(const AXNodeSource* node) const = 0;
     31 
     32   // Serialize one node in the tree.
     33   virtual void SerializeNode(
     34       const AXNodeSource* node, AXNodeData* out_data) const = 0;
     35 
     36  protected:
     37   AXTreeSource() {}
     38 };
     39 
     40 }  // namespace ui
     41 
     42 #endif  // UI_ACCESSIBILITY_AX_TREE_SOURCE_H_
     43