from __future__ import annotations
from typing import Any, TYPE_CHECKING, Tuple
from com.sun.star.script import XEventAttacherManager
from ooodev.exceptions import ex as mEx
from ooodev.loader import lo as mLo
if TYPE_CHECKING:
from com.sun.star.uno import XInterface
from com.sun.star.script import XScriptListener
from com.sun.star.script import ScriptEventDescriptor # struct
from ooodev.utils.type_var import UnoInterface
[docs]class EventAttacherManagerPartial:
"""
Partial class for XEventAttacherManager.
"""
[docs] def __init__(
self, component: XEventAttacherManager, interface: UnoInterface | None = XEventAttacherManager
) -> None:
"""
Constructor
Args:
component (XEventAttacherManager): UNO Component that implements ``com.sun.star.script.XEventAttacherManager`` interface.
interface (UnoInterface, optional): The interface to be validated. Defaults to ``XEventAttacherManager``.
"""
def validate(comp: Any, obj_type: Any) -> None:
if obj_type is None:
return
if not mLo.Lo.is_uno_interfaces(comp, obj_type):
raise mEx.MissingInterfaceError(obj_type)
validate(component, interface)
self.__component = component
# region XEventAttacherManager
[docs] def add_script_listener(self, listener: XScriptListener) -> None:
"""
Adds an ``XScriptListener`` that will be notified when an event takes place.
Args:
listener (XScriptListener): The listener to be added.
"""
self.__component.addScriptListener(listener)
[docs] def attach(self, idx: int, obj: XInterface, helper: Any) -> None:
"""
Attaches all the ScriptEvents which are registered for the given index to the given object.
"""
self.__component.attach(idx, obj, helper)
[docs] def detach(self, idx: int, obj: XInterface) -> None:
"""
Detaches all the ScriptEvents which are registered for the given index from the given object.
"""
self.__component.detach(idx, obj)
[docs] def get_script_events(self, idx: int) -> Tuple[ScriptEventDescriptor, ...]:
"""
Returns all the ScriptEvents which are registered for the given index.
"""
return self.__component.getScriptEvents(idx)
[docs] def insert_entry(self, idx: int) -> None:
"""
Inserts a new entry into the event attacher manager.
"""
self.__component.insertEntry(idx)
[docs] def register_script_event(self, idx: int, event: ScriptEventDescriptor) -> None:
"""
Registers a ScriptEvent for the given index.
"""
self.__component.registerScriptEvent(idx, event)
[docs] def register_script_events(self, idx: int, events: Tuple[ScriptEventDescriptor, ...]) -> None:
"""
Registers a ScriptEvent for the given index.
"""
self.__component.registerScriptEvents(idx, events)
[docs] def remove_entry(self, idx: int) -> None:
"""
Removes the entry at the given position.
"""
self.__component.removeEntry(idx)
[docs] def remove_script_listener(self, listener: XScriptListener) -> None:
"""
Removes an ``XScriptListener`` that was added with ``addScriptListener``.
"""
self.__component.removeScriptListener(listener)
[docs] def revoke_script_event(self, idx: int, listen_type: str, event_method: str, remove_listener_param: str) -> None:
"""
Revokes the registration of an event.
The parameters ``listen_type`` and ``event_method`` are equivalent to the first two members of the ScriptEventDescriptor used to register events.
"""
self.__component.revokeScriptEvent(idx, listen_type, event_method, remove_listener_param)
[docs] def revoke_script_events(self, idx: int) -> None:
"""
Revokes all events which are registered for the given index.
If the events at this index have been attached to any object, they are detached automatically.
"""
self.__component.revokeScriptEvents(idx)
# endregion XEventAttacherManager