<html> <head> <title>Interface XAccessibleKeyBinding</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="XAccessibleKeyBinding-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleKeyBinding" 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 XAccessibleKeyBinding</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interface can be used to represent any number of key bindings which then can be associated to a certain action. </dd> <dd><p>There can be zero, one, or more key bindings. Each key binding consists of a sequence of ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/KeyStroke.html">KeyStroke</a> objects. The association of an action with a key binding is established by the <a href="XAccessibleAction.html">XAccessibleAction</a> interface returning an <a href="XAccessibleKeyBinding.html">XAccessibleKeyBinding</a> object.</p> <p>A key binding describes alternative ways how to invoke an action with pressing one or more keys after each other. Each individual sequence of key strokes </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/XAccessibleKeyBinding">Accessibility - XAccessibleKeyBinding</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="#getAccessibleKeyBindingCount">getAccessibleKeyBindingCount</a></td> <td class="imsum_right">Return the number of available key bindings. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleKeyBinding">getAccessibleKeyBinding</a></td> <td class="imsum_right">The returned sequence of key strokes describes one method to invoke the associated action (the one from which you obtained the object at which you called this method) by pressing keys. The keys specified by each of the returned key strokes have to be pressed at the same time (the Control-key and the A-key for example). The keys of one key stroke have to be released before pressing those of the next. The order of the key strokes in the sequence define the order in which to press them. </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="getAccessibleKeyBindingCount" class="membertitle">getAccessibleKeyBindingCount</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>getAccessibleKeyBindingCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the number of available key bindings. </dd> <dt><b>Returns</b></dt> <dd>The returned value may be 0 to indicate that there are no key bindings or the positive number of the available key bindings. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleKeyBinding" class="membertitle">getAccessibleKeyBinding</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">sequence< ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/KeyStroke.html">KeyStroke</a> ></td> </tr> <tr> <td valign="top"><b>getAccessibleKeyBinding</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>The returned sequence of key strokes describes one method to invoke the associated action (the one from which you obtained the object at which you called this method) by pressing keys. The keys specified by each of the returned key strokes have to be pressed at the same time (the Control-key and the A-key for example). The keys of one key stroke have to be released before pressing those of the next. The order of the key strokes in the sequence define the order in which to press them. </dd> <dt><b>Parameter nIndex</b></dt> <dd>The index selects one of alternative key bindings. It has to non-negative and smaller then the number of key bindings as returned by the <a href="#geetAccessibleKeyBindingCount()">geetAccessibleKeyBindingCount()</a> method. </dd> <dt><b>Returns</b></dt> <dd>The returned sequence of key strokes specifies one way to invoke the associated action. The sequence may be empty (but should not be; better not to return such a key binding at all). </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the 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 © 2009 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>