Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: awt ::

interface XKeyHandler
Base Interfaces
XKeyHandler
┗ ::com::sun::star::lang::XEventListener

::com::sun::star::lang::XEventListener
(referenced interface's summary:)
base interface for all event listeners interfaces.
Description
This key handler is similar to XKeyListener 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.
Since
OOo 1.1.2

Methods' Summary
keyPressed This function is called by the broadcaster, an XExtendedToolkit 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.  
keyReleased This function is called by the broadcaster, an XExtendedToolkit 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.  
Methods' Details
keyPressed
boolean
keyPressed( [in] KeyEvent  aEvent );

Description
This function is called by the broadcaster, an XExtendedToolkit 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.

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.

Consuming this event does not prevent the pending key-release event from beeing broadcasted.

Parameter aEvent
The key event informs about the pressed key.
Returns
When false is returned the other handlers are called and a following handling of the event by the broadcaster takes place. Otherwise, when true is returned, no other handler will be called and the broadcaster will take no further actions regarding the event.
keyReleased
boolean
keyReleased( [in] KeyEvent  aEvent );

Description
This function is called by the broadcaster, an XExtendedToolkit 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.

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.

Parameter aEvent
The key event informs about the pressed key.
Returns
When false is returned the other handlers are called and a following handling of the event by the broadcaster takes place. Otherwise, when true is returned, no other handler will be called and the broadcaster will take no further actions regarding the event.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.