Source code for ooodev.adapter.form.load_listener

from __future__ import annotations
from typing import TYPE_CHECKING

import uno
from com.sun.star.form import XLoadListener

from ooodev.events.args.generic_args import GenericArgs
from ooodev.adapter.adapter_base import AdapterBase


if TYPE_CHECKING:
    from com.sun.star.lang import EventObject
    from com.sun.star.form import XLoadable


[docs]class LoadListener(AdapterBase, XLoadListener): """ Specifies a listener which receives load-related events from a loadable object. The interface is typically implemented by data-bound components, which want to listen to the data source that contains their database form. See Also: `API XLoadListener <https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form_1_1XLoadListener.html>`_ """
[docs] def __init__(self, trigger_args: GenericArgs | None = None, subscriber: XLoadable | None = None) -> None: """ Constructor Args: trigger_args (GenericArgs, Optional): Args that are passed to events when they are triggered. subscriber (XLoadable, optional): An UNO object that implements the ``com.sun.star.form.XLoadable`` interface. If passed in then this listener instance is automatically added to it. """ super().__init__(trigger_args=trigger_args) if subscriber: subscriber.addLoadListener(self)
[docs] def loaded(self, event: EventObject) -> None: """ Event is invoked when the object has successfully connected to a datasource. Args: event (EventObject): Event data for the event. Returns: None: """ self._trigger_event("loaded", event)
[docs] def reloaded(self, event: EventObject) -> None: """ Event is invoked when the object has been reloaded. Args: event (EventObject): Event data for the event. Returns: None: """ self._trigger_event("reloaded", event)
[docs] def reloading(self, event: EventObject) -> None: """ 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. Args: event (EventObject): Event data for the event. Returns: None: """ self._trigger_event("reloading", event)
[docs] def unloaded(self, event: EventObject) -> None: """ Event is invoked after the object has disconnected from a datasource. Args: event (EventObject): Event data for the event. Returns: None: """ self._trigger_event("unloaded", event)
[docs] def unloading(self, event: EventObject) -> None: """ Event is invoked when the object is about to be unloaded. Components may use this to stop any other event processing related to the event source before the object is unloaded. Args: event (EventObject): Event data for the event. Returns: None: """ self._trigger_event("unloading", event)
[docs] def disposing(self, event: EventObject) -> None: """ 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``. Args: event (EventObject): Event data for the event. Returns: None: """ # from com.sun.star.lang.XEventListener self._trigger_event("disposing", event)