ooodev.format.inner.direct.write.para.outline_list.outline module

Module for managing paragraph Outline.

New in version 0.9.0.

class ooodev.format.inner.direct.write.para.outline_list.outline.LevelKind(value)[source]

Bases: IntEnum

Outline Level

LEVEL_01 = 1
LEVEL_02 = 2
LEVEL_03 = 3
LEVEL_04 = 4
LEVEL_05 = 5
LEVEL_06 = 6
LEVEL_07 = 7
LEVEL_08 = 8
LEVEL_09 = 9
LEVEL_10 = 10
TEXT_BODY = 0
class ooodev.format.inner.direct.write.para.outline_list.outline.Outline(level=LevelKind.TEXT_BODY)[source]

Bases: StyleBase

Paragraph Outline

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

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

New in version 0.9.0.

__init__(level=LevelKind.TEXT_BODY)[source]

Constructor

Parameters:

level (LevelKind) – Outline level.

Return type:

None

apply(obj: Any)[source]
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)[source]
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:

Outline instance that represents obj break properties.

Return type:

Outline

style_above(value)[source]

Gets a copy of instance with level set.

Parameters:
  • value (LevelKind) – Level value

  • self (_TOutline) –

Returns:

Outline instance

Return type:

Spacing

property default: _TOutline

Gets Outline default.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_01: _TOutline

Gets copy of instance set to outline level 1.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_02: _TOutline

Gets copy of instance set to outline level 2.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_03: _TOutline

Gets copy of instance set to outline level 3.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_04: _TOutline

Gets copy of instance set to outline level 4.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_05: _TOutline

Gets copy of instance set to outline level 5.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_06: _TOutline

Gets copy of instance set to outline level 6.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_07: _TOutline

Gets copy of instance set to outline level 7.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_08: _TOutline

Gets copy of instance set to outline level 8.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_09: _TOutline

Gets copy of instance set to outline level 9.

Return type:

TypeVar(_TOutline, bound= Outline)

property level_10: _TOutline

Gets copy of instance set to outline level 10.

Return type:

TypeVar(_TOutline, bound= Outline)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_level: LevelKind

Gets/Sets level

Return type:

LevelKind

property text_body: _TOutline

Gets copy of instance set to outline level text body.

Return type:

TypeVar(_TOutline, bound= Outline)