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
   4
   5
   6
   7
   8 <interface name="org.freedesktop.atspi.Registry">
   9   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  10     <p>The Registry is a service through which applications providing
  11       accessibility services (servers) can rendezvous with consumers of those
  12       services (Assistive Technologies).  The Registry is the first "port of call" for
  13       accessible applications and for assistive technologies wishing to query and
  14       interact with those applications.  </p>
  15
  16     <p>The Registry service provides four basic functions to Assistive Technology (AT) clients:
  17       \li it provides a list of the applications who have registered with the AT-SPI
  18       framework, thereby announcing their participation in the AT-SPI framework;
  19       \li it allows AT clients to register for notification of changes in application
  20       state (at-spi Events);
  21       \li it dispatches/relays said events from participating applications to
  22       the registered listeners;
  23       \li it gives access to system device events via the associated DeviceEventController
  24       interface.  </p>
  25
  26     <p>From the point of view of accessible applications (i.e. AT-SPI service producers),
  27       the Registry is primarily a registration and event delivery service.  Applications
  28       normally only call the registerApplication and deregisterApplication Registry methods,
  29       and its inherited EventListener::notifyEvent method.  </p>
  30
  31     <p>@note Although all application events are dispatched via the Registry, other AT client
  32       calls are serviced directly by the applications, rather than being relayed via the
  33       Registry.  The AT client obtains references to these application objects
  34       via the enumeration of Desktop instances whose children are Application instances
  35       (Registry::getDesktopList) and via examination of the 'source' member of the Event
  36       structure.   </p>
  37
  38     <p>The Registry normally lives in its own process space; communication via Registry and
  39       both application services and AT clients takes place via IPC.  A process space diagram
  40       illustrating the relationship between applications, Registry, and AT is shown below.
  41       @image html "http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png"  </p>
  42
  43     <p>@see Desktop, Application, Event, EventListener</p>
  44   </tp:docstring>
  45   <method name="registerApplication">
  46     <tp:docstring>
  47       Register a new application with the accessibility broker.
  48     </tp:docstring>
  49   </method>
  50   <method name="deregisterApplication">
  51     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  52       <p>De-register an application previously registered with the broker.
  53         deregisterApplication:</p>
  54     </tp:docstring>
  55     <arg direction="in" name="app" type="o" tp:type="Application">
  56     <tp:docstring>
  57       a reference to the Application to be deregistered.
  58     </tp:docstring>
  59     </arg>
  60   </method>
  61   <method name="registerGlobalEventListener">
  62     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  63       <p>Register a client's interest in (all) application events of
  64         a certain type.</p>
  65     </tp:docstring>
  66     <arg direction="in" name="listener" type="o" tp:type="EventListener">
  67     <tp:docstring>
  68       a reference to the requesting ::EventListener.
  69     </tp:docstring>
  70     </arg>
  71     <arg direction="in" name="eventName" type="s">
  72     <tp:docstring>
  73       a string which indicates the type of events about which the client desires notification.
  74     </tp:docstring>
  75     </arg>
  76   </method>
  77   <method name="deregisterGlobalEventListenerAll">
  78     <tp:docstring>
  79       deregisterGlobalEventListenerAll:
  80     </tp:docstring>
  81     <arg direction="in" name="listener" type="o" tp:type="EventListener">
  82     <tp:docstring>
  83       the requesting EventListenerRequest that a previously registered client stop receivingglobal notifications for all events for which it was registered.
  84     </tp:docstring>
  85     </arg>
  86   </method>
  87   <method name="deregisterGlobalEventListener">
  88     <tp:docstring>
  89       deregisterGlobalEventListener:
  90     </tp:docstring>
  91     <arg direction="in" name="listener" type="o" tp:type="EventListener">
  92     <tp:docstring>
  93       the requesting EventListener
  94     </tp:docstring>
  95     </arg>
  96     <arg direction="in" name="eventName" type="s">
  97     <tp:docstring>
  98       a string indicating the type of eventsRequest that a previously registered client stop receivingglobal notifications for events of a certain type.
  99     </tp:docstring>
 100     </arg>
 101   </method>
 102   <method name="getDesktopCount">
 103     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 104       <p>event types: "Window" "Desktop"
 105         "Window:Create" "Window:Destroy"
 106         "Window:Iconify" "Window:Restore"
 107         "Window:Fullscreen" "Window:Resize"
 108         "Desktop:Create" "Desktop:Destroy"
 109         "Desktop:Focus" "Desktop:Defocus"
 110         "Desktop:Reorder"
 111         "Focus"
 112         "GtkWidget:show"
 113         "GObject:notify:&lt;propertyname&gt;"     </p>
 114
 115       <p>( not sure we should allow these last 2 forms,
 116         since they are toolkit-specific, but they're powerful )    </p>
 117
 118       <p>getDesktopCount:    </p>
 119
 120       <p>Get the current number of desktops.</p>
 121     </tp:docstring>
 122     <arg direction="out" type="n" tp:type="short">
 123     <tp:docstring>
 124       a short integer indicating the current number of Desktops.
 125     </tp:docstring>
 126     </arg>
 127   </method>
 128   <method name="getDesktop">
 129     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 130       <p>getDesktop:
 131         @n: the index of the requested Desktop.    </p>
 132
 133       <p>Get the nth accessible desktop.     </p>
 134     </tp:docstring>
 135     <arg direction="in" name="n" type="n" tp:type="short"/>
 136     <arg direction="out" type="o" tp:type="Desktop">
 137     <tp:docstring>
 138       a reference to the requested Desktop.
 139     </tp:docstring>
 140     </arg>
 141   </method>
 142   <method name="getDesktopList">
 143     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 144       <p>Get a list of accessible desktops.     </p>
 145     </tp:docstring>
 146     <arg direction="out" type="as" tp:type="DesktopSeq">
 147     <tp:docstring>
 148       a sequence containing references tothe Desktops.
 149     </tp:docstring>
 150     </arg>
 151   </method>
 152   <method name="getDeviceEventController">
 153     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 154       <p>Obtain an object which can be used to request device event notifications.    </p>
 155     </tp:docstring>
 156     <arg direction="out" type="o" tp:type="DeviceEventController">
 157     <tp:docstring>
 158       an object implementing DeviceEventController
 159     </tp:docstring>
 160     </arg>
 161   </method>
 162 </interface>
 163 </node>