<!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::Selector 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_1Selector.html">Selector</a></div>
<h1>Accessibility::Selector Interface Reference</h1><!-- doxytag: class="Accessibility::Selector" --><code>import "<a class="el" href="Accessibility__Selector_8idl-source.html">Accessibility_Selector.idl</a>";</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#6b35253465e23c3139fb646424b761dc">CommandResult</a> { <br>
<a class="el" href="interfaceAccessibility_1_1Selector.html#6b35253465e23c3139fb646424b761dc3abc7b2591c7d29e21a9918b0dbfd544">COMMAND_RESULT_INVALID</a>,
<a class="el" href="interfaceAccessibility_1_1Selector.html#6b35253465e23c3139fb646424b761dc6bb9d2ee757a7f510072481fd8d50ef9">COMMAND_RESULT_SUCCESS</a>,
<a class="el" href="interfaceAccessibility_1_1Selector.html#6b35253465e23c3139fb646424b761dcebb42e0f82f6e19b4c49b4a9554313cf">COMMAND_RESULT_FAILED</a>,
<a class="el" href="interfaceAccessibility_1_1Selector.html#6b35253465e23c3139fb646424b761dc542cdabe50b6c8ba787ce0837ccaf455">COMMAND_RESULT_OBSOLETE</a>,
<br>
<a class="el" href="interfaceAccessibility_1_1Selector.html#6b35253465e23c3139fb646424b761dc2e3462d9dd0ff7f36d81133c284096db">COMMAND_RESULT_LAST_DEFINED</a>
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceAccessibility.html#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#34c3eeca97f46f5e27ec360fab5fb85a">getCommands</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_1Selector.html#61a9fa9d6e3cbcbacd5a5969f9943df3">replaceCommands</a> (in <a class="el" href="namespaceAccessibility.html#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a> commands)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#0a75587c55693b9cca0a505d7febbf9e">refreshCommands</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Selector.html#6b35253465e23c3139fb646424b761dc">CommandResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#b3a532417b5da542b14c9a88e73afb60">activateCommand</a> (in <a class="el" href="structAccessibility_1_1Command.html">Command</a> cmd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#237c68189e7831fe24f9b1ab9e8441ab">registerChangeListener</a> (in <a class="el" href="interfaceAccessibility_1_1CommandListener.html">CommandListener</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_1Selector.html#937f3c6ae12d5b5520240387e33b8586">deregisterChangeListener</a> (in <a class="el" href="interfaceAccessibility_1_1CommandListener.html">CommandListener</a> listener)</td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selector.html#c0566476fa3214e41dd58195c8a54a18">supportsReplace</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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>
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. <dl class="since" compact><dt><b>Since:</b></dt><dd>AT-SPI 1.7.0 </dd></dl>
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="6b35253465e23c3139fb646424b761dc"></a><!-- doxytag: member="Accessibility::Selector::CommandResult" ref="6b35253465e23c3139fb646424b761dc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceAccessibility_1_1Selector.html#6b35253465e23c3139fb646424b761dc">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. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="6b35253465e23c3139fb646424b761dc3abc7b2591c7d29e21a9918b0dbfd544"></a><!-- doxytag: member="COMMAND_RESULT_INVALID" ref="6b35253465e23c3139fb646424b761dc3abc7b2591c7d29e21a9918b0dbfd544" args="" -->COMMAND_RESULT_INVALID</em> </td><td>
The command was invalid or ill-formed; usually indicates an error condition. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="6b35253465e23c3139fb646424b761dc6bb9d2ee757a7f510072481fd8d50ef9"></a><!-- doxytag: member="COMMAND_RESULT_SUCCESS" ref="6b35253465e23c3139fb646424b761dc6bb9d2ee757a7f510072481fd8d50ef9" args="" -->COMMAND_RESULT_SUCCESS</em> </td><td>
The command was successfully activated. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="6b35253465e23c3139fb646424b761dcebb42e0f82f6e19b4c49b4a9554313cf"></a><!-- doxytag: member="COMMAND_RESULT_FAILED" ref="6b35253465e23c3139fb646424b761dcebb42e0f82f6e19b4c49b4a9554313cf" args="" -->COMMAND_RESULT_FAILED</em> </td><td>
The command was valid, but could not be activated. This may be due to problems with permissions or error conditions. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="6b35253465e23c3139fb646424b761dc542cdabe50b6c8ba787ce0837ccaf455"></a><!-- doxytag: member="COMMAND_RESULT_OBSOLETE" ref="6b35253465e23c3139fb646424b761dc542cdabe50b6c8ba787ce0837ccaf455" args="" -->COMMAND_RESULT_OBSOLETE</em> </td><td>
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. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="6b35253465e23c3139fb646424b761dc2e3462d9dd0ff7f36d81133c284096db"></a><!-- doxytag: member="COMMAND_RESULT_LAST_DEFINED" ref="6b35253465e23c3139fb646424b761dc2e3462d9dd0ff7f36d81133c284096db" args="" -->COMMAND_RESULT_LAST_DEFINED</em> </td><td>
Defines size of enumeration; do not use this value as a parameter. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="34c3eeca97f46f5e27ec360fab5fb85a"></a><!-- doxytag: member="Accessibility::Selector::getCommands" ref="34c3eeca97f46f5e27ec360fab5fb85a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a> Accessibility::Selector::getCommands </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the Selector for the current <a class="el" href="namespaceAccessibility.html#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the currently available <a class="el" href="namespaceAccessibility.html#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="61a9fa9d6e3cbcbacd5a5969f9943df3"></a><!-- doxytag: member="Accessibility::Selector::replaceCommands" ref="61a9fa9d6e3cbcbacd5a5969f9943df3" 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#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a> </td>
<td class="paramname"> <em>commands</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><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><p>
<a class="anchor" name="0a75587c55693b9cca0a505d7febbf9e"></a><!-- doxytag: member="Accessibility::Selector::refreshCommands" ref="0a75587c55693b9cca0a505d7febbf9e" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ask the Selector to re-calculate its <a class="el" href="namespaceAccessibility.html#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a>. <dl class="note" compact><dt><b>Note:</b></dt><dd>in most cases the Selector will continuously update its <a class="el" href="namespaceAccessibility.html#4e9edd7b46e391ce3bbd56807d4aea1f">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#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a> will be returned via any registered CommandListener instances rather than synchronously via this call.</dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if the <a class="el" href="namespaceAccessibility.html#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a> changed. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b3a532417b5da542b14c9a88e73afb60"></a><!-- doxytag: member="Accessibility::Selector::activateCommand" ref="b3a532417b5da542b14c9a88e73afb60" 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#6b35253465e23c3139fb646424b761dc">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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Request that the Selector invoke the specified Command. <dl compact><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>
</dl>
<dl class="return" compact><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><p>
<a class="anchor" name="237c68189e7831fe24f9b1ab9e8441ab"></a><!-- doxytag: member="Accessibility::Selector::registerChangeListener" ref="237c68189e7831fe24f9b1ab9e8441ab" 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 width="100%"></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. <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 CommandListener to be notified of changes. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="937f3c6ae12d5b5520240387e33b8586"></a><!-- doxytag: member="Accessibility::Selector::deregisterChangeListener" ref="937f3c6ae12d5b5520240387e33b8586" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tell the Selector instance to cease notifying the specified CommandListener of changes to the command list. <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 CommandListener to remove from the notification list. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="c0566476fa3214e41dd58195c8a54a18"></a><!-- doxytag: member="Accessibility::Selector::supportsReplace" ref="c0566476fa3214e41dd58195c8a54a18" 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#c0566476fa3214e41dd58195c8a54a18">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#4e9edd7b46e391ce3bbd56807d4aea1f">CommandList</a> to be specified by the client
</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__Selector_8idl-source.html">Accessibility_Selector.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>
