Source code for ooodev.adapter.frame.layout_manager_comp

from __future__ import annotations
from typing import Any, cast, TYPE_CHECKING
import uno
from ooodev.adapter._helper.builder import builder_helper
from ooodev.adapter._helper.builder.comp_defaults_partial import CompDefaultsPartial
from ooodev.adapter.component_prop import ComponentProp
from ooodev.utils.builder.default_builder import DefaultBuilder
from ooodev.adapter.frame import layout_manager2_partial

if TYPE_CHECKING:
    from com.sun.star.frame import LayoutManager  # service


class _LayoutManagerComp(ComponentProp):

    def __eq__(self, other: Any) -> bool:
        if not isinstance(other, ComponentProp):
            return False
        if self is other:
            return True
        if self.component is other.component:
            return True
        return self.component == other.component

    def _ComponentBase__get_supported_service_names(self) -> tuple[str, ...]:
        """Returns a tuple of supported service names."""
        return ("com.sun.star.frame.LayoutManager",)

    # region context manage
    def __enter__(self) -> _LayoutManagerComp:
        # LayoutManagerPartial has lock and unlock
        self.lock()  # type: ignore
        return self

    def __exit__(self, exc_type, exc_value, traceback) -> None:
        self.unlock()  # type: ignore

    # endregion context manage

    # region Properties
    @property
    def __class__(self):
        # pretend to be a LayoutManagerComp class
        return LayoutManagerComp

    # endregion Properties


[docs]class LayoutManagerComp( _LayoutManagerComp, layout_manager2_partial.LayoutManager2Partial, CompDefaultsPartial, # child_partial.ChildPartial, ): """ Class for managing LayoutManager Component. Note: This is a Dynamic class that is created at runtime. This means that the class is created at runtime and not defined in the source code. In addition, the class may be created with additional classes implemented. The Type hints for this class at design time may not be accurate. To check if a class implements a specific interface, use the ``isinstance`` function or :py:meth:`~.InterfacePartial.is_supported_interface` methods which is always available in this class. Note: This component is also a context manager and will lock and unlock the component when used in a ``with`` statement. .. code-block:: python comp = doc.get_frame_comp() with comp.layout_manager: # do something with the layout manager while locked """ # pylint: disable=unused-argument def __new__(cls, component: Any, *args, **kwargs): builder = get_builder(component=component) builder_helper.builder_add_comp_defaults(builder) builder_helper.builder_add_property_change_implement(builder) builder_helper.builder_add_property_veto_implement(builder) builder_only = kwargs.get("_builder_only", False) if builder_only: # cast to prevent type checker error return cast(Any, builder) inst = builder.build_class( name="ooodev.adapter.frame.layout_manager_comp.LayoutManagerComp", base_class=_LayoutManagerComp, ) return inst
[docs] def __init__(self, component: Any) -> None: """ Constructor Args: component (Any): UNO Component that supports ``com.sun.star.configuration.ConfigurationAccess`` service. """ # this it not actually called as __new__ is overridden pass
# region Properties @property def component(self) -> LayoutManager: """LayoutManager Component""" # pylint: disable=no-member return cast("LayoutManager", self._ComponentBase__get_component()) # type: ignore
# endregion Properties
[docs]def get_builder(component: Any) -> DefaultBuilder: """ Get the builder for the component. Args: component (Any): The component. Returns: DefaultBuilder: Builder instance. """ builder = layout_manager2_partial.get_builder(component) builder.auto_add_interface("com.sun.star.awt.XWindowListener") builder.auto_add_interface("com.sun.star.beans.XPropertySet") builder.auto_add_interface("com.sun.star.beans.XMultiPropertySet") builder.auto_add_interface("com.sun.star.beans.XFastPropertySet") return builder