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.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.adapter.beans import property_with_state_partial
from ooodev.adapter.container import child_partial
from ooodev.adapter.lang import component_partial
from ooodev.adapter.configuration import template_instance_partial
from ooodev.utils.builder.default_builder import DefaultBuilder
from ooodev.adapter.configuration import hierarchy_element_comp
if TYPE_CHECKING:
from com.sun.star.configuration import SetElement # service
class _SetElementComp(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.SetElement",)
# region Properties
@property
def __class__(self): # type: ignore
# pretend to be a SetElementComp class
return SetElementComp
# endregion Properties
[docs]class SetElementComp(
_SetElementComp,
property_with_state_partial.PropertyWithStatePartial,
child_partial.ChildPartial,
component_partial.ComponentPartial,
template_instance_partial.TemplateInstancePartial,
CompDefaultsPartial,
):
"""
Class for managing SetElement 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.
"""
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.set_element_comp.SetElementComp",
base_class=_SetElementComp,
)
return inst
# pylint: disable=unused-argument
[docs] def __init__(self, component: Any) -> None:
"""
Constructor
Args:
component (Any): UNO Component that supports ``com.sun.star.configuration.SetElement`` service.
"""
# this it not actually called as __new__ is overridden
pass
# region Properties
@property
@override
def component(self) -> SetElement:
"""SetElement Component"""
# pylint: disable=no-member
return cast("SetElement", 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.merge(hierarchy_element_comp.get_builder(component), make_optional=True)
builder.auto_add_interface("com.sun.star.container.XChild")
builder.auto_add_interface("com.sun.star.lang.XComponent")
builder.auto_add_interface("com.sun.star.configuration.XTemplateInstance")
return builder