from __future__ import annotations
from typing import Any, cast, TYPE_CHECKING
from com.sun.star.awt import XExtendedToolkit
from ooodev.events.args.generic_args import GenericArgs
from ooodev.events.args.listener_event_args import ListenerEventArgs
from ooodev.utils import gen_util as gUtil
from ooodev.loader import lo as mLo
from ooodev.adapter.awt.top_window_listener import TopWindowListener
if TYPE_CHECKING:
from ooodev.utils.type_var import EventArgsCallbackT, ListenerEventCallbackT
# sourcery skip: class-extract-method
[docs]class TopWindowEvents:
"""
Class for managing Top Window Events.
This class is usually inherited by control classes that implement ``com.sun.star.awt.XWindowListener``.
"""
[docs] def __init__(
self,
trigger_args: GenericArgs | None = None,
cb: ListenerEventCallbackT | None = None,
listener: TopWindowListener | None = None,
add_window_listener: bool = False,
) -> 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 (TopWindowListener | None, optional): Listener that is used to manage events.
add_window_listener (bool, optional): If ``True`` Top window listener is automatically added. Default ``True``.
"""
self.__callback = cb
if listener:
self.__listener = listener
if add_window_listener:
# if the listener has a toolkit then a listener has already been added.
if self.__listener.toolkit is None:
self.__tool_kit = mLo.Lo.create_instance_mcf(
XExtendedToolkit, "com.sun.star.awt.Toolkit", raise_err=True
)
if self.__tool_kit is not None:
self.__tool_kit.addTopWindowListener(self.__listener)
else:
self.__listener.toolkit.addTopWindowListener(self.__listener)
else:
self.__listener = TopWindowListener(trigger_args=trigger_args, add_listener=add_window_listener)
self.__name = gUtil.Util.generate_random_string(10)
# region Manage Events
[docs] def add_event_window_activated(self, cb: EventArgsCallbackT) -> None:
"""
Adds a listener for an event.
Event is invoked when a window is activated.
The callback ``EventArgs.event_data`` will contain a UNO ``com.sun.star.langEventObject`` struct.
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowActivated")
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.on("windowActivated", cb)
[docs] def add_event_window_closed(self, cb: EventArgsCallbackT) -> None:
"""
Adds a listener for an event.
Event is invoked when a window has been closed.
The callback ``EventArgs.event_data`` will contain a UNO ``com.sun.star.lang.EventObject`` struct.
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowActivated")
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.on("windowActivated", cb)
[docs] def add_event_window_closing(self, cb: EventArgsCallbackT) -> None:
"""
Adds a listener for an event.
Event is invoked when a window is in the process of being closed.
The callback ``EventArgs.event_data`` will contain a UNO ``com.sun.star.lang.EventObject`` struct.
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowClosing")
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.on("windowClosing", cb)
[docs] def add_event_window_deactivated(self, cb: EventArgsCallbackT) -> None:
"""
Adds a listener for an event.
Event is invoked when a window is deactivated.
The callback ``EventArgs.event_data`` will contain a UNO ``com.sun.star.lang.EventObject`` struct.
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowDeactivated")
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.on("windowDeactivated", cb)
[docs] def add_event_window_minimized(self, cb: EventArgsCallbackT) -> None:
"""
Adds a listener for an event.
Event is invoked when a window is iconified.
The callback ``EventArgs.event_data`` will contain a UNO ``com.sun.star.lang.EventObject`` struct.
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowMinimized")
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.on("windowMinimized", cb)
[docs] def add_event_window_normalized(self, cb: EventArgsCallbackT) -> None:
"""
Adds a listener for an event.
Event is invoked when a window is deiconified.
The callback ``EventArgs.event_data`` will contain a UNO ``com.sun.star.lang.EventObject`` struct.
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowNormalized")
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.on("windowNormalized", cb)
[docs] def add_event_window_opened(self, cb: EventArgsCallbackT) -> None:
"""
Adds a listener for an event.
Event is invoked when a window has been opened.
The callback ``EventArgs.event_data`` will contain a UNO ``com.sun.star.lang.EventObject`` struct.
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowOpened")
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.on("windowOpened", cb)
[docs] def add_event_top_window_events_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 ``com.sun.star.lang.EventObject`` 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_window_activated(self, cb: EventArgsCallbackT) -> None:
"""
Removes a listener for an event
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowActivated", is_add=False)
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.off("windowActivated", cb)
[docs] def remove_event_window_closed(self, cb: EventArgsCallbackT) -> None:
"""
Removes a listener for an event
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowClosed", is_add=False)
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.off("windowClosed", cb)
[docs] def remove_event_window_closing(self, cb: EventArgsCallbackT) -> None:
"""
Removes a listener for an event
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowClosing", is_add=False)
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.off("windowClosing", cb)
[docs] def remove_event_window_deactivated(self, cb: EventArgsCallbackT) -> None:
"""
Removes a listener for an event
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowDeactivated", is_add=False)
self.__callback(self, args)
self.__listener.off("windowDeactivated", cb)
[docs] def remove_event_window_minimized(self, cb: EventArgsCallbackT) -> None:
"""
Removes a listener for an event
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowMinimized", is_add=False)
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.off("windowMinimized", cb)
[docs] def remove_event_window_normalized(self, cb: EventArgsCallbackT) -> None:
"""
Removes a listener for an event
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowNormalized", is_add=False)
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.off("windowNormalized", cb)
[docs] def remove_event_window_opened(self, cb: EventArgsCallbackT) -> None:
"""
Removes a listener for an event
"""
if self.__callback:
args = ListenerEventArgs(source=self.__name, trigger_name="windowOpened", is_add=False)
self.__callback(self, args)
if args.remove_callback:
self.__callback = None
self.__listener.off("windowOpened", cb)
[docs] def remove_event_top_window_events_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
self.__listener.off("disposing", cb)
# endregion Manage Events
@property
def events_listener_top_window(self) -> TopWindowListener:
"""
Returns listener
"""
return self.__listener
[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 TopWindowEvents 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, TopWindowEvents):
return
if not hasattr(source, "component"):
return
comp = cast(XExtendedToolkit, source.component) # type: ignore
comp.addTopWindowListener(source.events_listener_top_window)
event.remove_callback = True