ooodev.adapter.script.script_listener module

class ooodev.adapter.script.script_listener.ScriptListener(trigger_args=None, subscriber=None)[source]

Bases: AdapterBase, XScriptListener

Specifies a listener which is to be notified about state changes in a grid control

since

OOo 3.1

See also

API XScriptListener

Parameters:

  • args (Any) –

  • kwargs (Any) –

Return type:

Any

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

Constructor

Parameters:

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

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

Return type:

None

approveFiring(aEvent)[source]

Event is invoked when a vetoable event occurs at the object. If event is canceled then the firing will be canceled.

Parameters:

  • event (EventObject) – Event data for the event.

  • aEvent (com.sun.star.script.ScriptEvent) –

Returns:

True if the firing should be performed, False otherwise.

Return type:

bool

Note

When approveFiring event is invoked it will contain a CancelEventArgs instance as the trigger event. When the event is triggered the CancelEventArgs.cancel can be set to True to cancel the firing. Also if canceled the CancelEventArgs.handled can be set to True to indicate that the firing should be performed. The CancelEventArgs.event_data will contain the original com.sun.star.lang.EventObject that triggered the update.

disposing(Source)[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.

Parameters:

  • event (EventObject) – Event data for the event.

  • Source (com.sun.star.lang.EventObject) –

Return type:

None

firing(aEvent)[source]

Event is invoked when an event takes place.

For that a ScriptEventDescriptor is registered at and attached to an object by an XEventAttacherManager.

Parameters:

  • event (ScriptEvent) – Event data for the event.

  • aEvent (com.sun.star.script.ScriptEvent) –

Return type:

None