ooodev.adapter.awt.key_handler module

class ooodev.adapter.awt.key_handler.KeyHandler(trigger_args=None, subscriber=None)[source]

Bases: AdapterBase, XKeyHandler

This key handler is similar to com.sun.star.awt.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

See also

API XKeyHandler

Parameters:

  • args (Any) –

  • kwargs (Any) –

Return type:

Any

__init__(trigger_args=None, subscriber=None)[source]

Constructor:

Parameters:

  • trigger_args (GenericArgs, optional) – Args that are passed to events when they are triggered.

  • subscriber (XUserInputInterception, optional) – An UNO object that implements the XUserInputInterception interface. If passed in then this listener instance is automatically added to it.

Return type:

None

disposing(event)[source]

Gets called when the broadcaster is about to be disposed.

All listeners and all other objects, which reference the broadcaster should release the reference to the source. No method should be invoked anymore on this object ( including XComponent.removeEventListener() ).

This method is called for every listener registration of derived listener interfaced, not only for registrations at XComponent.

Return type:

None

Parameters:

event (com.sun.star.lang.EventObject) –

keyPressed(event)[source]

is invoked when a key has been pressed.

Return type:

None

Parameters:

event (com.sun.star.awt.KeyEvent) –

keyReleased(event)[source]

is invoked when a key has been released.

Return type:

None

Parameters:

event (com.sun.star.awt.KeyEvent) –