ooodev.adapter.frame.status_events module

class ooodev.adapter.frame.status_events.StatusEvents(subscriber, trigger_args=None)

Bases: object

Class for managing Status Events.

Parameters:

• subscriber (XDispatch) –

• trigger_args (GenericArgs | None) –

__init__(subscriber, trigger_args=None)

Constructor

Parameters:

• subscriber (XDispatch) – An UNO object that implements the XDispatch interface.

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

Return type:

None

add_event_status_changed(url, cb)

Adds a listener for an event.

Event is invoked when the status of the feature changes.

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

Return type:

None

Parameters:

• url (com.sun.star.util.URL) –

• cb (Any) –

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

remove_event_border_resize_events_disposing(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_status_changed(url, cb)

Removes a listener for an event

Return type:

None

Parameters:

• url (com.sun.star.util.URL) –

• cb (Any) –

ooodev.adapter.frame.status_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 BorderResizeEvents 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.