ooodev.adapter.form.load_events module

class ooodev.adapter.form.load_events.LoadEvents(trigger_args=None, cb=None, listener=None, subscriber=None)[source]

Bases: object

Class for managing Load Events.

Parameters:

  • trigger_args (GenericArgs | None) –

  • cb (ListenerEventCallbackT | None) –

  • listener (LoadListener | None) –

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

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

Return type:

None

add_event_load_events_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_loaded(cb)[source]

Adds a listener for an event.

Event is invoked when the object has successfully connected to a datasource.

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

Return type:

None

Parameters:

cb (Any) –

add_event_reloaded(cb)[source]

Adds a listener for an event.

Event is invoked when the object has been reloaded.

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

Return type:

None

Parameters:

cb (Any) –

add_event_reloading(cb)[source]

Adds a listener for an event.

Event is invoked when the object is about to be reloaded.

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

Return type:

None

Parameters:

cb (Any) –

add_event_unloaded(cb)[source]

Adds a listener for an event.

Event is invoked after the object has disconnected from a datasource.

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

Return type:

None

Parameters:

cb (Any) –

add_event_unloading(cb)[source]

Adds a listener for an event.

Event is invoked when the object is about to be unloaded.

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

Return type:

None

Parameters:

cb (Any) –

remove_event_load_events_disposing(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_loaded(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_reloaded(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_reloading(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_unloaded(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_unloading(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_load: LoadListener

Returns listener

Return type:

LoadListener