ooodev.format.writer.modify.para.tabs package

Module contents

class ooodev.format.writer.modify.para.tabs.Tabs(*, position=0.0, align=TabAlign.LEFT, decimal_char='.', fill_char=FillCharKind.NONE, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Bases: ParaStyleBaseMulti

Paragraph Style Breaks

See also

New in version 0.9.0.

__init__(*, position=0.0, align=TabAlign.LEFT, decimal_char='.', fill_char=FillCharKind.NONE, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Constructor

Parameters:

  • position (float, UnitT, optional) – Specifies the position of the tabulator in relation to the left border (in mm units) or Class UnitT. Defaults to 0.0

  • align (TabAlign, optional) – Specifies the alignment of the text range before the tabulator. Defaults to TabAlign.LEFT

  • decimal_char (str, optional) – Specifies which delimiter is used for the decimal. Argument is expected to be a single character string. This argument is only used when align is set to TabAlign.DECIMAL.

  • fill_char (FillCharKind, str, optional) – specifies the character that is used to fill up the space between the text in the text range and the tabulators. If string value then argument is expected to be a single character string. Defaults to FillCharKind.NONE.

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

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

Return type:

None

See also

classmethod find(doc, position, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

_summary_

Parameters:

  • doc (object) – UNO Document Object.

  • position (float) – position of tab stop (in mm units).

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

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

Returns:

Tab instance if found; Otherwise, None

Return type:

Tabs | None

classmethod from_style(doc, index=0, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

  • index (int, optional) – Index of tab stop. Default 0.

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

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

Returns:

Tabs instance from document properties.

Return type:

Tabs

property prop_inner: Tabs

Gets/Sets Inner Tabs instance

Return type:

Tabs

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str