Source code for ooodev.format.draw.modify.font.font_effects

Font Effects Style for Draw Documents

.. versionadded:: 0.17.9
# region Imports
from __future__ import annotations
from typing import cast, Any
import uno

from ooo.dyn.awt.font_relief import FontReliefEnum
from ooo.dyn.awt.font_strikeout import FontStrikeoutEnum
from import CaseMapEnum

from import DrawStyleFamilyKind
from import FamilyGraphics
from import FontEffects as InnerFontEffects
from import FontLine
from ooodev.format.inner.modify.draw.char_style_base_multi import CharStyleBaseMulti
from ooodev.utils.color import Color
from ooodev.utils.data_type.intensity import Intensity

# endregion Imports

[docs]class FontEffects(CharStyleBaseMulti): """ Character Style Font Effects .. seealso:: - :ref:`help_draw_format_modify_font_font_effects` .. versionadded:: 0.17.9 """
[docs] def __init__( self, *, color: Color | None = None, transparency: Intensity | int | None = None, overline: FontLine | None = None, underline: FontLine | None = None, strike: FontStrikeoutEnum | None = None, word_mode: bool | None = None, case: CaseMapEnum | None = None, relief: FontReliefEnum | None = None, outline: bool | None = None, hidden: bool | None = None, shadowed: bool | None = None, style_name: str = FamilyGraphics.DEFAULT_DRAWING_STYLE, style_family: str | DrawStyleFamilyKind = DrawStyleFamilyKind.GRAPHICS, ) -> None: """ Constructor Args: color (:py:data:`~.utils.color.Color`, optional): The value of the text color. If value is ``-1`` the automatic color is applied. transparency (Intensity, int, optional): The transparency value from ``0`` to ``100`` for the font color. overline (FontLine, optional): Character overline values. underline (FontLine, optional): Character underline values. strike (FontStrikeoutEnum, optional): Determines the type of the strike out of the character. word_mode(bool, optional): If ``True``, the underline and strike-through properties are not applied to white spaces. case (CaseMapEnum, optional): Specifies the case of the font. relief (FontReliefEnum, optional): Specifies the relief of the font. outline (bool, optional): Specifies if the font is outlined. hidden (bool, optional): Specifies if the font is hidden. shadowed (bool, optional): Specifies if the characters are formatted and displayed with a shadow effect. style_name (FamilyGraphics, str, optional): Specifies the Style that instance applies to. Default is Default ``standard`` Style. style_family (str, DrawStyleFamilyKind, optional): Family Style. Defaults to ``graphics``. Returns: None: See Also: - :ref:`help_draw_format_modify_font_font_effects` """ direct = InnerFontEffects( color=color, transparency=transparency, overline=overline, underline=underline, strike=strike, word_mode=word_mode, case=case, relief=relief, outline=outline, hidden=hidden, shadowed=shadowed, ) super().__init__() self._style_name = str(style_name) self._style_family_name = str(style_family) self._set_style("direct", direct)
[docs] @classmethod def from_style( cls, doc: Any, style_name: str = FamilyGraphics.DEFAULT_DRAWING_STYLE, style_family: str | DrawStyleFamilyKind = DrawStyleFamilyKind.GRAPHICS, ) -> FontEffects: """ Gets instance from Document. Args: doc (Any): UNO Document Object. style_name (FamilyGraphics, str, optional): Specifies the Style that instance applies to. Default is ``FamilyGraphics.DEFAULT_DRAWING_STYLE``. style_family (DrawStyleFamilyKind, str, optional): Style family. Default ``DrawStyleFamilyKind.GRAPHICS``. Returns: FontEffects: ``FontEffects`` instance from document properties. """ inst = cls(style_name=style_name, style_family=style_family) direct = InnerFontEffects.from_obj(inst.get_style_props(doc)) inst._set_style("direct", direct) 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 | FamilyGraphics): self._style_name = str(value) @property def prop_inner(self) -> InnerFontEffects: """Gets/Sets Inner Font instance""" try: return self._direct_inner except AttributeError: self._direct_inner = cast(InnerFontEffects, self._get_style_inst("direct")) return self._direct_inner @prop_inner.setter def prop_inner(self, value: InnerFontEffects) -> None: if not isinstance(value, InnerFontEffects): raise TypeError(f'Expected type of InnerFontEffects, got "{type(value).__name__}"') self._del_attribs("_direct_inner") self._set_style("direct", value, *value.get_attrs())