# region Imports
from __future__ import annotations
from typing import cast, TYPE_CHECKING
from ooo.dyn.table.shadow_location import ShadowLocation
from ooodev.format.inner.direct.write.char.border.shadow import Shadow as InnerShadow
from ooodev.format.inner.modify.write.char.char_style_base_multi import CharStyleBaseMulti
from ooodev.format.writer.style.char.kind.style_char_kind import StyleCharKind
from ooodev.utils.color import Color
from ooodev.utils.color import StandardColor
if TYPE_CHECKING:
from ooodev.units.unit_obj import UnitT
# endregion Imports
[docs]class Shadow(CharStyleBaseMulti):
"""
Character Style Border padding.
.. seealso::
- :ref:`help_writer_format_modify_char_borders`
.. versionadded:: 0.9.0
"""
[docs] def __init__(
self,
*,
location: ShadowLocation = ShadowLocation.BOTTOM_RIGHT,
color: Color = StandardColor.GRAY,
transparent: bool = False,
width: float | UnitT = 1.76,
style_name: StyleCharKind | str = StyleCharKind.STANDARD,
style_family: str = "CharacterStyles",
) -> None:
"""
Constructor
Args:
location (ShadowLocation, optional): contains the location of the shadow. Default to ``ShadowLocation.BOTTOM_RIGHT``.
color (:py:data:`~.utils.color.Color`, optional):contains the color value of the shadow. Defaults to ``StandardColor.GRAY``.
transparent (bool, optional): Shadow transparency. Defaults to False.
width (float, UnitT, optional): contains the size of the shadow (in ``mm`` units) or :ref:`proto_unit_obj`. Defaults to ``1.76``.
style_name (StyleCharKind, str, optional): Specifies the Character Style that instance applies to. Default is Default Character Style.
style_family (str, optional): Style family. Default ``CharacterStyles``.
Returns:
None:
See Also:
- :ref:`help_writer_format_modify_char_borders`
"""
direct = InnerShadow(location=location, color=color, transparent=transparent, width=width)
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: StyleCharKind | str = StyleCharKind.STANDARD,
style_family: str = "CharacterStyles",
) -> Shadow:
"""
Gets instance from Document.
Args:
doc (object): UNO Document Object.
style_name (StyleParaKind, str, optional): Specifies the Character Style that instance applies to. Default is Default Character Style.
style_family (str, optional): Style family. Default ``CharacterStyles``.
Returns:
Shadow: ``Shadow`` instance from document properties.
"""
inst = cls(style_name=style_name, style_family=style_family)
direct = InnerShadow.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 | StyleCharKind):
self._style_name = str(value)
@property
def prop_inner(self) -> InnerShadow:
"""Gets/Sets Inner Shadow instance"""
try:
return self._direct_inner
except AttributeError:
self._direct_inner = cast(InnerShadow, self._get_style_inst("direct"))
return self._direct_inner
@prop_inner.setter
def prop_inner(self, value: InnerShadow) -> None:
if not isinstance(value, InnerShadow):
raise TypeError(f'Expected type of InnerShadow, got "{type(value).__name__}"')
self._del_attribs("_direct_inner")
self._set_style("direct", value, *value.get_attrs())