ooodev.format.inner.modify.write.para.outline_list.list_style module

class ooodev.format.inner.modify.write.para.outline_list.list_style.InnerListStyle(list_style=None)[source]

Bases: StyleBase

Style Paragraph ListStyle

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

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

New in version 0.9.0.

__init__(list_style=None)[source]

Constructor

Parameters:

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

Return type:

None

apply(obj: Any)[source]
apply(obj: Any, **kwargs)
apply(obj, **kwargs)

Applies break properties to obj

Parameters:

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

Return type:

None

fmt_list_style(value)[source]

Gets a copy of instance with before list style set or removed

Parameters:
  • value (str, StyleListKind, None) – List style value.

  • self (_TInnerListStyle) –

Returns:

List Style instance

Return type:

DirectListStyle

classmethod from_obj(obj)[source]

Gets instance from object

Parameters:

obj (Any) – UNO object.

Raises:

NotSupportedError – If obj is not supported.

Returns:

DirectListStyle instance that represents obj properties.

Return type:

DirectListStyle

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_list_style: str | None

Gets/Sets List Style

Return type:

str | None

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

Bases: ParaStyleBaseMulti

Paragraph List Style

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

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