from __future__ import annotations
from typing import Any, cast, TYPE_CHECKING
try:
# python 3.12+
from typing import override # noqa # type: ignore
except ImportError:
from typing_extensions import override # noqa # type: ignore
from ooodev.events.args.listener_event_args import ListenerEventArgs
from ooodev.adapter.component_base import ComponentBase
from ooodev.adapter.sheet.result_events import ResultEvents
if TYPE_CHECKING:
from com.sun.star.sheet import VolatileResult # service
[docs]class VolatileResultComp(ComponentBase, ResultEvents):
"""
Class for managing Volatile Result Component.
"""
# pylint: disable=unused-argument
[docs] def __init__(self, component: VolatileResult) -> None:
"""
Constructor
Args:
component (VolatileResult): UNO Volatile Result Component
"""
ComponentBase.__init__(self, component)
# pylint: disable=no-member
generic_args = self._ComponentBase__get_generic_args() # type: ignore
ResultEvents.__init__(self, trigger_args=generic_args, cb=self._on_result_events_add_remove)
# region Lazy Listeners
def _on_result_events_add_remove(self, source: Any, event: ListenerEventArgs) -> None:
# will only ever fire once
self.component.addResultListener(self.events_listener_result)
event.remove_callback = True
# endregion Lazy Listeners
# region Overrides
@override
def _ComponentBase__get_supported_service_names(self) -> tuple[str, ...]:
"""Returns a tuple of supported service names."""
return ("com.sun.star.sheet.VolatileResult",)
# endregion Overrides
# region Properties
@property
@override
def component(self) -> VolatileResult:
"""Volatile Result Component"""
# pylint: disable=no-member
return cast("VolatileResult", self._ComponentBase__get_component()) # type: ignore
# endregion Properties