ooodev.adapter.frame.terminate_listener module

class ooodev.adapter.frame.terminate_listener.TerminateListener(trigger_args=None, add_listener=True, subscriber=None)[source]

Bases: AdapterBase, XTerminateListener

Has to be provided if an object wants to receive an event when the master environment (e.g., desktop) is terminated.

See also

Parameters:

  • args (Any) –

  • kwargs (Any) –

Return type:

Any

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

Constructor

Parameters:

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

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

notifyTermination(event)[source]

Is called when the master environment is finally terminated.

No veto will be accepted then.

Return type:

None

Parameters:

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

queryTermination(event)[source]

Is called when the master environment (e.g., desktop) is about to terminate.

Termination can be intercepted by throwing TerminationVetoException. Interceptor will be the new owner of desktop and should call XDesktop.terminate() after finishing his own operations.

Raises:

TerminationVetoException – TerminationVetoException

Return type:

None

Parameters:

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