ooodev.format.inner.modify.write.char.font.font_position module

class ooodev.format.inner.modify.write.char.font.font_position.FontPosition(*, script_kind=None, raise_lower=None, rel_size=None, rotation=None, scale=None, fit=None, spacing=None, pair=None, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[source]

Bases: CharStyleBaseMulti

Character Style Font Effects

New in version 0.9.0.

__init__(*, script_kind=None, raise_lower=None, rel_size=None, rotation=None, scale=None, fit=None, spacing=None, pair=None, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[source]

Constructor

Parameters:
  • script_kind (FontScriptKind, optional) – Specifies Superscript/Subscript option.

  • raise_lower (int, optional) – Specifies raise or Lower as percent value. Set to a value of 0 for automatic.

  • rel_size (int, Intensity, optional) – Specifies relative Font Size as percent value. Set this value to 0 for automatic; Otherwise value from 1 to 100.

  • rotation (int, Angle, optional) – Specifies the rotation of a character in degrees. Depending on the implementation only certain values may be allowed.

  • scale (int, optional) – Specifies scale width as percent value. Min value is 1.

  • fit (bool, optional) – Specifies if rotation is fit to line.

  • spacing (CharSpacingKind, float, UnitT, optional) – Specifies character spacing in pt (point) units or Class UnitT.

  • pair (bool, optional) – Specifies pair kerning.

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

Return type:

None

classmethod from_style(doc, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[source]

Gets instance from Document.

Parameters:
  • doc (object) – UNO Document Object.

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

FontPosition instance from document properties.

Return type:

FontPosition

property prop_inner: FontPosition

Gets/Sets Inner Font Position instance

Return type:

FontPosition

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str