ooodev.format.proto.font.highlight_t module

protocol ooodev.format.proto.font.highlight_t.HighlightT[source]

Bases: StyleT, Protocol

Font Highlight Protocol

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

__init__(color=Ellipsis)[source]

Constructor

Parameters:

color (Color, optional) – Highlight Color. A value of -1 Set color to Transparent.

Return type:

None

fmt_color(value)[source]

Gets copy of instance with color set.

Parameters:

value (Color) – color value. If value is less than zero it means no color.

Returns:

Highlight instance

Return type:

HighlightT

from_obj(obj: Any) HighlightT
from_obj(obj: Any, **kwargs) HighlightT
from_obj(**kwds)

Helper for @overload to raise when called.

__protocol_attrs__ = {'add_event_listener', 'add_event_observer', 'apply', 'backup', 'copy', 'empty', 'fmt_color', 'from_obj', 'get_attrs', 'get_props', 'get_update_obj', 'has_update_obj', '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', 'prop_color', 'prop_format_kind', 'prop_has_attribs', 'prop_has_backup', 'prop_parent', 'remove_event_listener', 'remove_event_observer', 'restore', 'set_update_obj', 'support_service', 'update'}
property empty: HighlightT

Gets Highlight empty.

Return type:

HighlightT

property prop_color: Color

Gets/Sets color

Return type:

NewType()(Color, int)