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

Module for managing paragraph breaks.

New in version 0.9.0.

class ooodev.format.inner.direct.write.para.text_flow.breaks.Breaks(*, type=None, style=None, num=None)

Bases: StyleBase

Paragraph Breaks

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

See also

• Write Direct Paragraph Text Flow

New in version 0.9.0.

__init__(*, type=None, style=None, num=None)

Constructor

Parameters:

• type (BreakType, optional) – Break type.

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

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

Return type:

None

Note

If argument type is None then all other argument are ignored

See also

• Write Direct Paragraph Text Flow

apply(obj: Any)

apply(obj: Any, **kwargs)

apply(obj, **kwargs)

Applies break properties to obj

Parameters:

obj (object) – UNO object that supports com.sun.star.style.ParagraphProperties service.

Return type:

None

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:

Breaks instance that represents obj break properties.

Return type:

Breaks

property default: _TBreaks

Gets Breaks default.

Return type:

TypeVar(_TBreaks, bound= Breaks)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_num: int | None

Gets Page number to apply to break

Return type:

int | None

property prop_style: str | None

Gets Break Style

Return type:

str | None

property prop_type: BreakType | None

Gets break type

Return type:

BreakType | None