<!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::Application 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_1Application.html">Application</a></div>
<h1>Accessibility::Application Interface Reference</h1><!-- doxytag: class="Accessibility::Application" --><!-- doxytag: inherits="Accessibility::Accessible" --><code>import "<a class="el" href="Accessibility__Application_8idl-source.html">Accessibility_Application.idl</a>";</code>
<p>
<p>Inheritance diagram for Accessibility::Application:
<p><center><img src="interfaceAccessibility_1_1Application.png" usemap="#Accessibility::Application_map" border="0" alt=""></center>
<map name="Accessibility::Application_map">
<area href="interfaceAccessibility_1_1Accessible.html" alt="Accessibility::Accessible" shape="rect" coords="0,0,152,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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#a7061abbe51fd73e55ff0ef82aa5b6d9">registerToolkitEventListener</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_1Application.html#2a6d841c8a26cd0a5e2f0a69b3536d82">registerObjectEventListener</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">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#a1640ca7e53f8a562f5eb783e972713b">pause</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#9a06b7cd58dd28f929aee5f439346076">resume</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#d120b2aa423221a44ffd49dbd513c29a">getLocale</a> (in <a class="el" href="namespaceAccessibility.html#964d269667b76899b9196886b517a23e">LOCALE_TYPE</a> lctype)</td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#3e06a4aedb90e5523d483b89dc273695">toolkitName</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#a150837a62a285c943fe0a86363f884f">version</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#173620735281c3124e2350bd0d12c88e">id</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An interface identifying an object which is the root of the user interface <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> hierarchy associated with a running application. Children of <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a> are typically, but not exclusively, top-level windows. <dl class="note" compact><dt><b>Note:</b></dt><dd>It is possible for an element deeper in an <a class="el" href="namespaceAccessibility.html">Accessibility</a> stack to implement <a class="el" href="interfaceAccessibility_1_1Application.html">Application</a>, for instance in the case of "embedded applications" which draw into toplevel windows associated with other applications from the user's point of view. </dd></dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a7061abbe51fd73e55ff0ef82aa5b6d9"></a><!-- doxytag: member="Accessibility::Application::registerToolkitEventListener" ref="a7061abbe51fd73e55ff0ef82aa5b6d9" args="(in EventListener listener, in string eventName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Application::registerToolkitEventListener </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>
<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>an EventListener object which will receive the requested events from the application's toolkits via toolit 'bridges' </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eventName,:</em> </td><td>a UTF-8 string indicating the type of (toolkit-specific) event being requested. Not all applications can generate toolkit events of a given type.</td></tr>
</table>
</dl>
Register with this application's toolkit for "toolkit-specific" event notifications. <dl class="note" compact><dt><b>Note:</b></dt><dd>For most event support, clients should use non-toolkit-specific events whenever possible, via Registry::registerGlobalEventListener - this method is provided as a 'back door' when generic names do not exist for the events in question. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2a6d841c8a26cd0a5e2f0a69b3536d82"></a><!-- doxytag: member="Accessibility::Application::registerObjectEventListener" ref="2a6d841c8a26cd0a5e2f0a69b3536d82" args="(in EventListener listener, in string eventName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Application::registerObjectEventListener </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>
registerObjectEventListener: <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>an EventListener object which will receive the requested events </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eventName,:</em> </td><td>a UTF-8 string indicating the type of (toolkit-specific) event being requested. Register with this application toolkit for "Accessibility::Accessible" event notifications. </td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>: SUBJECT TO DEPRECATION. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a1640ca7e53f8a562f5eb783e972713b"></a><!-- doxytag: member="Accessibility::Application::pause" ref="a1640ca7e53f8a562f5eb783e972713b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Application::pause </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Request that the application temporarily stop sending events. In most cases this should pause the application's main event loop.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: <code>true</code> if the request succeeded, <code>false</code> otherwise.</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>: This method is not implemented in most toolkits, and therefore should be treated with caution. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9a06b7cd58dd28f929aee5f439346076"></a><!-- doxytag: member="Accessibility::Application::resume" ref="9a06b7cd58dd28f929aee5f439346076" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Application::resume </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Request that the application resume sending events.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: <code>True</code> if the request succeeded, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d120b2aa423221a44ffd49dbd513c29a"></a><!-- doxytag: member="Accessibility::Application::getLocale" ref="d120b2aa423221a44ffd49dbd513c29a" args="(in LOCALE_TYPE lctype)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Application::getLocale </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#964d269667b76899b9196886b517a23e">LOCALE_TYPE</a> </td>
<td class="paramname"> <em>lctype</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the locale in which the application is currently operating. For the current message locale, use <em>lctype</em> LOCALE_TYPE_MESSAGES.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>lctype</em> </td><td>The LocaleType for which the locale is queried. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a string compliant with the POSIX standard for locale description. </dd></dl>
</div>
</div><p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="3e06a4aedb90e5523d483b89dc273695"></a><!-- doxytag: member="Accessibility::Application::toolkitName" ref="3e06a4aedb90e5523d483b89dc273695" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute string <a class="el" href="interfaceAccessibility_1_1Application.html#3e06a4aedb90e5523d483b89dc273695">Accessibility::Application::toolkitName</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A string indicating the type of user interface toolkit which is used by the application. <dl class="note" compact><dt><b>Note:</b></dt><dd>Ordinarily clients of Application should be toolkit-agnostic, dependencies on this property should be avoided where possible. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a150837a62a285c943fe0a86363f884f"></a><!-- doxytag: member="Accessibility::Application::version" ref="a150837a62a285c943fe0a86363f884f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute string <a class="el" href="interfaceAccessibility_1_1Application.html#a150837a62a285c943fe0a86363f884f">Accessibility::Application::version</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A string indicating the version number of the application's accessibility bridge implementation.
</div>
</div><p>
<a class="anchor" name="173620735281c3124e2350bd0d12c88e"></a><!-- doxytag: member="Accessibility::Application::id" ref="173620735281c3124e2350bd0d12c88e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">attribute long <a class="el" href="interfaceAccessibility_1_1Application.html#173620735281c3124e2350bd0d12c88e">Accessibility::Application::id</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The application instance's unique ID as assigned by the registry.
</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__Application_8idl-source.html">Accessibility_Application.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>
