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.beans.hierarchical_property_set_partial import HierarchicalPropertySetPartial
from ooodev.adapter.beans.multi_hierarchical_property_set_partial import MultiHierarchicalPropertySetPartial
from ooodev.adapter.beans.multi_property_set_partial import MultiPropertySetPartial
from ooodev.adapter.beans.property_set_partial import PropertySetPartial
from ooodev.adapter.component_prop import ComponentProp
from ooodev.utils.builder.default_builder import DefaultBuilder
if TYPE_CHECKING:
from com.sun.star.configuration import PropertyHierarchy # service
class _PropertyHierarchyComp(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.configuration.PropertyHierarchy",)
# region Properties
@property
def __class__(self):
# pretend to be a PropertyHierarchyComp class
return PropertyHierarchyComp
# endregion Properties
[docs]class PropertyHierarchyComp(
_PropertyHierarchyComp,
PropertySetPartial,
MultiPropertySetPartial,
HierarchicalPropertySetPartial,
MultiHierarchicalPropertySetPartial,
CompDefaultsPartial,
):
"""
Class for managing PropertyHierarchy 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.
"""
# pylint: disable=unused-argument
def __new__(cls, component: Any, *args, **kwargs):
builder = get_builder(component=component)
builder_helper.builder_add_comp_defaults(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.configuration.property_hierarchy_comp.PropertyHierarchyComp",
base_class=_PropertyHierarchyComp,
)
return inst
[docs] def __init__(self, component: Any) -> None:
"""
Constructor
Args:
component (Any): UNO Component that supports ``com.sun.star.configuration.PropertyHierarchy`` service.
"""
# this it not actually called as __new__ is overridden
pass
# region Properties
@property
def component(self) -> PropertyHierarchy:
"""PropertyHierarchy Component"""
# pylint: disable=no-member
return cast("PropertyHierarchy", 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 = DefaultBuilder(component)
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.XHierarchicalPropertySet")
builder.auto_add_interface("com.sun.star.beans.XMultiHierarchicalPropertySet")
return builder