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         </tp:struct>
  50
  51         <interface name="org.freedesktop.atspi.Tree">
  52                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  53                         <p>The Tree interface provides access to all
  54                         of the Accessible objects that an application
  55                         has available. Information about the objects is
  56                         transferred as a collection to reduce IPC usage.</p>
  57                 </tp:docstring>
  58
  59                 <method name="getRoot">
  60                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  61                                 <p>Gets the D-Bus object path of the
  62                                 root accessible object of the application.</p>
  63                         </tp:docstring>
  64                         <arg name="root" type="o" direction="out">
  65                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  66                                         <p>Path of root Accessible object.</p>
  67                                 </tp:docstring>
  68                         </arg>
  69                 </method>
  70
  71                 <method name="getTree">
  72                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  73                                 <p>Transfers structures representing ALL
  74                                 Accessible objects that currently exist in the
  75                                 application. This should be used to create
  76                                 a mirror of the tree of Accessibles within the AT.</p>
  77                         </tp:docstring>
  78                         <arg name="nodes" type="a(ooaoassus)" direction="out" tp:type="AccessibleProxy[]">
  79                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  80                                         <p>Array of Accessible Object proxy structures.</p>
  81                                 </tp:docstring>
  82                         </arg>
  83                 </method>
  84
  85                 <signal name="updateTree">
  86                         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  87                                 <p>Updates all mirrors. Re-sends all all the
  88                                 accessible objects that have changed since the last
  89                                 updateTree signal was send</p>
  90                         </tp:docstring>
  91                         <arg name="nodesAdded" type="a(ooaoassus)" tp:type="AccessibleProxy[]">
  92                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  93                                         <p>Array of Accessible Object proxy structures to be added.</p>
  94                                 </tp:docstring>
  95                         </arg>
  96                         <arg name="nodesRemoved" type="ao">
  97                                 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  98                                         <p>Array of Accessible Object proxy structures to be removed.</p>
  99                                 </tp:docstring>
 100                         </arg>
 101                 </signal>
 102         </interface>
 103 </node>