# region Import
from __future__ import annotations
from typing import Any, Tuple, cast, Type, TypeVar
from ooodev.format.inner.common.abstract.abstract_fill_color import AbstractColor
from ooodev.format.inner.common.props.fill_color_props import FillColorProps
from ooodev.format.inner.kind.format_kind import FormatKind
from ooodev.format.inner.modify.write.page.page_style_base_multi import PageStyleBaseMulti
from ooodev.format.writer.style.page.kind.writer_style_page_kind import WriterStylePageKind
from ooodev.utils import color as mColor
# endregion Import
_TColor = TypeVar("_TColor", bound="Color")
[docs]class InnerColor(AbstractColor):
"""
Inner Fill Coloring
.. versionadded:: 0.9.0
"""
def _supported_services(self) -> Tuple[str, ...]:
try:
return self._supported_services_values
except AttributeError:
self._supported_services_values = ("com.sun.star.style.PageProperties", "com.sun.star.style.PageStyle")
return self._supported_services_values
@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 _props(self) -> FillColorProps:
try:
return self._props_internal_attributes
except AttributeError:
self._props_internal_attributes = FillColorProps(color="FooterFillColor", style="FooterFillStyle")
return self._props_internal_attributes
[docs]class Color(PageStyleBaseMulti):
"""
Page Header Color
.. seealso::
- :ref:`help_writer_format_modify_page_header_area`
.. versionadded:: 0.9.0
"""
[docs] def __init__(
self,
*,
color: mColor.Color = mColor.StandardColor.AUTO_COLOR,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> None:
"""
Constructor
Args:
color (:py:data:`~.utils.color.Color`, optional): Header Area Color.
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_area`
"""
direct = InnerColor(color=color, _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())
# region internal methods
def _get_inner_props(self) -> FillColorProps:
return FillColorProps(color="HeaderFillColor", style="HeaderFillStyle")
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[_TColor],
doc: Any,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> _TColor:
"""
Gets instance from Document.
Args:
doc (Any): UNO Document Object.
style_name (WriterStylePageKind, str, optional): Specifies the Paragraph Style that instance applies to.
Default is Default Paragraph Style.
style_family (str, optional): Style family. Default ``PageStyles``.
Returns:
Color: ``Color`` instance from document properties.
"""
inst = cls(style_name=style_name, style_family=style_family)
direct = InnerColor.from_obj(inst.get_style_props(doc), _cattribs=inst._get_inner_cattribs())
inst._set_style("direct", direct, *direct.get_attrs())
return inst
# endregion Static Methods
@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) -> InnerColor:
"""Gets/Sets Inner Color instance"""
try:
return self._direct_inner
except AttributeError:
self._direct_inner = cast(InnerColor, self._get_style_inst("direct"))
return self._direct_inner
@prop_inner.setter
def prop_inner(self, value: InnerColor) -> None:
if not isinstance(value, InnerColor):
raise TypeError(f'Expected type of InnerColor, got "{type(value).__name__}"')
self._del_attribs("_direct_inner")
cp = value.copy(_cattribs=self._get_inner_cattribs())
self._set_style("direct", cp, *cp.get_attrs())