ooodev.format.writer.modify.para.outline_list package

Module contents

class ooodev.format.writer.modify.para.outline_list.LineNum(*, num_start=0, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Bases: ParaStyleBaseMulti

Paragraph Style Line Number

See also

New in version 0.9.0.

__init__(*, num_start=0, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Constructor

Parameters:

  • num_start (int, optional) – Restart paragraph with number. If 0 then this paragraph is include in line numbering. If -1 then this paragraph is excluded in line numbering. If greater than zero this paragraph is included in line numbering and the numbering is restarted with value of num_start.

  • 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 from_style(doc, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

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

LineNum instance from document properties.

Return type:

LineNum

property prop_inner: InnerLineNum

Gets/Sets Inner Line Number instance

Return type:

InnerLineNum

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.writer.modify.para.outline_list.ListStyle(*, list_style=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Bases: ParaStyleBaseMulti

Paragraph List Style

See also

New in version 0.9.0.

__init__(*, list_style=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Constructor

Parameters:

  • list_style (str, StyleListKind, optional) – List Style.

  • 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 from_style(doc, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

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

ListStyle instance from document properties.

Return type:

ListStyle

property prop_inner: InnerListStyle

Gets/Sets Inner List Style instance

Return type:

InnerListStyle

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.writer.modify.para.outline_list.Outline(*, level=LevelKind.TEXT_BODY, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Bases: ParaStyleBaseMulti

Paragraph Style Outline

See also

New in version 0.9.0.

__init__(*, level=LevelKind.TEXT_BODY, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Constructor

Parameters:

  • level (LevelKind) – Outline level.

  • 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 from_style(doc, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

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

Outline instance from document properties.

Return type:

Outline

property prop_inner: Outline

Gets/Sets Inner Outline instance

Return type:

Outline

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str