ooodev.format.calc.modify.cell.font package

Module contents

class ooodev.format.calc.modify.cell.font.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=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Bases: CellStyleBaseMulti

Style Font Effects

See also

New in version 0.9.0.

__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=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

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 (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.

  • style_family (str, optional) – Style family. Default CellStyles.

Return type:

None

See also

classmethod from_style(doc, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Gets instance from Document.

Parameters:

  • doc (object) – UNO Document Object.

  • style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.

  • style_family (str, optional) – Style family. Default CellStyles.

Returns:

FontEffects instance from document properties.

Return type:

FontEffects

property prop_inner: InnerFontEffects

Gets/Sets Inner Font Effects instance

Return type:

InnerFontEffects

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.calc.modify.cell.font.FontOnly(*, name=None, size=None, font_style=None, lang=None, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Bases: CellStyleBaseMulti

Style Font

See also

New in version 0.9.0.

__init__(*, name=None, size=None, font_style=None, lang=None, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Constructor

Parameters:

  • name (str, optional) – This property specifies the name of the font style. It may contain more than one name separated by comma.

  • size (float, optional) – This value contains the size of the characters in pt (point) units or Class UnitT.

  • font_style (str, optional) – Font style name such as Bold.

  • lang (Lang, optional) – Font Language

  • style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.

  • style_family (str, optional) – Style family. Default CellStyles.

Return type:

None

See also

classmethod from_style(doc, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Gets instance from Document.

Parameters:

  • doc (object) – UNO Document Object.

  • style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.

  • style_family (str, optional) – Style family. Default CellStyles.

Returns:

FontOnly instance from document properties.

Return type:

FontOnly

property prop_inner: InnerFontOnly

Gets/Sets Inner Font instance

Return type:

InnerFontOnly

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str