ooodev.adapter.awt.extended_toolkit_partial module

class ooodev.adapter.awt.extended_toolkit_partial.ExtendedToolkitPartial(component, interface=com.sun.star.awt.XExtendedToolkit)

Bases: object

Partial class for XExtendedToolkit.

Parameters:

• component (XExtendedToolkit) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.awt.XExtendedToolkit)

Constructor

Parameters:

• component (XExtendedToolkit) – UNO Component that implements com.sun.star.awt.XExtendedToolkit interface.

• interface (UnoInterface, optional) – The interface to be validated. Defaults to XExtendedToolkit.

Return type:

None

add_focus_listener(listener)

Add a new listener that is called on com.sun.star.awt.FocusEvent.

Use this focus broadcaster to keep track of the object that currently has the input focus.

Return type:

None

Parameters:

listener (com.sun.star.awt.XFocusListener) –

add_key_handler(handler)

Add a new listener that is called on com.sun.star.awt.KeyEvent.

Every listener is given the opportunity to consume the event, i.e. prevent the not yet called listeners from being called.

Return type:

None

Parameters:

handler (com.sun.star.awt.XKeyHandler) –

add_top_window_listener(listener)

Add a new listener that is called for events that involve com.sun.star.awt.XTopWindow.

After having obtained the current list of existing top-level windows you can keep this list up-to-date by listening to opened or closed top-level windows. Wait for activations or deactivations of top-level windows to keep track of the currently active frame.

Return type:

None

Parameters:

listener (com.sun.star.awt.XTopWindowListener) –

fire_focus_gained(source)

Broadcasts the a focusGained on all registered focus listeners.

Return type:

None

Parameters:

source (com.sun.star.uno.XInterface) –

fire_focus_lost(source)

Broadcasts the a focusGained on all registered focus listeners.

Return type:

None

Parameters:

source (com.sun.star.uno.XInterface) –

get_active_top_window()

Return the currently active top-level window, i.e.

which has currently the input focus.

Return type:

XTopWindow

get_top_window(idx)

Return a reference to the specified top-level window.

Note that the number of top-level windows may change between a call to getTopWindowCount() and successive calls to this function.

Raises:

com.sun.star.lang.IndexOutOfBoundsException – IndexOutOfBoundsException

Return type:

XTopWindow

Parameters:

idx (int) –

get_top_window_count()

This function returns the number of currently existing top-level windows.

Return type:

int

remove_focus_listener(listener)

Remove the specified listener from the list of listeners.

Return type:

None

Parameters:

listener (com.sun.star.awt.XFocusListener) –

remove_key_handler(handler)

Remove the specified listener from the list of listeners.

Return type:

None

Parameters:

handler (com.sun.star.awt.XKeyHandler) –

remove_top_window_listener(xListener)

Remove the specified listener from the list of listeners.

Return type:

None

Parameters:

xListener (com.sun.star.awt.XTopWindowListener) –