ooodev.format.inner.direct.write.para.text_flow.text_flow module

Module for managing paragraph Text Flow.

New in version 0.9.0.

class ooodev.format.inner.direct.write.para.text_flow.text_flow.TextFlow(*, hy_auto=None, hy_no_caps=None, hy_start_chars=None, hy_end_chars=None, hy_max=None, bk_type=None, bk_style=None, bk_num=None, op_orphans=None, op_widows=None, op_keep=None, op_no_split=None)

Bases: StyleMulti

Paragraph Text Flow

See also

• Write Direct Paragraph Text Flow

New in version 0.9.0.

__init__(*, hy_auto=None, hy_no_caps=None, hy_start_chars=None, hy_end_chars=None, hy_max=None, bk_type=None, bk_style=None, bk_num=None, op_orphans=None, op_widows=None, op_keep=None, op_no_split=None)

Constructor

Parameters:

• hy_auto (bool, optional) – Hyphenate automatically.

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

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

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

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

• bk_type (Any, optional) – Break type.

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

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

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

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

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

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

Return type:

None

Note

Arguments starting with hy_ are for hyphenation

Arguments starting with bk_ are for Breaks

Arguments starting with op_ are for Flow options

See also

• Write Direct Paragraph Text Flow

classmethod from_obj(obj)

classmethod from_obj(obj, **kwargs)

classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:

obj (object) – UNO object.

Raises:

NotSupportedError – If obj is not supported.

Returns:

TextFlow instance that represents obj Indents and spacing.

Return type:

TextFlow

property default: _TTextFlow

Gets TextFlow default.

Return type:

TypeVar(_TTextFlow, bound= TextFlow)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_inner_breaks: Breaks | None

Gets Breaks instance

Return type:

Breaks | None

property prop_inner_flow_options: FlowOptions | None

Gets Flow Options instance

Return type:

FlowOptions | None

property prop_inner_hyphenation: Hyphenation | None

Gets Hyphenation instance

Return type:

Hyphenation | None