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.awt import XWindowListener
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.awt import WindowEvent
from com.sun.star.awt import XWindow
[docs]class WindowListener(AdapterBase, XWindowListener):
"""
Makes it possible to receive window events.
Component events are provided only for notification purposes.
Moves and resizes will be handled internally by the window component, so that GUI
layout works properly regardless of whether a program registers such a listener or not.
See Also:
`API XWindowListener <https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XWindowListener.html>`_
"""
[docs] def __init__(self, trigger_args: GenericArgs | None = None, subscriber: XWindow | None = None) -> None:
"""
Constructor:
Arguments:
trigger_args (GenericArgs, optional): Args that are passed to events when they are triggered.
subscriber (XWindow, optional): An UNO object that implements the ``XWindow`` interface.
If passed in then this listener instance is automatically added to it.
"""
super().__init__(trigger_args=trigger_args)
if subscriber:
subscriber.addWindowListener(self)
# region XPaintListener
[docs] @override
def windowHidden(self, e: EventObject) -> None:
"""
is invoked when the window has been hidden.
"""
self._trigger_event("windowHidden", e)
[docs] @override
def windowMoved(self, e: WindowEvent) -> None:
"""
is invoked when the window has been moved.
"""
self._trigger_event("windowMoved", e)
[docs] @override
def windowResized(self, e: WindowEvent) -> None:
"""
is invoked when the window has been resized.
"""
self._trigger_event("windowResized", e)
[docs] @override
def windowShown(self, e: EventObject) -> None:
"""
is invoked when the window has been shown.
"""
self._trigger_event("windowShown", e)
[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)
# endregion XPaintListener