Source code for ooodev.format.inner.modify.write.frame.border.sides

# region Imports
from __future__ import annotations
from typing import cast
import uno
from ooodev.format.inner.direct.structs.side import Side
from ooodev.format.inner.modify.write.frame.frame_style_base_multi import FrameStyleBaseMulti
from ooodev.format.writer.style.frame.style_frame_kind import StyleFrameKind
from ooodev.format.inner.direct.write.para.border.sides import Sides as InnerSides

# endregion Imports


[docs]class Sides(FrameStyleBaseMulti): """ Frame Style Border Shadow. .. versionadded:: 0.9.0 """ # region Init
[docs] def __init__( self, *, left: Side | None = None, right: Side | None = None, top: Side | None = None, bottom: Side | None = None, all: Side | None = None, style_name: StyleFrameKind | str = StyleFrameKind.FRAME, style_family: str = "FrameStyles", ) -> None: """ Constructor Args: left (Side | None, optional): Determines the line style at the left edge. right (Side | None, optional): Determines the line style at the right edge. top (Side | None, optional): Determines the line style at the top edge. bottom (Side | None, optional): Determines the line style at the bottom edge. all (Side | None, optional): Determines the line style at the top, bottom, left, right edges. If this argument has a value then arguments ``top``, ``bottom``, ``left``, ``right`` are ignored style_name (StyleFrameKind, str, optional): Specifies the Frame Style that instance applies to. Default is Default Frame Style. style_family (str, optional): Style family. Default ``FrameStyles``. Returns: None: """ direct = InnerSides( left=left, right=right, top=top, bottom=bottom, all=all, _cattribs=self._get_inner_cattribs() ) super().__init__() self._style_name = str(style_name) self._style_family_name = style_family self._set_style("direct", direct, *direct.get_attrs())
# endregion Init # region Static Methods
[docs] @classmethod def from_style( cls, doc: object, style_name: StyleFrameKind | str = StyleFrameKind.FRAME, style_family: str = "FrameStyles", ) -> Sides: """ Gets instance from Document. Args: doc (object): UNO Document Object. style_name (StyleFrameKind, str, optional): Specifies the Frame Style that instance applies to. Default is Default Frame Style. style_family (str, optional): Style family. Default ``FrameStyles``. Returns: Sides: ``Sides`` instance from style properties. """ inst = cls(style_name=style_name, style_family=style_family) direct = InnerSides.from_obj(obj=inst.get_style_props(doc), _cattribs=inst._get_inner_cattribs()) inst._set_style("direct", direct, *direct.get_attrs()) return inst
# endregion Static Methods # region internal methods def _get_inner_cattribs(self) -> dict: return { "_format_kind_prop": self.prop_format_kind, "_supported_services_values": self._supported_services(), } # endregion internal methods # region Properties @property def prop_style_name(self) -> str: """Gets/Sets property Style Name""" return self._style_name @prop_style_name.setter def prop_style_name(self, value: str | StyleFrameKind): self._style_name = str(value) @property def prop_inner(self) -> InnerSides: """Gets/Sets Inner Sides instance""" try: return self._direct_inner except AttributeError: self._direct_inner = cast(InnerSides, self._get_style_inst("direct")) return self._direct_inner @prop_inner.setter def prop_inner(self, value: InnerSides) -> None: if not isinstance(value, InnerSides): raise TypeError(f'Expected type of InnerTransparency, got "{type(value).__name__}"') direct = value.copy(_cattribs=self._get_inner_cattribs()) self._del_attribs("_direct_inner") self._set_style("direct", direct, *direct.get_attrs())
# endregion Properties