<html> <head> <title>Interface XAccessibleAction</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XAccessibleAction-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleAction" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">accessibility</a> :: </p> </td> </tr> <tr> <td class="title">interface XAccessibleAction</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Implement this interface to give access to actions that can be executed for accessible objects. </dd> <dd><p>Every accessible object that can be manipulated beyond its methods exported over the accessibility API should support this interface to expose all actions that it can perform. Each action can be performed or be queried for a description or associated key bindings.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleAction">Accessibility - XAccessibleAction</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleActionCount">getAccessibleActionCount</a></td> <td class="imsum_right">Returns the number of accessible actions available in this object. </td> </tr> <tr> <td class="imsum_left"><a href="#doAccessibleAction">doAccessibleAction</a></td> <td class="imsum_right">Perform the specified Action on the object. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleActionDescription">getAccessibleActionDescription</a></td> <td class="imsum_right">Returns a description of the specified action of the object. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleActionKeyBinding">getAccessibleActionKeyBinding</a></td> <td class="imsum_right">Returns a key binding object, if there is one, associated with the specified action. Note that there can be several alternative key bindings for an action. See <a href="XAccessibleKeyBinding.html">XAccessibleKeyBinding</a> for more information about how key bindings are represented. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getAccessibleActionCount" class="membertitle">getAccessibleActionCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getAccessibleActionCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the number of accessible actions available in this object. </dd> <dd><p>If there are more than one, the first one is considered the "default" action of the object.</p> </dd> <dt><b>Returns</b></dt> <dd>The returned value of the number of actions is zero if there are no actions. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="doAccessibleAction" class="membertitle">doAccessibleAction</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>doAccessibleAction</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Perform the specified Action on the object. </dd> <dt><b>Parameter nIndex</b></dt> <dd>This index specifies the action to perform. If it lies outside the valid range <b>false</b> is returned and no action is performed. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> if the action was successfully performed. If the action could not be performed successfully <b>false</b> is returned. </dd> <dt><b>Throws</b></dt> <dd>IndexOutOfBoundsException If no action with the given index exists then an ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> exception is thrown. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleActionDescription" class="membertitle">getAccessibleActionDescription</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getAccessibleActionDescription</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns a description of the specified action of the object. </dd> <dt><b>Parameter nIndex</b></dt> <dd>This index specifies the action of which to return a description. If it lies outside the valid range an empty string is returned. </dd> <dt><b>Returns</b></dt> <dd>The returned value is a localized string of the specified action. </dd> <dt><b>Throws</b></dt> <dd>IndexOutOfBoundsException If the given index lies not in the valid range then an ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> exception is thrown. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleActionKeyBinding" class="membertitle">getAccessibleActionKeyBinding</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XAccessibleKeyBinding.html">XAccessibleKeyBinding</a></td> </tr> <tr> <td valign="top"><b>getAccessibleActionKeyBinding</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns a key binding object, if there is one, associated with the specified action. Note that there can be several alternative key bindings for an action. See <a href="XAccessibleKeyBinding.html">XAccessibleKeyBinding</a> for more information about how key bindings are represented. </dd> <dt><b>Parameter nIndex</b></dt> <dd>This index specifies the action of which to return the key binding. </dd> <dt><b>Returns</b></dt> <dd>The returned object describes a set of key bindings associated with the specified action. </dd> <dt><b>Throws</b></dt> <dd>IndexOutOfBoundsException if the given index is not valid. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
605
