ooodev.format.inner.modify.write.frame.wrap.settings module

class ooodev.format.inner.modify.write.frame.wrap.settings.Settings(*, mode=WrapTextMode.PARALLEL, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Bases: FrameStyleBaseMulti

Frame Style Wrap Settings.

New in version 0.9.0.

__init__(*, mode=WrapTextMode.PARALLEL, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Constructor

Parameters:

  • mode (WrapTextMode) – Specifies Wrap mode. Default WrapTextMode.PARALLEL

  • style_name (StyleFrameKind, str, optional) – Specifies the Frame Style that instance applies to. Default is Default Frame Style.

  • style_family (str, optional) – Style family. Default FrameStyles.

Return type:

None

classmethod from_style(doc, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Gets instance from Document.

Parameters:

  • doc (object) – UNO Document Object.

  • style_name (StyleFrameKind, str, optional) – Specifies the Frame Style that instance applies to. Default is Default Frame Style.

  • style_family (str, optional) – Style family. Default FrameStyles.

Returns:

Settings instance from style properties.

Return type:

Settings

property prop_inner: Settings

Gets/Sets Inner Settings instance

Return type:

Settings

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str