interact with those applications. </p>
<p>The Registry service provides four basic functions to Assistive Technology (AT) clients:
- <li>It provides a list of the applications who have registered with the
- AT-SPI framework, thereby announcing their participation in the AT-SPI framework.</li>
- <li>It gives access to system device events via the associated DeviceEventController interface.</li>
- </ol>
+ <ol>
+ <li>It provides a list of the applications who have registered with the
+ AT-SPI framework, thereby announcing their participation in the AT-SPI framework.</li>
+ <li>It gives access to system device events via the associated DeviceEventController interface.</li>
+ </ol>
</p>
<p>From the point of view of accessible applications (i.e. AT-SPI service producers),
illustrating the relationship between applications, Registry, and AT is shown at:
http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png </p>
</tp:docstring>
- <method name="registerApplication">
- <tp:docstring>
- Register a new application with the accessibility broker.
- </tp:docstring>
- </method>
- <method name="deregisterApplication">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>De-register an application previously registered with the broker.
- deregisterApplication:</p>
- </tp:docstring>
- <arg direction="in" name="app" type="o" tp:type="Application">
- <tp:docstring>
- A reference to the Application to be deregistered.
- </tp:docstring>
- </arg>
- </method>
- <method name="registerGlobalEventListener">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Register a client's interest in (all) application events of
- a certain type.</p>
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="EventListener">
- <tp:docstring>
- A reference to the requesting EventListener.
- </tp:docstring>
- </arg>
- <arg direction="in" name="eventName" type="s">
- <tp:docstring>
- A string which indicates the type of events about which the client desires notification.
- </tp:docstring>
- </arg>
- </method>
- <method name="deregisterGlobalEventListenerAll">
- <arg direction="in" name="listener" type="o" tp:type="EventListener">
- <tp:docstring>
- The requesting EventListenerRequest that a previously registered client stop receiving global notifications for all events for which it was registered.
- </tp:docstring>
- </arg>
- </method>
- <method name="deregisterGlobalEventListener">
- <arg direction="in" name="listener" type="o" tp:type="EventListener">
- <tp:docstring>
- The requesting EventListener
- </tp:docstring>
- </arg>
- <arg direction="in" name="eventName" type="s">
- <tp:docstring>
- A string indicating the type of eventsRequest that a previously registered client stop receiving global notifications for events of a certain type.
- </tp:docstring>
- </arg>
- </method>
- <method name="getDesktopCount">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Event types: "Window" "Desktop"
- "Window:Create" "Window:Destroy"
- "Window:Iconify" "Window:Restore"
- "Window:Fullscreen" "Window:Resize"
- "Desktop:Create" "Desktop:Destroy"
- "Desktop:Focus" "Desktop:Defocus"
- "Desktop:Reorder"
- "Focus"
- "GtkWidget:show"
- "GObject:notify:propertyname" </p>
-
- <p>( not sure we should allow these last 2 forms,
- since they are toolkit-specific, but they're powerful ) </p>
- <p>Get the current number of desktops.</p>
- </tp:docstring>
- <arg direction="out" type="n" tp:type="short">
+ <method name="getApplications">
<tp:docstring>
- A short integer indicating the current number of Desktops.
+ Gets all the currently registered applications.
</tp:docstring>
+ <arg direction="out" name="applications" type="as">
+ <tp:docstring>
+ A list of strings containing the D-Bus bus names of the applications.
+ </tp:docstring>
</arg>
</method>
- <method name="getDesktop">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get the nth accessible desktop. </p>
- </tp:docstring>
- <arg direction="in" name="n" type="n" tp:type="short"/>
- <arg direction="out" type="o" tp:type="Desktop">
+
+ <signal name="updateApplications">
<tp:docstring>
- A reference to the requested Desktop.
- </tp:docstring>
+ Updates an AT about recently added or removed applications.
+ </tp:docstring>
+ <arg direction="out" name="app" type="is">
+ <tp:docstring>
+ Unique bus name of the application that has been removed or added.
+ The integer is an enumeration:
+ 0 : The application has been removed.
+ 1 : The application has been added.
+ </tp:docstring>
</arg>
- </method>
- <method name="getDesktopList">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get a list of accessible desktops. </p>
- </tp:docstring>
- <arg direction="out" type="as" tp:type="DesktopSeq">
+ </signal>
+
+ <method name="registerApplication">
<tp:docstring>
- A sequence containing references tothe Desktops.
- </tp:docstring>
- </arg>
+ Register a new application with the accessibility registry.
+ </tp:docstring>
+ <arg direction="in" name="app" type="s" tp:type="Application">
+ <tp:docstring>
+ D-Bus Bus name of the application that wishes to be made accessible.
+ </tp:docstring>
+ </arg>
</method>
- <method name="getDeviceEventController">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Obtain an object which can be used to request device event notifications. </p>
- </tp:docstring>
- <arg direction="out" type="o" tp:type="DeviceEventController">
- <tp:docstring>
- An object implementing DeviceEventController
- </tp:docstring>
- </arg>
+
+ <method name="deregisterApplication">
+ <tp:docstring>
+ De-register an application from accessibility registry.
+ </tp:docstring>
+ <arg direction="in" name="app" type="s" tp:type="Application">
+ <tp:docstring>
+ D-Bus Bus name of the application that wishes to be made accessible.
+ </tp:docstring>
+ </arg>
</method>
+
</interface>
</node>
projects / platform / core / uifw / at-spi2-atk.git / blobdiff