xml/Accessibility_Tree.xml

   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>
  11
  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>
  16
  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>
  21         </tp:license>
  22
  23         <tp:struct name="AccessibleProxy" array-name="AccessibleProxyArray">
  24                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  25                         <p>The wire structure of an Accessible object proxy</p>
  26                 </tp:docstring>
  27
  28                 <tp:member type="o" tp:name="path">
  29                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  30                                 <p>D-Bus path of the object.</p>
  31                         </tp:docstring>
  32                 </tp:member>
  33
  34                 <tp:member type="o" tp:name="parent">
  35                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  36                                 <p>D-Bus path of the parent accessible.</p>
  37                         </tp:docstring>
  38                 </tp:member>
  39
  40                 <tp:member type="ao" tp:name="children">
  41                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  42                                 <p>Array of all the child accessibles.</p>
  43                         </tp:docstring>
  44                 </tp:member>
  45
  46                 <tp:member type="as" tp:name="interfaces">
  47                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  48                                 <p>Names of all the interfaces this accessible object supports.</p>
  49                         </tp:docstring>
  50                 </tp:member>
  51
  52                 <tp:member type="s" tp:name="name">
  53                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  54                                 <p>Names of the object.</p>
  55                         </tp:docstring>
  56                 </tp:member>
  57
  58                 <tp:member type="u" tp:name="role">
  59                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  60                                 <p>Accessible role of object.</p>
  61                         </tp:docstring>
  62                 </tp:member>
  63
  64                 <tp:member type="s" tp:name="description">
  65                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  66                                 <p>Extended description of the object.</p>
  67                         </tp:docstring>
  68                 </tp:member>
  69         </tp:struct>
  70
  71         <interface name="org.freedesktop.atspi.Tree">
  72                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  73                         <p>The Tree interface provides access to all
  74                         of the Accessible objects that an application
  75                         has available. Information about the objects is
  76                         transferred as a collection to reduce IPC usage.</p>
  77                 </tp:docstring>
  78
  79                 <method name="getRoot">
  80                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  81                                 <p>Gets the D-Bus object path of the
  82                                 root accessible object of the application.</p>
  83                         </tp:docstring>
  84                         <arg name="root" type="o" direction="out">
  85                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  86                                         <p>Path of root Accessible object.</p>
  87                                 </tp:docstring>
  88                         </arg>
  89                 </method>
  90
  91                 <method name="getTree">
  92                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  93                                 <p>Transfers structures representing ALL
  94                                 Accessible objects that currently exist in the
  95                                 application. This should be used to create
  96                                 a mirror of the tree of Accessibles within the AT.</p>
  97                         </tp:docstring>
  98                         <arg name="nodes" type="a(ooaoassus)" direction="out" tp:type="AccessibleProxy[]">
  99                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 100                                         <p>Array of Accessible Object proxy structures.</p>
 101                                 </tp:docstring>
 102                         </arg>
 103                 </method>
 104
 105                 <signal name="updateTree">
 106                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 107                                 <p>Updates all mirrors. Re-sends all all the
 108                                 accessible objects that have changed since the last
 109                                 updateTree signal was send</p>
 110                         </tp:docstring>
 111                         <arg name="nodesAdded" type="a(ooaoassus)" tp:type="AccessibleProxy[]">
 112                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 113                                         <p>Array of Accessible Object proxy structures to be added.</p>
 114                                 </tp:docstring>
 115                         </arg>
 116                         <arg name="nodesRemoved" type="ao">
 117                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 118                                         <p>Array of Accessible Object proxy structures to be removed.</p>
 119                                 </tp:docstring>
 120                         </arg>
 121                 </signal>
 122         </interface>
 123 </node>