<!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::Action 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_1Action.html">Action</a></div>
<h1>Accessibility::Action Interface Reference</h1><!-- doxytag: class="Accessibility::Action" --><code>import "<a class="el" href="Accessibility__Action_8idl-source.html">Accessibility_Action.idl</a>";</code>
<p>
<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">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Action.html#5279b2a8f3812be143673d1a17efb73c">getDescription</a> (in long index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Action.html#28f6bff38431495430f7026a0e702c36">getName</a> (in long index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Action.html#22755a6c2a4c5fda386ca5597ab872d8">doAction</a> (in long index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Action.html#8a1e3c76c0cfbe52e9e90c4baf9a1eeb">getKeyBinding</a> (in long index)</td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Action.html#a5335017e058fc9d296622bf185f7b7d">nActions</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An interface through which a user-actionable user interface component can be manipulated. Components which react to mouse or keyboard input from the user, (with the exception of pure text entry fields with no other function), should implement this interface. Typical actions include "click", "press", "release" (for instance for buttons), "menu" (for objects which have context menus invokable from mouse or keyboard), "open" for icons representing files folders, and others.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5279b2a8f3812be143673d1a17efb73c"></a><!-- doxytag: member="Accessibility::Action::getDescription" ref="5279b2a8f3812be143673d1a17efb73c" args="(in long index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Action::getDescription </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getDescription: <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index,:</em> </td><td>the index of the action for which a description is desired.</td></tr>
</table>
</dl>
Get the description of the specified action. The description of an action may provide information about the result of action invocation, unlike the action name. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Action.html#28f6bff38431495430f7026a0e702c36">getName</a>.</dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: a <code>string</code> containing the description of the specified action. </dd></dl>
</div>
</div><p>
<a class="anchor" name="28f6bff38431495430f7026a0e702c36"></a><!-- doxytag: member="Accessibility::Action::getName" ref="28f6bff38431495430f7026a0e702c36" args="(in long index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Action::getName </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getName: <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index,:</em> </td><td>the index of the action whose name is requested.</td></tr>
</table>
</dl>
Get the name of the specified action. <a class="el" href="interfaceAccessibility_1_1Action.html">Action</a> names generally describe the user action, i.e. "click" or "press", rather then the result of invoking the action.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: a <code>string</code> containing the name of the specified action. </dd></dl>
</div>
</div><p>
<a class="anchor" name="22755a6c2a4c5fda386ca5597ab872d8"></a><!-- doxytag: member="Accessibility::Action::doAction" ref="22755a6c2a4c5fda386ca5597ab872d8" args="(in long index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Action::doAction </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
doAction: <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index,:</em> </td><td>the 0-based index of the action to perform.</td></tr>
</table>
</dl>
Causes the object to perform the specified action.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: a <code>boolean</code> indicating success or failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8a1e3c76c0cfbe52e9e90c4baf9a1eeb"></a><!-- doxytag: member="Accessibility::Action::getKeyBinding" ref="8a1e3c76c0cfbe52e9e90c4baf9a1eeb" args="(in long index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Action::getKeyBinding </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getKeyBinding: <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index,:</em> </td><td>the 0-based index of the action for which a key binding is requested.</td></tr>
</table>
</dl>
Get the key binding associated with a specific action.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: a <code>string</code> containing the key binding for the specified action, or an empty string ("") if none exists. </dd></dl>
</div>
</div><p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="a5335017e058fc9d296622bf185f7b7d"></a><!-- doxytag: member="Accessibility::Action::nActions" ref="a5335017e058fc9d296622bf185f7b7d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Action.html#a5335017e058fc9d296622bf185f7b7d">Accessibility::Action::nActions</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
nActions: a <code>long</code> containing the number of actions this object supports.
</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__Action_8idl-source.html">Accessibility_Action.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>
