xml/org.freedesktop.atspi.Registry.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3 <interface name="org.freedesktop.atspi.Registry">
   4   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
   5     <p>The Registry is a service through which applications providing
   6       accessibility services (servers) can rendezvous with consumers of those
   7       services (Assistive Technologies).  The Registry is the first "port of call" for
   8       accessible applications and for assistive technologies wishing to query and
   9       interact with those applications.  </p>
  10
  11     <p>The Registry service provides four basic functions to Assistive Technology (AT) clients:
  12         <ol>
  13             <li>It provides a list of the applications who have registered with the
  14                 AT-SPI framework, thereby announcing their participation in the AT-SPI framework.</li>
  15             <li>It gives access to system device events via the associated DeviceEventController interface.</li>
  16         </ol>
  17     </p>
  18
  19     <p>From the point of view of accessible applications (i.e. AT-SPI service producers),
  20       the Registry is primarily a registration and event delivery service.  Applications
  21       normally only call the registerApplication and deregisterApplication Registry methods,
  22       and its inherited EventListener::notifyEvent method.  </p>
  23
  24     <p>Although all application events are dispatched via the Registry, other AT client
  25       calls are serviced directly by the applications, rather than being relayed via the
  26       Registry.  The AT client obtains references to these application objects
  27       via the enumeration of Desktop instances whose children are Application instances
  28       (Registry.getDesktopList) and via examination of the 'source' member of the Event
  29       structure.   </p>
  30
  31     <p>The Registry normally lives in its own process space; communication via Registry and
  32       both application services and AT clients takes place via IPC.  A process space diagram
  33       illustrating the relationship between applications, Registry, and AT is shown at:
  34       http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png  </p>
  35   </tp:docstring>
  36
  37   <method name="getApplications">
  38     <tp:docstring>
  39         Gets all the currently registered applications.
  40     </tp:docstring>
  41     <arg direction="out" name="applications" type="as">
  42         <tp:docstring>
  43             A list of strings containing the D-Bus bus names of the applications.
  44         </tp:docstring>
  45     </arg>
  46   </method>
  47
  48   <signal name="updateApplications">
  49     <tp:docstring>
  50         Updates an AT about recently added or removed applications.
  51     </tp:docstring>
  52     <arg direction="out" name="app" type="is">
  53         <tp:docstring>
  54                 Unique bus name of the application that has been removed or added.
  55                 The integer is an enumeration:
  56                            0 : The application has been removed.
  57                            1 : The application has been added.
  58         </tp:docstring>
  59     </arg>
  60   </signal>
  61
  62   <method name="registerApplication">
  63     <tp:docstring>
  64       Register a new application with the accessibility registry.
  65    </tp:docstring>
  66    <arg direction="in" name="app" type="s" tp:type="Application">
  67       <tp:docstring>
  68          D-Bus Bus name of the application that wishes to be made accessible.
  69       </tp:docstring>
  70    </arg>
  71   </method>
  72
  73   <method name="deregisterApplication">
  74    <tp:docstring>
  75       De-register an application from accessibility registry.
  76    </tp:docstring>
  77    <arg direction="in" name="app" type="s" tp:type="Application">
  78       <tp:docstring>
  79          D-Bus Bus name of the application that wishes to be made accessible.
  80       </tp:docstring>
  81    </arg>
  82   </method>
  83
  84 </interface>
  85 </node>