<!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::Selector 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_1Selector.html">Accessibility::Selector</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>Accessibility::Selector Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::Selector" -->
<p><code>import "<a class="el" href="Accessibility__Selector_8idl_source.html">Accessibility_Selector.idl</a>";</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49">CommandResult</a> { <br/>
<a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49ae5856c586280e1d7c79ef6b8d99b7872">COMMAND_RESULT_INVALID</a>,
<a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49ae3d406ff8323526a8bba7436429b93e5">COMMAND_RESULT_SUCCESS</a>,
<a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49a94b038068a8eb80398491d479fdf47bb">COMMAND_RESULT_FAILED</a>,
<a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49afa1ef1d86592c92493ad4ab9b0ff8d1c">COMMAND_RESULT_OBSOLETE</a>,
<br/>
<a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49afa45c01aa32275dbbd46d653724029a7">COMMAND_RESULT_LAST_DEFINED</a>
<br/>
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#ac59e321ac7d03c2afb2078ff2f31eaf9">getCommands</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#adf3e4936a8211e5ab9816e07e00650ee">replaceCommands</a> (in <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> commands)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#a629ab50cb5a2c5d6abae930c3cd634bc">refreshCommands</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49">CommandResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#a062f6b93946522a16b6ef2135cf3fa50">activateCommand</a> (in <a class="el" href="structAccessibility_1_1Command.html">Command</a> cmd)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#aedd5e55beedb3e5198c292c636c0c870">registerChangeListener</a> (in <a class="el" href="interfaceAccessibility_1_1CommandListener.html">CommandListener</a> listener)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#ab3d07422b09acff42da76d2744703fc6">deregisterChangeListener</a> (in <a class="el" href="interfaceAccessibility_1_1CommandListener.html">CommandListener</a> listener)</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 boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#af10e1447c0f55fb4f864af55cba5b526">supportsReplace</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This interface is intended for use by assistive technologies and related user-agents. Via this interface, an assistive technology or user agent may expose a series of choices or selections in textual form, which can be activated on demand by a client of the <a class="el" href="interfaceAccessibility_1_1Selector.html">Selector</a> interface.</p>
<p>Examples of the use of this interface include voice-command and remote-control applications, in which the user interaction is wholly or partly delegated by the implementor to an external agent. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>AT-SPI 1.7.0 </dd></dl>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a726e0ec495817a2c86f08ee100ff0a49"></a><!-- doxytag: member="Accessibility::Selector::CommandResult" ref="a726e0ec495817a2c86f08ee100ff0a49" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49">Accessibility::Selector::CommandResult</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A code returned by a call to activateCommand, indicating the result of the activation request. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a726e0ec495817a2c86f08ee100ff0a49ae5856c586280e1d7c79ef6b8d99b7872"></a><!-- doxytag: member="COMMAND_RESULT_INVALID" ref="a726e0ec495817a2c86f08ee100ff0a49ae5856c586280e1d7c79ef6b8d99b7872" args="" -->COMMAND_RESULT_INVALID</em> </td><td>
<p>The command was invalid or ill-formed; usually indicates an error condition. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a726e0ec495817a2c86f08ee100ff0a49ae3d406ff8323526a8bba7436429b93e5"></a><!-- doxytag: member="COMMAND_RESULT_SUCCESS" ref="a726e0ec495817a2c86f08ee100ff0a49ae3d406ff8323526a8bba7436429b93e5" args="" -->COMMAND_RESULT_SUCCESS</em> </td><td>
<p>The command was successfully activated. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a726e0ec495817a2c86f08ee100ff0a49a94b038068a8eb80398491d479fdf47bb"></a><!-- doxytag: member="COMMAND_RESULT_FAILED" ref="a726e0ec495817a2c86f08ee100ff0a49a94b038068a8eb80398491d479fdf47bb" args="" -->COMMAND_RESULT_FAILED</em> </td><td>
<p>The command was valid, but could not be activated. This may be due to problems with permissions or error conditions. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a726e0ec495817a2c86f08ee100ff0a49afa1ef1d86592c92493ad4ab9b0ff8d1c"></a><!-- doxytag: member="COMMAND_RESULT_OBSOLETE" ref="a726e0ec495817a2c86f08ee100ff0a49afa1ef1d86592c92493ad4ab9b0ff8d1c" args="" -->COMMAND_RESULT_OBSOLETE</em> </td><td>
<p>The command is no longer valid in the current program context. This may mean that the application has changed state in such a way that the specified command it no longer applicable, or because changes to the application state have rendered it ambiguous. Commands should be re-fetched and a new selection made. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a726e0ec495817a2c86f08ee100ff0a49afa45c01aa32275dbbd46d653724029a7"></a><!-- doxytag: member="COMMAND_RESULT_LAST_DEFINED" ref="a726e0ec495817a2c86f08ee100ff0a49afa45c01aa32275dbbd46d653724029a7" args="" -->COMMAND_RESULT_LAST_DEFINED</em> </td><td>
<p>Defines size of enumeration; do not use this value as a parameter. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a062f6b93946522a16b6ef2135cf3fa50"></a><!-- doxytag: member="Accessibility::Selector::activateCommand" ref="a062f6b93946522a16b6ef2135cf3fa50" args="(in Command cmd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Selector.html#a726e0ec495817a2c86f08ee100ff0a49">CommandResult</a> Accessibility::Selector::activateCommand </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structAccessibility_1_1Command.html">Command</a> </td>
<td class="paramname"> <em>cmd</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request that the Selector invoke the specified Command. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cmd</em> </td><td>the Command to activate/invoke. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a CommandResult indicating whether the request was honored, and the reason for failure if the Command could not be activated or invoked. </dd></dl>
</div>
</div>
<a class="anchor" id="ab3d07422b09acff42da76d2744703fc6"></a><!-- doxytag: member="Accessibility::Selector::deregisterChangeListener" ref="ab3d07422b09acff42da76d2744703fc6" args="(in CommandListener listener)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Selector::deregisterChangeListener </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1CommandListener.html">CommandListener</a> </td>
<td class="paramname"> <em>listener</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell the Selector instance to cease notifying the specified CommandListener of changes to the command list. </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>the CommandListener to remove from the notification list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac59e321ac7d03c2afb2078ff2f31eaf9"></a><!-- doxytag: member="Accessibility::Selector::getCommands" ref="ac59e321ac7d03c2afb2078ff2f31eaf9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> Accessibility::Selector::getCommands </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query the Selector for the current <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the currently available <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a629ab50cb5a2c5d6abae930c3cd634bc"></a><!-- doxytag: member="Accessibility::Selector::refreshCommands" ref="a629ab50cb5a2c5d6abae930c3cd634bc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Selector::refreshCommands </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Ask the Selector to re-calculate its <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a>. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>in most cases the Selector will continuously update its <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> without recourse to this call. This call is equivalent to getCommands, except that after refreshCommands the new <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> will be returned via any registered CommandListener instances rather than synchronously via this call.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if the <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> changed. </dd></dl>
</div>
</div>
<a class="anchor" id="aedd5e55beedb3e5198c292c636c0c870"></a><!-- doxytag: member="Accessibility::Selector::registerChangeListener" ref="aedd5e55beedb3e5198c292c636c0c870" args="(in CommandListener listener)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Selector::registerChangeListener </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1CommandListener.html">CommandListener</a> </td>
<td class="paramname"> <em>listener</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register a :<a class="el" href="interfaceAccessibility_1_1CommandListener.html">CommandListener</a> instance for notification of changes to the command set. </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>the CommandListener to be notified of changes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adf3e4936a8211e5ab9816e07e00650ee"></a><!-- doxytag: member="Accessibility::Selector::replaceCommands" ref="adf3e4936a8211e5ab9816e07e00650ee" args="(in CommandList commands)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Selector::replaceCommands </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> </td>
<td class="paramname"> <em>commands</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if the replacement request was successful, FALSE if the request could not be honored. </dd></dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="af10e1447c0f55fb4f864af55cba5b526"></a><!-- doxytag: member="Accessibility::Selector::supportsReplace" ref="af10e1447c0f55fb4f864af55cba5b526" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute boolean <a class="el" href="interfaceAccessibility_1_1Selector.html#af10e1447c0f55fb4f864af55cba5b526">Accessibility::Selector::supportsReplace</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This attribute is TRUE if this <a class="el" href="interfaceAccessibility_1_1Selector.html">Selector</a> allows its <a class="el" href="namespaceAccessibility.html#a5932efe886c29ac49ec12d7fdb0eca87">CommandList</a> to be specified by the client </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__Selector_8idl_source.html">Accessibility_Selector.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>
