The Free and Open Productivity Suite
QA Volunteers Needed -- Help us test OpenOffice

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for Apache OpenOffice version 3.4.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XUserInputInterception
Description
Interface to add handlers for key and mouse events. A handler is not a passive listener, it can even consume the event.
Since
OOo 1.1.2
Methods' Summary
addKeyHandler Add a new listener that is called on KeyEvents. Every listener is given the opportunity to consume the event, i.e. prevent the not yet called listeners from being called.  
removeKeyHandler Remove the specified listener from the list of listeners.  
addMouseClickHandler Add a new listener that is called on MouseEvents. Every listener is given the opportunity to consume the event, i.e. prevent the not yet called listeners from being called.  
removeMouseClickHandler Remove the specified listener from the list of listeners.  
Methods' Details
addKeyHandler
[oneway] void
addKeyHandler( [in] XKeyHandler  xHandler );
Description
Add a new listener that is called on KeyEvents. Every listener is given the opportunity to consume the event, i.e. prevent the not yet called listeners from being called.
Parameter xHandler
If this is a valid reference it is inserted into the list of handlers. It is the task of the caller to not register the same handler twice (otherwise that listener will be called twice.)
removeKeyHandler
[oneway] void
removeKeyHandler( [in] XKeyHandler  xHandler );
Description
Remove the specified listener from the list of listeners.
Parameter xHandler
If the reference is empty then nothing will be changed. If the handler has been registered twice (or more) then all refrences will be removed.
addMouseClickHandler
[oneway] void
addMouseClickHandler( [in] XMouseClickHandler  xHandler );
Description
Add a new listener that is called on MouseEvents. Every listener is given the opportunity to consume the event, i.e. prevent the not yet called listeners from being called.
Parameter xHandler
If this is a valid reference it is inserted into the list of handlers. It is the task of the caller to not register the same handler twice (otherwise that listener will be called twice.)
removeMouseClickHandler
[oneway] void
removeMouseClickHandler( [in] XMouseClickHandler  xHandler );
Description
Remove the specified listener from the list of listeners.
Parameter xHandler
If the reference is empty then nothing will be changed. If the handler has been registered twice (or more) then all refrences will be removed.
Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Feather

Copyright & License | Privacy | Contact Us | Donate

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. 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.