ooodev.format.draw.modify.font.font_effects module

Font Effects Style for Draw Documents

New in version 0.17.9.

class ooodev.format.draw.modify.font.font_effects.FontEffects(*, color=None, transparency=None, overline=None, underline=None, strike=None, word_mode=None, case=None, relief=None, outline=None, hidden=None, shadowed=None, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)

Bases: CharStyleBaseMulti

Character Style Font Effects

See also

• Draw Modify Font Effects

New in version 0.17.9.

__init__(*, color=None, transparency=None, overline=None, underline=None, strike=None, word_mode=None, case=None, relief=None, outline=None, hidden=None, shadowed=None, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)

Constructor

Parameters:

• 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.

Return type:

None

See also

• Draw Modify Font Effects

classmethod from_style(doc, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)

Gets instance from Document.

Parameters:

• 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 instance from document properties.

Return type:

FontEffects

property prop_inner: FontEffects

Gets/Sets Inner Font instance

Return type:

FontEffects

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str