ooodev.format.writer.direct.para.tabs package

Module contents

class ooodev.format.writer.direct.para.tabs.Tabs(*, position=0.0, align=TabAlign.LEFT, decimal_char='.', fill_char=FillCharKind.NONE)[source]

Bases: TabStopStruct

Paragraph Tabs

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together properties.

See also

New in version 0.9.0.

__init__(*, position=0.0, align=TabAlign.LEFT, decimal_char='.', fill_char=FillCharKind.NONE)[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

Return type:

None

Note

If argument type is None then all other argument are ignored

See also

classmethod find(obj: Any, position: float) → _TTabs | None[source]
classmethod find(obj: Any, position: float, **kwargs) → _TTabs | None
classmethod find(obj, position, **kwargs)

Gets a Tab that matches position from obj such as a cursor.

Parameters:

  • obj (object) – UNO Object.

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

Returns:

Tab instance if found; Otherwise, None

Return type:

Tab | None

get_uno_struct()[source]

Gets tab stop for instance

Returns:

Tab stop instance

Return type:

TabStop

classmethod remove(obj: Any, tab: TabStop | TabStopStruct) → bool[source]
classmethod remove(obj: Any, tab: TabStop | TabStopStruct, **kwargs) → bool
classmethod remove(obj, tab, **kwargs)

Removes a Tab Stop from obj ParaTabStops property.

Parameters:

  • obj (object) – Object that supports com.sun.star.style.ParagraphProperties

  • tab (TabStop | Tab) – Tab or Tab Stop to remove.

Returns:

True if a Tab has been removed; Otherwise, False

Return type:

bool

classmethod remove_all(obj)[source]
classmethod remove_all(obj, **kwargs)
classmethod remove_all(obj, **kwargs)

Removes all tab from obj ParaTabStops property.

Parameters:

obj (object) – UNO Object.

Return type:

None

classmethod remove_by_pos(obj, position)[source]
classmethod remove_by_pos(obj, position, **kwargs)
classmethod remove_by_pos(obj, position, **kwargs)

Removes a Tab Stop from obj

Parameters:

  • obj (object) – Object that supports com.sun.star.style.ParagraphProperties

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

Returns:

True if a Tab Stop has been removed; Otherwise, False

Return type:

bool

default