ooodev.adapter.script.vba.vba_script_listener module

class ooodev.adapter.script.vba.vba_script_listener.VBAScriptListener(trigger_args=None, subscriber=None)[source]

Bases: AdapterBase, XVBAScriptListener

VBA Script Listener.

See also

API XVBAScriptListener

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 (XVBACompatibility, optional) – An UNO object that implements the XVBACompatibility interface. If passed in then this listener instance is automatically added to it.

Return type:

None

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.

Return type:: None
Parameters:: Source (com.sun.star.lang.EventObject) –

notifyVBAScriptEvent(Event)[source]

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

Components may use this to stop any other event processing related to the event source until they get the reloaded event.

Parameters:

event (VBAScriptEvent) – Event data for the event.
Event (com.sun.star.script.vba.VBAScriptEvent) –

Return type:

None