# region Imports
from __future__ import annotations
from typing import cast
from ooodev.format.inner.direct.write.char.highlight.highlight import Highlight as InnerHighlight
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
# endregion Imports
[docs]class Highlight(CharStyleBaseMulti):
"""
Character Style Highlight.
.. seealso::
- :ref:`help_writer_format_modify_char_highlight`
.. versionadded:: 0.9.0
"""
[docs] def __init__(
self,
*,
color: Color = StandardColor.AUTO_COLOR,
style_name: StyleCharKind | str = StyleCharKind.STANDARD,
style_family: str = "CharacterStyles",
) -> None:
"""
Constructor
Args:
color (:py:data:`~.utils.color.Color`, optional): Highlight Color
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:
None:
"""
direct = InnerHighlight(color=color)
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",
) -> Highlight:
"""
Gets instance from Document.
Args:
doc (object): UNO Document Object.
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:
Highlight: ``Highlight`` instance from document properties.
See Also:
- :ref:`help_writer_format_modify_char_highlight`
"""
inst = cls(style_name=style_name, style_family=style_family)
direct = InnerHighlight.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) -> InnerHighlight:
"""Gets Inner Highlight instance"""
try:
return self._direct_inner
except AttributeError:
self._direct_inner = cast(InnerHighlight, self._get_style_inst("direct"))
return self._direct_inner
@prop_inner.setter
def prop_inner(self, value: InnerHighlight) -> None:
if not isinstance(value, InnerHighlight):
raise TypeError(f'Expected type of InnerHighlight, got "{type(value).__name__}"')
self._del_attribs("_direct_inner")
self._set_style("direct", value, *value.get_attrs())