from __future__ import annotations
from typing import Any, TYPE_CHECKING
from com.sun.star.beans import XPropertyContainer
# com.sun.star.beans.PropertyAttribute
from ooo.dyn.beans.property_attribute import PropertyAttributeEnum
from ooodev.exceptions import ex as mEx
from ooodev.loader import lo as mLo
if TYPE_CHECKING:
from ooodev.utils.type_var import UnoInterface
[docs]class PropertyContainerPartial:
"""
Partial class for XPropertyContainer.
"""
[docs] def __init__(self, component: XPropertyContainer, interface: UnoInterface | None = XPropertyContainer) -> None:
"""
Constructor
Args:
component (XPropertyContainer): UNO Component that implements ``com.sun.star.container.XPropertyContainer`` interface.
interface (UnoInterface, optional): The interface to be validated. Defaults to ``XPropertyContainer``.
"""
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 XPropertyContainer
[docs] def add_property(self, name: str, attributes: PropertyAttributeEnum, value: Any) -> None:
"""
Adds a property to the container.
Args:
name (str): The name of the property.
attributes (PropertyAttributeEnum): The attributes of the property.
Flags enum, this is a combination of ``com.sun.star.beans.PropertyAttribute``.
value (Any): The value of the property.
"""
self.__component.addProperty(name, attributes.value, value)
[docs] def remove_property(self, name: str) -> None:
"""
Removes a property from the container.
Args:
name (str): The name of the property.
"""
self.__component.removeProperty(name)
# endregion XPropertyContainer