ooodev.adapter.util.close_events module

class ooodev.adapter.util.close_events.CloseEvents(trigger_args=None, cb=None, listener=None, subscriber=None)[source]

Bases: object

Class for managing Close Events.

This class is usually inherited by control classes that implement com.sun.star.util.XCloseListener.

New in version 0.21.0.

Parameters:

  • trigger_args (GenericArgs | None) –

  • cb (ListenerEventCallbackT | None) –

  • listener (CloseListener | None) –

  • subscriber (XCloseBroadcaster | None) –

__init__(trigger_args=None, cb=None, listener=None, 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 (CloseListener | None, optional) – Listener that is used to manage events.

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

Return type:

None

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

add_event_notify_closing(cb)[source]

Adds a listener for an event.

Event is invoked when the listened object is closed really.

Now the listened object is closed really. Listener has to accept that; should deregister itself and release all references to it. It’s not allowed nor possible to disagree with that by throwing any exception.

If the event com.sun.star.lang.XEventListener.disposing() occurred before it must be accepted too. There exist no chance for a disagreement any more.

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

Return type:

None

Parameters:

cb (Any) –

add_event_query_closing(cb)[source]

Adds a listener for an event.

Event is invoked when somewhere tries to close listened object

Is called before XCloseListener.notifyClosing(). Listener has the chance to break that by throwing a CloseVetoException. This exception must be passed to the original caller of XCloseable.close() without any interaction.

The parameter gets_ownership regulate who has to try to close the listened object again, if this listener disagree with the request by throwing the exception. If it’s set to False the original caller of XCloseable.close() will be the owner in every case. It’s not allowed to call close() from this listener then. If it’s set to True this listener will be the new owner if he throw the exception, otherwise not! If his still running processes will be finished he must call close() on listened object again then.

If this listener doesn’t disagree with th close request it depends from his internal implementation if he deregister itself at the listened object. But normally this must be done in XCloseListener.notifyClosing().

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

Note

The callback event is an instance of KeyValArgs with the following properties: event.key=gets_ownership, event.value is a bool and event.event_data is com.sun.star.lang.EventObject.

This is because the UNO interface com.sun.star.util.XCloseListener has the following signature: void queryClosing ([in] com::sun::star::lang::EventObject Source, [in] boolean GetsOwnership).

Return type:

None

Parameters:

cb (Any) –

remove_event_close_events_disposing(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_notify_closing(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_query_closing(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_close: CloseListener

Returns listener

Return type:

CloseListener

ooodev.adapter.util.close_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 CloseEvents 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.