xml/org.freedesktop.atspi.Tree.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3         <tp:struct name="AccessibleProxy" array-name="AccessibleProxyArray">
   4                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
   5                         <p>The wire structure of an Accessible object proxy</p>
   6                 </tp:docstring>
   7
   8                 <tp:member type="o" tp:name="path">
   9                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  10                                 <p>D-Bus path of the object.</p>
  11                         </tp:docstring>
  12                 </tp:member>
  13
  14                 <tp:member type="o" tp:name="parent">
  15                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  16                                 <p>D-Bus path of the parent accessible.</p>
  17                         </tp:docstring>
  18                 </tp:member>
  19
  20                 <tp:member type="ao" tp:name="children">
  21                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  22                                 <p>Array of all the child accessibles.</p>
  23                         </tp:docstring>
  24                 </tp:member>
  25
  26                 <tp:member type="as" tp:name="interfaces">
  27                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  28                                 <p>Names of all the interfaces this accessible object supports.</p>
  29                         </tp:docstring>
  30                 </tp:member>
  31
  32                 <tp:member type="s" tp:name="name">
  33                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  34                                 <p>Names of the object.</p>
  35                         </tp:docstring>
  36                 </tp:member>
  37
  38                 <tp:member type="u" tp:name="role">
  39                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  40                                 <p>Accessible role of object.</p>
  41                         </tp:docstring>
  42                 </tp:member>
  43
  44                 <tp:member type="s" tp:name="description">
  45                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  46                                 <p>Extended description of the object.</p>
  47                         </tp:docstring>
  48                 </tp:member>
  49
  50                 <tp:member type="au" tp:name="states">
  51                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  52                                 <p>The object's states.  Each integer contains a bitmask of 32 states (the first item contains states 0-31, and the second item contains states 32-63).</p>
  53                         </tp:docstring>
  54                 </tp:member>
  55         </tp:struct>
  56
  57         <interface name="org.freedesktop.atspi.Tree">
  58                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  59                         <p>The Tree interface provides access to all
  60                         of the Accessible objects that an application
  61                         has available. Information about the objects is
  62                         transferred as a collection to reduce IPC usage.</p>
  63                 </tp:docstring>
  64
  65                 <method name="getRoot">
  66                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  67                                 <p>Gets the D-Bus object path of the
  68                                 root accessible object of the application.</p>
  69                         </tp:docstring>
  70                         <arg name="root" type="o" direction="out">
  71                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  72                                         <p>Path of root Accessible object.</p>
  73                                 </tp:docstring>
  74                         </arg>
  75                 </method>
  76
  77                 <method name="getTree">
  78                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  79                                 <p>Transfers structures representing ALL
  80                                 Accessible objects that currently exist in the
  81                                 application. This should be used to create
  82                                 a mirror of the tree of Accessibles within the AT.</p>
  83                         </tp:docstring>
  84                         <arg name="nodes" type="a(ooaoassusau)" direction="out" tp:type="AccessibleProxy[]">
  85                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  86                                         <p>Array of Accessible Object proxy structures.</p>
  87                                 </tp:docstring>
  88                         </arg>
  89                 </method>
  90
  91                 <signal name="updateAccessible">
  92                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  93                                 <p>Updates all mirrors. Re-sends all all the
  94                                 accessible objects that have changed since the last
  95                                 updateTree signal was send</p>
  96                         </tp:docstring>
  97                         <arg name="nodesAdded" type="(ooaoassusau)" tp:type="AccessibleProxy[]">
  98                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  99                                         <p>Array of Accessible Object proxy structures to be added.</p>
 100                                 </tp:docstring>
 101                         </arg>
 102                 </signal>
 103
 104                 <signal name="removeAccessible">
 105                         <arg name="nodeRemoved" type="o">
 106                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 107                                         <p>Accessible Object proxy structure to be removed.</p>
 108                                 </tp:docstring>
 109                         </arg>
 110                 </signal>
 111         </interface>
 112 </node>