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.ui.accelerator_configuration_partial import AcceleratorConfigurationPartial
from ooodev.adapter.ui.ui_configuration_events import UIConfigurationEvents
if TYPE_CHECKING:
from com.sun.star.ui import DocumentAcceleratorConfiguration
from com.sun.star.embed import XStorage
[docs]class DocumentAcceleratorConfigurationComp(ComponentBase, AcceleratorConfigurationPartial, UIConfigurationEvents):
"""
Class for managing DocumentAcceleratorConfiguration Component.
"""
# pylint: disable=unused-argument
[docs] def __init__(self, component: DocumentAcceleratorConfiguration) -> None:
"""
Constructor
Args:
component (DocumentAcceleratorConfiguration): UNO DocumentAcceleratorConfiguration Component that supports ``com.sun.star.ui.DocumentAcceleratorConfiguration`` service.
"""
# component is a struct
ComponentBase.__init__(self, component)
AcceleratorConfigurationPartial.__init__(self, component=component, interface=None)
# pylint: disable=no-member
generic_args = self._ComponentBase__get_generic_args() # type: ignore
UIConfigurationEvents.__init__(
self, trigger_args=generic_args, cb=self.__on_ui_configuration_events_add_remove
)
# region Lazy Listeners
def __on_ui_configuration_events_add_remove(self, source: Any, event: ListenerEventArgs) -> None:
# will only ever fire once
self.component.addConfigurationListener(self.events_listener_ui_configuration)
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."""
# validated by mTextRangePartial.TextRangePartial
return ("com.sun.star.ui.DocumentAcceleratorConfiguration",)
# endregion Overrides
[docs] def create_with_document_root(self, document_root: XStorage) -> None:
"""
Creates the component with the specified document root.
"""
self.component.createWithDocumentRoot(document_root)
@property
@override
def component(self) -> DocumentAcceleratorConfiguration:
"""DocumentAcceleratorConfiguration Component"""
# pylint: disable=no-member
return cast("DocumentAcceleratorConfiguration", self._ComponentBase__get_component()) # type: ignore