ooodev.format.proto.font.font_effects_t module

protocol ooodev.format.proto.font.font_effects_t.FontEffectsT[source]

Bases: StyleT, Protocol

Font Effect Protocol

Classes that implement this protocol must have the following methods / attributes:

__init__(*, color=Ellipsis, transparency=Ellipsis, overline=Ellipsis, underline=Ellipsis, strike=Ellipsis, word_mode=Ellipsis, case=Ellipsis, relief=Ellipsis, outline=Ellipsis, hidden=Ellipsis, shadowed=Ellipsis)[source]

Parameters:

color (Color | None) –
transparency (Intensity | int | None) –
overline (FontLine | None) –
underline (FontLine | None) –
strike (FontStrikeoutEnum | None) –
word_mode (bool | None) –
case (CaseMapEnum | None) –
relief (FontReliefEnum | None) –
outline (bool | None) –
hidden (bool | None) –
shadowed (bool | None) –

Return type:

None

fmt_case(value=None)[source]

Gets copy of instance with case set or removed.

Parameters:: value (CaseMapEnum, optional) – The case value. If None style is removed. Default None
Returns:: Font with style added or removed.
Return type:: FontEffectsT

Hint

CaseMapEnum can be imported from ooo.dyn.style.case_map

fmt_color(value=None)[source]

Gets copy of instance with text color set or removed.

Parameters:: value (Color, optional) – The text color. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontEffectsT

fmt_hidden(value=None)[source]

Gets copy of instance with hidden set or removed.

Parameters:: value (bool, optional) – The hidden value. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontEffectsT

fmt_outline(value=None)[source]

Gets copy of instance with outline set or removed.

Parameters:: value (bool, optional) – The outline value. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontEffectsT

fmt_overline(value=None)[source]

Gets copy of instance with overline set or removed.

Parameters:: value (FontUnderlineEnum, optional) – The size of the characters in point units. If None style is removed. Default None
Returns:: Font with style added or removed.
Return type:: FontEffectsT

Hint

FontUnderlineEnum can be imported from ooo.dyn.awt.font_underline

fmt_overline_color(value=None)[source]

Gets copy of instance with text overline color set or removed.

Parameters:: value (Color, optional) – The color is used for an overline. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontEffectsT

fmt_relief(value=None)[source]

Gets copy of instance with relief set or removed.

Parameters:: value (FontReliefEnum, optional) – The relief value. If None style is removed. Default None
Returns:: Font with style added or removed.
Return type:: FontEffectsT

Hint

FontReliefEnum can be imported from ooo.dyn.awt.font_relief

fmt_shadowed(value=None)[source]

Gets copy of instance with shadowed set or removed.

Parameters:: value (bool, optional) – The shadowed value. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontEffectsT

fmt_strike(value=None)[source]

Gets copy of instance with strike set or removed.

Parameters:: value (FontStrikeoutEnum, optional) – The type of the strike out of the character. If None style is removed. Default None
Returns:: Font with style added or removed.
Return type:: FontEffectsT

Hint

FontStrikeoutEnum can be imported from ooo.dyn.awt.font_strikeout

fmt_transparency(value=None)[source]

Gets copy of instance with text background transparency set or removed.

Parameters:: value (bool, optional) – The text background transparency. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontEffectsT

fmt_underline(value=None)[source]

Gets copy of instance with underline set or removed.

Parameters:: value (FontUnderlineEnum, optional) – The value for the character underline. If None style is removed. Default None
Returns:: Font with style added or removed.
Return type:: FontEffectsT

Hint

FontUnderlineEnum can be imported from ooo.dyn.awt.font_underline

fmt_underline_color(value=None)[source]

Gets copy of instance with text underline color set or removed.

Parameters:: value (Color, optional) – The color is used for an underline. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontEffectsT

fmt_word_mode(value=None)[source]

Gets copy of instance with word mode set or removed.

The underline and strike-through properties are not applied to white spaces when set to True.

Parameters:: value (bool, optional) – The word mode. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontEffectsT

from_obj(obj: Any) → FontEffectsT
from_obj(obj: Any, **kwargs) → FontEffectsT
from_obj(**kwds): Helper for @overload to raise when called.

__protocol_attrs__ = {'add_event_listener', 'add_event_observer', 'apply', 'backup', 'case_lower', 'case_none', 'case_small_caps', 'case_title', 'case_upper', 'color_auto', 'copy', 'default', 'fmt_case', 'fmt_color', 'fmt_hidden', 'fmt_outline', 'fmt_overline', 'fmt_overline_color', 'fmt_relief', 'fmt_shadowed', 'fmt_strike', 'fmt_transparency', 'fmt_underline', 'fmt_underline_color', 'fmt_word_mode', 'from_obj', 'get_attrs', 'get_props', 'get_update_obj', 'has_update_obj', 'hidden', 'on_applied', 'on_applying', 'on_property_backed_up', 'on_property_backing_up', 'on_property_restore_set', 'on_property_restore_setting', 'on_property_set', 'on_property_set_error', 'outline', 'overline', 'overline_color_auto', 'prop_case', 'prop_color', 'prop_format_kind', 'prop_has_attribs', 'prop_has_backup', 'prop_hidden', 'prop_outline', 'prop_overline', 'prop_parent', 'prop_relief', 'prop_shadowed', 'prop_strike', 'prop_transparency', 'prop_underline', 'prop_word_mode', 'relief_embossed', 'relief_engraved', 'relief_none', 'remove_event_listener', 'remove_event_observer', 'restore', 'set_update_obj', 'shadowed', 'strike', 'support_service', 'under_color_auto', 'underline', 'update', 'word_mode'}