Source code for

# region Import
from __future__ import annotations
from typing import Any, cast, Type, TypeVar
import uno
from ooo.dyn.awt.gradient_style import GradientStyle

from ooodev.format.inner.common.props.transparent_gradient_props import TransparentGradientProps
from import Gradient as InnerGradient
from ooodev.format.inner.kind.format_kind import FormatKind
from import PageStyleBaseMulti
from import WriterStylePageKind
from ooodev.units.angle import Angle
from ooodev.utils.data_type.intensity import Intensity
from ooodev.utils.data_type.intensity_range import IntensityRange
from ooodev.utils.data_type.offset import Offset

# endregion Import

_TGradient = TypeVar(name="_TGradient", bound="Gradient")

[docs]class Gradient(PageStyleBaseMulti): """ Page Header Transparent Gradient .. seealso:: - :ref:`help_writer_format_modify_page_header_transparency` .. versionadded:: 0.9.0 """
[docs] def __init__( self, *, style: GradientStyle = GradientStyle.LINEAR, offset: Offset = Offset(50, 50), angle: Angle | int = 0, border: Intensity | int = 0, grad_intensity: IntensityRange = IntensityRange(100, 100), style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD, style_family: str = "PageStyles", ) -> None: """ Constructor Args: style (GradientStyle, optional): Specifies the style of the gradient. Defaults to ``GradientStyle.LINEAR``. offset (offset, optional): Specifies the X-coordinate (start) and Y-coordinate (end), where the gradient begins. X is effectively the center of the ``RADIAL``, ``ELLIPTICAL``, ``SQUARE`` and ``RECT`` style gradients. Defaults to ``Offset(50, 50)``. angle (Angle, int, optional): Specifies angle of the gradient. Defaults to ``0``. border (int, optional): Specifies percent of the total width where just the start color is used. Defaults to ``0``. grad_intensity (IntensityRange, optional): Specifies the intensity at the start point and stop point of the gradient. Defaults to ``IntensityRange(0, 0)``. style_name (WriterStylePageKind, 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_writer_format_modify_page_header_transparency` """ direct = InnerGradient( style=style, offset=offset, angle=angle, border=border, grad_intensity=grad_intensity, _cattribs=self._get_inner_cattribs(), ) direct._prop_parent = self super().__init__() self._style_name = str(style_name) self._style_family_name = style_family self._set_style("direct", direct, *direct.get_attrs())
# region Internal Methods def _get_inner_props(self) -> TransparentGradientProps: return TransparentGradientProps( transparence="HeaderFillTransparence", name="HeaderFillTransparenceGradientName", struct_prop="HeaderFillTransparenceGradient", ) def _get_inner_cattribs(self) -> dict: return { "_supported_services_values": self._supported_services(), "_format_kind_prop": self.prop_format_kind, "_props_internal_attributes": self._get_inner_props(), } # endregion Internal Methods # region Static Methods
[docs] @classmethod def from_style( cls: Type[_TGradient], doc: Any, style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD, style_family: str = "PageStyles", ) -> _TGradient: """ Gets instance from Document. Args: doc (Any): UNO Document Object. style_name (StyleParaKind, str, optional): Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style. style_family (str, optional): Style family. Default ``PageStyles``. Returns: Gradient: ``Gradient`` instance from document properties. """ inst = cls(style_name=style_name, style_family=style_family) direct = InnerGradient.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 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.DOC | FormatKind.STYLE | FormatKind.HEADER return self._format_kind_prop @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 | WriterStylePageKind): self._style_name = str(value) @property def prop_inner(self) -> InnerGradient: """Gets/Sets Inner Gradient instance""" try: return self._direct_inner except AttributeError: self._direct_inner = cast(InnerGradient, self._get_style_inst("direct")) return self._direct_inner @prop_inner.setter def prop_inner(self, value: InnerGradient) -> None: if not isinstance(value, InnerGradient): raise TypeError(f'Expected type of InnerGradient, got "{type(value).__name__}"') self._del_attribs("_direct_inner") self._set_style("direct", value, *value.get_attrs())
# endregion Properties