<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>at-spi-idl: Accessibility::Registry Interface Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceAccessibility.html">Accessibility</a>::<a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a></div>
<h1>Accessibility::Registry Interface Reference</h1><!-- doxytag: class="Accessibility::Registry" --><!-- doxytag: inherits="Accessibility::EventListener" --><code>import "<a class="el" href="Accessibility__Registry_8idl-source.html">Accessibility_Registry.idl</a>";</code>
<p>
<p>Inheritance diagram for Accessibility::Registry:
<p><center><img src="interfaceAccessibility_1_1Registry.png" usemap="#Accessibility::Registry_map" border="0" alt=""></center>
<map name="Accessibility::Registry_map">
<area href="interfaceAccessibility_1_1EventListener.html" alt="Accessibility::EventListener" shape="rect" coords="0,0,166,24">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oneway void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#221f1ab46b17ad1585fc7ed5660a1d50">registerApplication</a> (in <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a> app)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#903e8b7a8aae6cc002a8fa08ee1a5e0c">deregisterApplication</a> (in <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a> app)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#c8411c32e2af083ceb73850e24c62bc4">registerGlobalEventListener</a> (in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> listener, in string eventName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#07418789b0d5f975cb128b60c192e889">deregisterGlobalEventListenerAll</a> (in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> listener)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#cd2cfbec1123952216e02c9279e3249d">deregisterGlobalEventListener</a> (in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> listener, in string eventName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#e925f551f0c609d4a901241d5b0becf1">getDesktopCount</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Desktop.html">Desktop</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#b3ca4fb097932eda3d8118e4fab10144">getDesktop</a> (in short n)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceAccessibility.html#21062610dc08191c6e6fc7618bb30020">DesktopSeq</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#d6f1a185f262ba3606da9f4f2311806d">getDesktopList</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html">DeviceEventController</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Registry.html#777e056ae1557558392da432fd5fc210">getDeviceEventController</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> is a service through which applications providing accessibility services (servers) can rendezvous with consumers of those services (Assistive Technologies). The <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> is the first "port of call" for accessible applications and for assistive technologies wishing to query and interact with those applications.<p>
The <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> service provides four basic functions to Assistive Technology (AT) clients: <ul>
<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 allows AT clients to register for notification of changes in application state (at-spi Events); </li>
<li>it dispatches/relays said events from participating applications to the registered listeners; </li>
<li>it gives access to system device events via the associated <a class="el" href="interfaceAccessibility_1_1DeviceEventController.html">DeviceEventController</a> interface.</li>
</ul>
From the point of view of accessible applications (i.e. AT-SPI service producers), the <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> is primarily a registration and event delivery service. Applications normally only call the registerApplication and deregisterApplication <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> methods, and its inherited <a class="el" href="interfaceAccessibility_1_1EventListener.html#cf4d368964e0671f54c2cae9c9599fb1">EventListener::notifyEvent</a> method.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Although all application events are dispatched via the <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a>, other AT client calls are serviced directly by the applications, rather than being relayed via the <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a>. The AT client obtains references to these application objects via the enumeration of <a class="el" href="interfaceAccessibility_1_1Desktop.html">Desktop</a> instances whose children are <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a> instances (<a class="el" href="interfaceAccessibility_1_1Registry.html#d6f1a185f262ba3606da9f4f2311806d">Registry::getDesktopList</a>) and via examination of the 'source' member of the <a class="el" href="structAccessibility_1_1Event.html">Event</a> structure.</dd></dl>
The <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> normally lives in its own process space; communication via <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> and both application services and AT clients takes place via IPC. A process space diagram illustrating the relationship between applications, <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a>, and AT is shown below. <div align="center">
<img src="http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png" alt="SPIBlockDiagram.png">
</div>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Desktop.html">Desktop</a>, <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a>, <a class="el" href="structAccessibility_1_1Event.html">Event</a>, <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> </dd></dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="221f1ab46b17ad1585fc7ed5660a1d50"></a><!-- doxytag: member="Accessibility::Registry::registerApplication" ref="221f1ab46b17ad1585fc7ed5660a1d50" args="(in Application app)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oneway void Accessibility::Registry::registerApplication </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a> </td>
<td class="paramname"> <em>app</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register a new application with the accessibility broker. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>app,:</em> </td><td>a reference to the requesting <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a> </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="903e8b7a8aae6cc002a8fa08ee1a5e0c"></a><!-- doxytag: member="Accessibility::Registry::deregisterApplication" ref="903e8b7a8aae6cc002a8fa08ee1a5e0c" args="(in Application app)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Registry::deregisterApplication </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a> </td>
<td class="paramname"> <em>app</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
De-register an application previously registered with the broker. deregisterApplication: <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>app,:</em> </td><td>a reference to the <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a> to be deregistered. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c8411c32e2af083ceb73850e24c62bc4"></a><!-- doxytag: member="Accessibility::Registry::registerGlobalEventListener" ref="c8411c32e2af083ceb73850e24c62bc4" args="(in EventListener listener, in string eventName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Registry::registerGlobalEventListener </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> </td>
<td class="paramname"> <em>listener</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"> <em>eventName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register a client's interest in (all) application events of a certain type. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>listener,:</em> </td><td>a reference to the requesting EventListener. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eventName,:</em> </td><td>a string which indicates the type of events about which the client desires notification. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="07418789b0d5f975cb128b60c192e889"></a><!-- doxytag: member="Accessibility::Registry::deregisterGlobalEventListenerAll" ref="07418789b0d5f975cb128b60c192e889" args="(in EventListener listener)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Registry::deregisterGlobalEventListenerAll </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> </td>
<td class="paramname"> <em>listener</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
deregisterGlobalEventListenerAll: <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>listener,:</em> </td><td>the requesting <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a></td></tr>
</table>
</dl>
Request that a previously registered client stop receiving global notifications for all events for which it was registered.
</div>
</div><p>
<a class="anchor" name="cd2cfbec1123952216e02c9279e3249d"></a><!-- doxytag: member="Accessibility::Registry::deregisterGlobalEventListener" ref="cd2cfbec1123952216e02c9279e3249d" args="(in EventListener listener, in string eventName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Registry::deregisterGlobalEventListener </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> </td>
<td class="paramname"> <em>listener</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"> <em>eventName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
deregisterGlobalEventListener: <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>listener,:</em> </td><td>the requesting <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eventName,:</em> </td><td>a string indicating the type of events</td></tr>
</table>
</dl>
Request that a previously registered client stop receiving global notifications for events of a certain type.
</div>
</div><p>
<a class="anchor" name="e925f551f0c609d4a901241d5b0becf1"></a><!-- doxytag: member="Accessibility::Registry::getDesktopCount" ref="e925f551f0c609d4a901241d5b0becf1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short Accessibility::Registry::getDesktopCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getDesktopCount:<p>
Get the current number of desktops. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a short integer indicating the current number of Desktops. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b3ca4fb097932eda3d8118e4fab10144"></a><!-- doxytag: member="Accessibility::Registry::getDesktop" ref="b3ca4fb097932eda3d8118e4fab10144" args="(in short n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Desktop.html">Desktop</a> Accessibility::Registry::getDesktop </td>
<td>(</td>
<td class="paramtype">in short </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getDesktop: <br>
: the index of the requested <a class="el" href="interfaceAccessibility_1_1Desktop.html">Desktop</a>.<p>
Get the nth accessible desktop.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a reference to the requested <a class="el" href="interfaceAccessibility_1_1Desktop.html">Desktop</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d6f1a185f262ba3606da9f4f2311806d"></a><!-- doxytag: member="Accessibility::Registry::getDesktopList" ref="d6f1a185f262ba3606da9f4f2311806d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#21062610dc08191c6e6fc7618bb30020">DesktopSeq</a> Accessibility::Registry::getDesktopList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a list of accessible desktops.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: a sequence containing references to the Desktops. </dd></dl>
</div>
</div><p>
<a class="anchor" name="777e056ae1557558392da432fd5fc210"></a><!-- doxytag: member="Accessibility::Registry::getDeviceEventController" ref="777e056ae1557558392da432fd5fc210" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html">DeviceEventController</a> Accessibility::Registry::getDeviceEventController </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Obtain an object which can be used to request device event notifications.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: an object implementing <a class="el" href="interfaceAccessibility_1_1DeviceEventController.html">DeviceEventController</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this interface was generated from the following file:<ul>
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Registry_8idl-source.html">Accessibility_Registry.idl</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jul 10 10:46:52 2007 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
