1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
2 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
3 <tp:copyright>Copyright 2008 Codethink Ltd.</tp:copyright>
4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
5 <tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
7 <p>This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.</p>
12 <p>This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.</p>
17 <p>You should have received a copy of the GNU Library General Public
18 License along with this library; if not, write to the
19 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.</p>
23 <tp:enum name="TreeUpdateFlag" type="q">
24 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
25 <p>Flag indicating whether an accessible object proxy should be
26 removed or updated.</p>
28 <tp:enumvalue suffix="TREE_UPDATE_ACCESSIBLE" value="0">
29 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
30 <p>The accessible object proxies cached values should be updated</p>
33 <tp:enumvalue suffix="TREE_REMOVE_ACCESSIBLE" value="1">
34 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
35 <p>The accessible object proxy should be removed or set to invalid.</p>
40 <tp:struct name="AccessibleProxy" array-name="AccessibleProxyArray">
41 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
42 <p>The wire structure of an Accessible object proxy</p>
45 <tp:member type="q" tp:name="update" tp:type="TreeUpdateFlag">
46 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
47 <p>Flag stating whether the object is to be updated or removed</p>
51 <tp:member type="o" tp:name="path">
52 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
53 <p>D-Bus path of the object.</p>
57 <tp:member type="o" tp:name="parent">
58 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
59 <p>D-Bus path of the parent accessible.</p>
63 <tp:member type="ao" tp:name="children">
64 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
65 <p>Array of all the child accessibles.</p>
69 <tp:member type="as" tp:name="interfaces">
70 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
71 <p>Names of all the interfaces this accessible object supports.</p>
75 <tp:member type="s" tp:name="name">
76 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
77 <p>Names of the object.</p>
81 <tp:member type="u" tp:name="role">
82 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
83 <p>Accessible role of object.</p>
87 <tp:member type="s" tp:name="description">
88 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
89 <p>Extended description of the object.</p>
94 <interface name="org.freedesktop.atspi.Tree">
95 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
96 <p>The Tree interface provides access to all
97 of the Accessible objects that an application
98 has available. Information about the objects is
99 transferred as a collection to reduce IPC usage.</p>
102 <method name="getRoot">
103 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
104 <p>Gets the D-Bus object path of the
105 root accessible object of the application.</p>
107 <arg name="root" type="o" direction="out">
108 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
109 <p>Path of root Accessible object.</p>
114 <method name="getTree">
115 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
116 <p>Transfers structures representing ALL
117 Accessible objects that currently exist in the
118 application. This should be used to create
119 a mirror of the tree of Accessibles within the AT.</p>
121 <arg name="nodes" type="a(qooaoassus)" direction="out" tp:type="AccessibleProxy[]">
122 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
123 <p>Array of Accessible Object proxy structures.</p>
128 <signal name="updateTree">
129 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
130 <p>Updates all mirrors. Re-sends all all the
131 accessible objects that have changed since the last
132 updateTree signal was send</p>
134 <arg name="nodes" type="a(qooaoassus)" tp:type="AccessibleProxy[]">
135 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
136 <p>Array of Accessible Object proxy structures.</p>