ooodev.adapter.awt.top_window_events module

class ooodev.adapter.awt.top_window_events.TopWindowEvents(trigger_args=None, cb=None, listener=None, add_window_listener=False)

Bases: object

Class for managing Top Window Events.

This class is usually inherited by control classes that implement com.sun.star.awt.XWindowListener.

Parameters:

• trigger_args (GenericArgs | None) –

• cb (ListenerEventCallbackT | None) –

• listener (TopWindowListener | None) –

• add_window_listener (bool) –

__init__(trigger_args=None, cb=None, listener=None, add_window_listener=False)

Constructor

Parameters:

• trigger_args (GenericArgs, optional) – Args that are passed to events when they are triggered. This only applies if the listener is not passed.

• cb (ListenerEventCallbackT | None, optional) – Callback that is invoked when an event is added or removed.

• listener (TopWindowListener | None, optional) – Listener that is used to manage events.

• add_window_listener (bool, optional) – If True Top window listener is automatically added. Default True.

Return type:

None

add_event_top_window_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

add_event_window_activated(cb)

Adds a listener for an event.

Event is invoked when a window is activated.

The callback EventArgs.event_data will contain a UNO com.sun.star.langEventObject struct.

Return type:

None

Parameters:

cb (Any) –

add_event_window_closed(cb)

Adds a listener for an event.

Event is invoked when a window has been closed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

add_event_window_closing(cb)

Adds a listener for an event.

Event is invoked when a window is in the process of being closed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

add_event_window_deactivated(cb)

Adds a listener for an event.

Event is invoked when a window is deactivated.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

add_event_window_minimized(cb)

Adds a listener for an event.

Event is invoked when a window is iconified.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

add_event_window_normalized(cb)

Adds a listener for an event.

Event is invoked when a window is deiconified.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

add_event_window_opened(cb)

Adds a listener for an event.

Event is invoked when a window has been opened.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

remove_event_top_window_events_disposing(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_window_activated(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_window_closed(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_window_closing(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_window_deactivated(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_window_minimized(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_window_normalized(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_window_opened(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_top_window: TopWindowListener

Returns listener

Return type:

TopWindowListener

ooodev.adapter.awt.top_window_events.on_lazy_cb(source, event)

Callback that is invoked when an event is added or removed.

This method is generally used to add the listener to the component in a lazy manner. This means this callback will only be called once in the lifetime of the component.

Parameters:

• source (Any) – Expected to be an instance of TopWindowEvents that is a partial class of a component based class.

• event (ListenerEventArgs) – Event arguments.

Return type:

None

Warning

This method is intended for internal use only.