Source code for ooodev.format.inner.modify.calc.page.border.sides

# region Imports
from __future__ import annotations
from typing import Tuple, cast
import uno

from ooodev.format.inner.common.abstract.abstract_sides import AbstractSides
from ooodev.format.inner.common.props.border_props import BorderProps
from ooodev.format.inner.direct.structs.side import Side
from ooodev.format.inner.kind.format_kind import FormatKind
from ooodev.format.calc.style.page.kind.calc_style_page_kind import CalcStylePageKind
from ooodev.format.inner.modify.calc.cell_style_base_multi import CellStyleBaseMulti

# endregion Imports


[docs]class InnerSides(AbstractSides): """ Calc Page Border. Any properties starting with ``prop_`` set or get current instance values. All methods starting with ``fmt_`` can be used to chain together Sides properties. .. seealso:: - :ref:`help_calc_format_modify_page_borders` .. versionadded:: 0.9.0 """ # region methods def _supported_services(self) -> Tuple[str, ...]: try: return self._supported_services_values except AttributeError: self._supported_services_values = ("com.sun.star.style.PageStyle",) return self._supported_services_values # endregion methods # region Properties @property def prop_format_kind(self) -> FormatKind: """Gets the kind of style""" try: return self._format_kind_prop except AttributeError: self._format_kind_prop = FormatKind.PAGE | FormatKind.STYLE return self._format_kind_prop @property def _props(self) -> BorderProps: try: return self._props_internal_attributes except AttributeError: self._props_internal_attributes = BorderProps( left="LeftBorder", top="TopBorder", right="RightBorder", bottom="BottomBorder" ) return self._props_internal_attributes
# endregion Properties
[docs]class Sides(CellStyleBaseMulti): """ Page Style Border Sides. .. seealso:: - :ref:`help_calc_format_modify_page_borders` .. versionadded:: 0.9.0 """
[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: CalcStylePageKind | str = CalcStylePageKind.DEFAULT, style_family: str = "PageStyles", ) -> 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 (CalcStylePageKind, str, optional): Specifies the Page Style that instance applies to. Default is Default Page Style. style_family (str, optional): Style family. Default ``PageStyles``. Returns: None: See Also: - :ref:`help_calc_format_modify_page_borders` """ direct = InnerSides(left=left, right=right, top=top, bottom=bottom, all=all) super().__init__() self._style_name = str(style_name) self._style_family_name = style_family self._set_style("direct", direct, *direct.get_attrs())
[docs] @classmethod def from_style( cls, doc: object, style_name: CalcStylePageKind | str = CalcStylePageKind.DEFAULT, style_family: str = "PageStyles", ) -> Sides: """ Gets instance from Document. Args: doc (object): UNO Document Object. style_name (CalcStylePageKind, str, optional): Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style. style_family (str, optional): Style family. Default ``PageStyles``. Returns: Sides: ``Sides`` instance from document properties. """ inst = cls(style_name=style_name, style_family=style_family) direct = InnerSides.from_obj(inst.get_style_props(doc)) inst._set_style("direct", direct, *direct.get_attrs()) return inst
@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 | CalcStylePageKind): 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 InnerSides, got "{type(value).__name__}"') self._del_attribs("_direct_inner") self._set_style("direct", value, *value.get_attrs())