ooodev.format.writer.modify.para.text_flow package

Module contents

class ooodev.format.writer.modify.para.text_flow.Breaks(*, type=None, style=None, num=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Bases: ParaStyleBaseMulti

Paragraph Style Breaks

See also

New in version 0.9.0.

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

Constructor

Parameters:

  • type (BreakType, optional) – Break type.

  • style (str, optional) – Style to apply to break.

  • num (int, optional) – Page number to apply to break.

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

Breaks instance from document properties.

Return type:

Breaks

property prop_inner: Breaks

Gets/Sets Inner Breaks instance

Return type:

Breaks

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.writer.modify.para.text_flow.FlowOptions(*, orphans=None, widows=None, keep=None, no_split=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Bases: ParaStyleBaseMulti

Paragraph Style Flow Options

See also

New in version 0.9.0.

__init__(*, orphans=None, widows=None, keep=None, no_split=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Constructor

Parameters:

  • orphans (int, optional) – Number of Orphan Control Lines.

  • widows (int, optional) – Number Widow Control Lines.

  • keep (bool, optional) – Keep with next paragraph.

  • no_split (bool, optional) – Do not split paragraph.

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

Breaks instance from document properties.

Return type:

Breaks

property prop_inner: FlowOptions

Gets/Sets Inner Flow Options instance

Return type:

FlowOptions

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.writer.modify.para.text_flow.Hyphenation(*, auto=None, no_caps=None, start_chars=None, end_chars=None, max=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Bases: ParaStyleBaseMulti

Paragraph Style Hyphenation

See also

New in version 0.9.0.

__init__(*, auto=None, no_caps=None, start_chars=None, end_chars=None, max=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]

Constructor

Parameters:

  • auto (bool, optional) – Hyphenate automatically.

  • no_caps (bool, optional) – Don’t hyphenate word in caps.

  • start_chars (int, optional) – Characters at line begin.

  • end_chars (int, optional) – characters at line end.

  • max (int, optional) – Maximum consecutive hyphenated lines.

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

Breaks instance from document properties.

Return type:

Breaks

property prop_inner: Hyphenation

Gets/Sets Inner Hyphenation instance

Return type:

Hyphenation

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str