Source code for ooodev.adapter.lang.event_events

from __future__ import annotations
import contextlib
from typing import Any, TYPE_CHECKING

from import GenericArgs
from import ListenerEventArgs
from ooodev.utils import gen_util as gUtil
from ooodev.adapter.lang.event_listener import EventListener

    from ooodev.utils.type_var import EventArgsCallbackT, ListenerEventCallbackT

[docs]class EventEvents: """ Class for managing Events. This class is usually inherited by control classes that implement ````. """
[docs] def __init__( self, trigger_args: GenericArgs | None = None, cb: ListenerEventCallbackT | None = None, listener: EventListener | None = None, subscriber: Any = None, ) -> None: """ Constructor Args: 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 (EventListener | None, optional): Listener that is used to manage events. subscriber (Any, optional): An UNO object that has a ``addAdjustmentListener()`` Method. If passed in then this instance listener is automatically added to it. """ self.__callback = cb if listener: self.__listener = listener if subscriber: # several object such as Scrollbar and SpinValue # There is no common interface for this, so we have to try them all. with contextlib.suppress(AttributeError): subscriber.addAdjustmentListener(self.__listener) else: self.__listener = EventListener(trigger_args=trigger_args, subscriber=subscriber) self.__name = gUtil.Util.generate_random_string(10)
# region Manage Events
[docs] def add_event_disposing(self, cb: EventArgsCallbackT) -> None: """ 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 ```` struct. """ if self.__callback: args = ListenerEventArgs(source=self.__name, trigger_name="disposing") self.__callback(self, args) if args.remove_callback: self.__callback = None self.__listener.on("disposing", cb)
[docs] def remove_event_disposing(self, cb: EventArgsCallbackT) -> None: """ Removes a listener for an event """ if self.__callback: args = ListenerEventArgs(source=self.__name, trigger_name="disposing", is_add=False) self.__callback(self, args) if args.remove_callback: self.__callback = None"disposing", cb)
@property def events_listener_event(self) -> EventListener: """ Returns listener """ return self.__listener
# endregion Manage Events
[docs]def on_lazy_cb(source: Any, event: ListenerEventArgs) -> None: """ 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. Args: source (Any): Expected to be an instance of EventEvents that is a partial class of a component based class. event (ListenerEventArgs): Event arguments. Returns: None: Warning: This method is intended for internal use only. """ # will only ever fire once if not isinstance(source, EventEvents): return if not hasattr(source, "component"): return with contextlib.suppress(AttributeError): source.component.addAdjustmentListener(source.events_listener_event) # type: ignore event.remove_callback = True