<html> <head> <title>Interface XKeyHandler</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="XKeyHandler-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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">awt</a> :: </p> </td> </tr> <tr> <td class="title">interface XKeyHandler</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XKeyHandler</strong> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>base interface for all event listeners interfaces. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This key handler is similar to <a href="XKeyListener.html">XKeyListener</a> but allows the consumption of key events. If a key event is consumed by one handler both the following handlers, with respect to the list of key handlers of the broadcaster, and a following handling by the broadcaster will not take place. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</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="#keyPressed">keyPressed</a></td> <td class="imsum_right">This function is called by the broadcaster, an <a href="XExtendedToolkit.html">XExtendedToolkit</a> for instance, after a key has been pressed but before it is released. The return value decides about whether other handlers will be called and a handling by the broadcaster will take place. </td> </tr> <tr> <td class="imsum_left"><a href="#keyReleased">keyReleased</a></td> <td class="imsum_right">This function is called by the broadcaster, an <a href="XExtendedToolkit.html">XExtendedToolkit</a> for instance, after a key has been pressed and released. The return value decides about whether other handlers will be called and a handling by the broadcaster will take place. </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="keyPressed" class="membertitle">keyPressed</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>keyPressed</b>(</td> <td valign="top">[in] <a href="KeyEvent.html">KeyEvent</a></td> <td valign="bottom"> aEvent );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>This function is called by the broadcaster, an <a href="XExtendedToolkit.html">XExtendedToolkit</a> for instance, after a key has been pressed but before it is released. The return value decides about whether other handlers will be called and a handling by the broadcaster will take place. </dd> <dd><p>Consume the event if the action performed by the implementation is mutually exclusive with the default action of the broadcaster or, when known, with that of other handlers.</p> <p>Consuming this event does not prevent the pending key-release event from beeing broadcasted.</p> </dd> <dt><b>Parameter aEvent</b></dt> <dd>The key event informs about the pressed key. </dd> <dt><b>Returns</b></dt> <dd>When <b>false</b> is returned the other handlers are called and a following handling of the event by the broadcaster takes place. Otherwise, when <b>true</b> is returned, no other handler will be called and the broadcaster will take no further actions regarding the event. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="keyReleased" class="membertitle">keyReleased</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>keyReleased</b>(</td> <td valign="top">[in] <a href="KeyEvent.html">KeyEvent</a></td> <td valign="bottom"> aEvent );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>This function is called by the broadcaster, an <a href="XExtendedToolkit.html">XExtendedToolkit</a> for instance, after a key has been pressed and released. The return value decides about whether other handlers will be called and a handling by the broadcaster will take place. </dd> <dd><p>Consume the event if the action performed by the implementation is mutualy exclusive with the default action of the broadcaster or, when known, with that of other handlers.</p> </dd> <dt><b>Parameter aEvent</b></dt> <dd>The key event informs about the pressed key. </dd> <dt><b>Returns</b></dt> <dd>When <b>false</b> is returned the other handlers are called and a following handling of the event by the broadcaster takes place. Otherwise, when <b>true</b> is returned, no other handler will be called and the broadcaster will take no further actions regarding the event. </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>