Source code for

from __future__ import annotations
import uno
from ooo.dyn.awt.gradient_style import GradientStyle

from ooodev.format.inner.common.props.area_gradient_props import AreaGradientProps
from ooodev.format.inner.kind.format_kind import FormatKind
from import Gradient as HeaderGradient
from import WriterStylePageKind
from ooodev.units.angle import Angle
from ooodev.utils.color import Color
from ooodev.utils.data_type.color_range import ColorRange
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

[docs]class Gradient(HeaderGradient): """ Page Footer Gradient Color .. seealso:: - :ref:`help_writer_format_modify_page_footer_area` .. versionadded:: 0.9.0 """
[docs] def __init__( self, *, style: GradientStyle = GradientStyle.LINEAR, step_count: int = 0, offset: Offset = Offset(50, 50), angle: Angle | int = 0, border: Intensity | int = 0, grad_color: ColorRange = ColorRange(Color(0), Color(16777215)), grad_intensity: IntensityRange = IntensityRange(100, 100), name: str = "", 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``. step_count (int, optional): Specifies the number of steps of change color. Defaults to ``0``. offset (Offset, int, optional): Specifies the X and Y coordinate, 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_color (ColorRange, optional): Specifies the color at the start point and stop point of the gradient. Defaults to ``ColorRange(Color(0), Color(16777215))``. grad_intensity (IntensityRange, optional): Specifies the intensity at the start point and stop point of the gradient. Defaults to ``IntensityRange(100, 100)``. name (str, optional): Specifies the Fill Gradient Name. style_name (StyleParaKind, 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_footer_area` """ super().__init__( style=style, step_count=step_count, offset=offset, angle=angle, border=border, grad_color=grad_color, grad_intensity=grad_intensity, name=name, style_name=style_name, style_family=style_family, )
# region internal methods def _get_inner_props(self) -> AreaGradientProps: return AreaGradientProps( style="FooterFillStyle", step_count="FooterFillGradientStepCount", name="FooterFillGradientName", grad_prop_name="FooterFillGradient", ) # endregion internal 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.FOOTER return self._format_kind_prop
# endregion properties