<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::Application Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="tabs2">
<ul class="tablist">
<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="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1Application.html">Accessibility::Application</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>Accessibility::Application Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::Application" --><!-- doxytag: inherits="Accessibility::Accessible" -->
<p><code>import "<a class="el" href="Accessibility__Application_8idl_source.html">Accessibility_Application.idl</a>";</code></p>
<div class="dynheader">
Inheritance diagram for Accessibility::Application:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceAccessibility_1_1Application.png" usemap="#Accessibility::Application_map" alt=""/>
<map id="Accessibility::Application_map" name="Accessibility::Application_map">
<area href="interfaceAccessibility_1_1Accessible.html" alt="Accessibility::Accessible" shape="rect" coords="0,0,152,24"/>
</map>
</div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#a52636e795abe8268413a454cb78ee175">registerToolkitEventListener</a> (in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> listener, in string eventName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#aa1d325cc823754a17a11ec43c43f7e35">registerObjectEventListener</a> (in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> listener, in string eventName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#addb80eabe337d0ab5298ce6e9eb8df47">pause</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#ab2cbd12b5f16b389cdf10c46daea15f4">resume</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#ad8886b8066388cd8760357ce61995550">getLocale</a> (in <a class="el" href="namespaceAccessibility.html#ac761bb2da4048aebdd771c0d77edc2eb">LOCALE_TYPE</a> lctype)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#acb78c8d2878081bd2c57a275fe7818f7">toolkitName</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#a91e6ccdb0e38dca1bbf4742cc7424ffb">version</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Application.html#a28c7ec31e93f7f82b2a82a3afe1f711c">id</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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. </p>
<dl class="note"><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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad8886b8066388cd8760357ce61995550"></a><!-- doxytag: member="Accessibility::Application::getLocale" ref="ad8886b8066388cd8760357ce61995550" 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#ac761bb2da4048aebdd771c0d77edc2eb">LOCALE_TYPE</a> </td>
<td class="paramname"> <em>lctype</em></td>
<td> ) </td>
<td></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><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a string compliant with the POSIX standard for locale description. </dd></dl>
</div>
</div>
<a class="anchor" id="addb80eabe337d0ab5298ce6e9eb8df47"></a><!-- doxytag: member="Accessibility::Application::pause" ref="addb80eabe337d0ab5298ce6e9eb8df47" 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></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"><dt><b>Returns:</b></dt><dd>: <code>true</code> if the request succeeded, <code>false</code> otherwise.</dd></dl>
<dl class="note"><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>
<a class="anchor" id="aa1d325cc823754a17a11ec43c43f7e35"></a><!-- doxytag: member="Accessibility::Application::registerObjectEventListener" ref="aa1d325cc823754a17a11ec43c43f7e35" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>registerObjectEventListener: </p>
<dl><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>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>: SUBJECT TO DEPRECATION. </dd></dl>
</div>
</div>
<a class="anchor" id="a52636e795abe8268413a454cb78ee175"></a><!-- doxytag: member="Accessibility::Application::registerToolkitEventListener" ref="a52636e795abe8268413a454cb78ee175" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><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>
</dd>
</dl>
<p>Register with this application's toolkit for "toolkit-specific" event notifications. </p>
<dl class="note"><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>
<a class="anchor" id="ab2cbd12b5f16b389cdf10c46daea15f4"></a><!-- doxytag: member="Accessibility::Application::resume" ref="ab2cbd12b5f16b389cdf10c46daea15f4" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request that the application resume sending events.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>: <code>True</code> if the request succeeded, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a28c7ec31e93f7f82b2a82a3afe1f711c"></a><!-- doxytag: member="Accessibility::Application::id" ref="a28c7ec31e93f7f82b2a82a3afe1f711c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">attribute long <a class="el" href="interfaceAccessibility_1_1Application.html#a28c7ec31e93f7f82b2a82a3afe1f711c">Accessibility::Application::id</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The application instance's unique ID as assigned by the registry. </p>
</div>
</div>
<a class="anchor" id="acb78c8d2878081bd2c57a275fe7818f7"></a><!-- doxytag: member="Accessibility::Application::toolkitName" ref="acb78c8d2878081bd2c57a275fe7818f7" 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#acb78c8d2878081bd2c57a275fe7818f7">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. </p>
<dl class="note"><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>
<a class="anchor" id="a91e6ccdb0e38dca1bbf4742cc7424ffb"></a><!-- doxytag: member="Accessibility::Application::version" ref="a91e6ccdb0e38dca1bbf4742cc7424ffb" 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#a91e6ccdb0e38dca1bbf4742cc7424ffb">Accessibility::Application::version</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A string indicating the version number of user interface toolkit which is used by the application. </p>
</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
