from __future__ import annotations
from typing import Any, TYPE_CHECKING
from com.sun.star.lang import XComponent
from ooodev.exceptions import ex as mEx
from ooodev.loader import lo as mLo
if TYPE_CHECKING:
from com.sun.star.lang import XEventListener
from ooodev.utils.type_var import UnoInterface
[docs]class ComponentPartial:
"""
Partial class for XComponent.
"""
[docs] def __init__(self, component: XComponent, interface: UnoInterface | None = XComponent) -> None:
"""
Constructor
Args:
component (XComponent): UNO Component that implements ``com.sun.star.lang.XComponent`` interface.
interface (UnoInterface, optional): The interface to be validated. Defaults to ``XComponent``.
"""
def validate(comp: Any, obj_type: Any) -> None:
if obj_type is None:
return
if not mLo.Lo.is_uno_interfaces(comp, obj_type):
raise mEx.MissingInterfaceError(obj_type)
validate(component, interface)
self.__component = component
# region XComponent
[docs] def add_event_listener(self, listener: XEventListener) -> None:
"""
Adds an event listener to the component.
Args:
listener (XEventListener): The event listener to be added.
"""
self.__component.addEventListener(listener)
[docs] def remove_event_listener(self, listener: XEventListener) -> None:
"""
Removes an event listener from the component.
Args:
listener (XEventListener): The event listener to be removed.
"""
self.__component.removeEventListener(listener)
[docs] def dispose(self) -> None:
"""
Disposes the component.
"""
self.__component.dispose()
# endregion XComponent
[docs]def get_builder(component: Any) -> Any:
"""
Get the builder for the component.
Args:
component (Any): The component.
Returns:
DefaultBuilder: Builder instance.
"""
# pylint: disable=import-outside-toplevel
from ooodev.utils.builder.default_builder import DefaultBuilder
builder = DefaultBuilder(component)
builder.auto_add_interface("com.sun.star.lang.XComponent", False)
return builder