from __future__ import annotations
from typing import TYPE_CHECKING
try:
# python 3.12+
from typing import override # noqa # type: ignore
except ImportError:
from typing_extensions import override # noqa # type: ignore
from com.sun.star.util import XModifyListener
from com.sun.star.util import XModifyBroadcaster
from ooodev.loader import lo as mLo
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
[docs]class ModifyListener(AdapterBase, XModifyListener):
"""
makes it possible to receive events when a model object changes.
See Also:
- :ref:`ch25_listening_for_modifications`
- `API XModifyListener <https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1util_1_1XModifyListener.html>`_
"""
[docs] def __init__(
self, trigger_args: GenericArgs | None = None, subscriber: XModifyBroadcaster | None = None, **kwargs
) -> None:
"""
Constructor
Args:
trigger_args (GenericArgs, Optional): Args that are passed to events when they are triggered.
subscriber (XModifyBroadcaster, optional): An UNO object that implements the ``XModifyBroadcaster`` interface.
If passed in then this listener instance is automatically added to it.
"""
super().__init__(trigger_args=trigger_args)
# doc parameter was renamed to subscriber in version 0.13.6
if subscriber is None:
doc = kwargs.get("doc", None)
else:
doc = subscriber
if doc is None:
return
mb = mLo.Lo.qi(XModifyBroadcaster, doc, True)
mb.addModifyListener(self)
[docs] @override
def modified(self, aEvent: EventObject) -> None:
"""
Is called when something changes in the object.
Due to such an event, it may be necessary to update views or controllers.
The source of the event may be the content of the object to which the listener
is registered.
"""
self._trigger_event("modified", aEvent)
[docs] @override
def disposing(self, Source: 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``.
"""
# from com.sun.star.lang.XEventListener
self._trigger_event("disposing", Source)