ooodev.adapter.script.script_events module

class ooodev.adapter.script.script_events.ScriptEvents(trigger_args=None, cb=None, listener=None, subscriber=None)[source]

Bases: object

Class for managing Script Events.

Parameters:

trigger_args (GenericArgs | None) –
cb (ListenerEventCallbackT | None) –
listener (ScriptListener | None) –
subscriber (XEventAttacherManager | 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 (ScriptListener | None, optional) – Listener that is used to manage events.
subscriber (XEventAttacherManager, optional) – An UNO object that implements the com.sun.star.form.XEventAttacherManager interface. If passed in then this instance listener is automatically added to it.

Return type:

None

add_event_approve_firing(cb)[source]

Adds a listener for an event.

Event is invoked is invoked when an firing is performed. If event is canceled then the firing will be canceled.

The callback CancelEventArgs.event_data will contain a UNO com.sun.star.script.ScriptEvent struct.

Note

The callback event will be CancelEventArgs. If the CancelEventArgs.cancel is set to True then the firing will be canceled if the CancelEventArgs.handled is set to True then the firing will be performed.

Return type:: None
Parameters:: cb (Any) –

add_event_firing(cb)[source]

Adds a listener for an event.

Event is invoked when an event takes place.

The callback EventArgs.event_data will contain a UNO com.sun.star.script.ScriptEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_script_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_approve_firing(cb)[source]

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_firing(cb)[source]

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_script_events_disposing(cb)[source]

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

property events_listener_script: ScriptListener

Returns listener

Return type:: ScriptListener

ooodev.adapter.script.script_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 ScriptEvents 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.