ooodev.adapter.script.event_attacher_manager_partial module
- class ooodev.adapter.script.event_attacher_manager_partial.EventAttacherManagerPartial(component, interface=com.sun.star.script.XEventAttacherManager)[source]
Bases:
object
Partial class for XEventAttacherManager.
- Parameters:
component (XEventAttacherManager) –
interface (UnoInterface | None) –
- __init__(component, interface=com.sun.star.script.XEventAttacherManager)[source]
Constructor
- Parameters:
component (XEventAttacherManager) – UNO Component that implements
com.sun.star.script.XEventAttacherManager
interface.interface (UnoInterface, optional) – The interface to be validated. Defaults to
XEventAttacherManager
.
- Return type:
None
- add_script_listener(listener)[source]
Adds an
XScriptListener
that will be notified when an event takes place.- Parameters:
listener (XScriptListener) – The listener to be added.
- Return type:
None
- attach(idx, obj, helper)[source]
Attaches all the ScriptEvents which are registered for the given index to the given object.
- Return type:
None
- Parameters:
idx (int) –
obj (com.sun.star.uno.XInterface) –
helper (Any) –
- detach(idx, obj)[source]
Detaches all the ScriptEvents which are registered for the given index from the given object.
- Return type:
None
- Parameters:
idx (int) –
obj (com.sun.star.uno.XInterface) –
- get_script_events(idx)[source]
Returns all the ScriptEvents which are registered for the given index.
- Return type:
Tuple
[ScriptEventDescriptor
,...
]- Parameters:
idx (int) –
- insert_entry(idx)[source]
Inserts a new entry into the event attacher manager.
- Return type:
None
- Parameters:
idx (int) –
- register_script_event(idx, event)[source]
Registers a ScriptEvent for the given index.
- Return type:
None
- Parameters:
idx (int) –
event (com.sun.star.script.ScriptEventDescriptor) –
- register_script_events(idx, events)[source]
Registers a ScriptEvent for the given index.
- Return type:
None
- Parameters:
idx (int) –
events (Tuple[com.sun.star.script.ScriptEventDescriptor, ...]) –
- remove_entry(idx)[source]
Removes the entry at the given position.
- Return type:
None
- Parameters:
idx (int) –
- remove_script_listener(listener)[source]
Removes an
XScriptListener
that was added withaddScriptListener
.- Return type:
None
- Parameters:
listener (com.sun.star.script.XScriptListener) –
- revoke_script_event(idx, listen_type, event_method, remove_listener_param)[source]
Revokes the registration of an event.
The parameters
listen_type
andevent_method
are equivalent to the first two members of the ScriptEventDescriptor used to register events.- Return type:
None
- Parameters:
idx (int) –
listen_type (str) –
event_method (str) –
remove_listener_param (str) –