ooodev.adapter.frame.terminate_events module

class ooodev.adapter.frame.terminate_events.TerminateEvents(trigger_args=None, cb=None, listener=None, add_terminate_listener=True, subscriber=None)[source]

Bases: object

Class for managing Terminate Events.

This class is usually inherited by control classes that implement com.sun.star.frame.XTerminateListener.

Parameters:

  • trigger_args (GenericArgs | None) –

  • cb (ListenerEventCallbackT | None) –

  • listener (TerminateListener | None) –

  • add_terminate_listener (bool) –

  • subscriber (XDesktop | None) –

__init__(trigger_args=None, cb=None, listener=None, add_terminate_listener=True, subscriber=None)[source]

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 (TerminateListener | None, optional) – Listener that is used to manage events.

  • add_terminate_listener (bool, optional) – If True listener is automatically added. Default True.

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

Return type:

None

add_event_notify_termination(cb)[source]

Adds a listener for an event.

Event is invoked when the master environment is finally terminated.

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

Return type:

None

Parameters:

cb (Any) –

add_event_query_termination(cb)[source]

Adds a listener for an event.

Event is invoked when the master environment (e.g., desktop) is about to terminate.

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

Return type:

None

Parameters:

cb (Any) –

add_event_terminate_events_disposing(cb)[source]

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) –

remove_event_notify_termination(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_query_termination(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_terminate_events_disposing(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_terminate: TerminateListener

Returns listener

Return type:

TerminateListener

ooodev.adapter.frame.terminate_events.on_lazy_cb(source, event)[source]

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 TerminateEvents 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.