ooodev.format.writer.modify.frame.wrap package

Module contents

class ooodev.format.writer.modify.frame.wrap.Options(*, first=None, background=None, contour=None, outside=None, overlap=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Bases: FrameStyleBaseMulti

Frame Style Wrap Options.

New in version 0.9.0.

__init__(*, first=None, background=None, contour=None, outside=None, overlap=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Constructor

Parameters:

  • first (bool , optional) – Specifies first paragraph.

  • background (bool , optional) – Specifies in background.

  • contour (bool , optional) – Specifies contour.

  • outside (bool , optional) – Specifies contour outside only. contour must be True for this parameter to be effective.

  • overlap (bool , optional) – Specifies allow overlap.

  • 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:

Options instance from style properties.

Return type:

Options

property prop_inner: Options

Gets/Sets Inner Options instance

Return type:

Options

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.writer.modify.frame.wrap.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

class ooodev.format.writer.modify.frame.wrap.Spacing(*, left=None, right=None, top=None, bottom=None, all=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Bases: FrameStyleBaseMulti

Frame Style Wrap Spacing.

New in version 0.9.0.

__init__(*, left=None, right=None, top=None, bottom=None, all=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Constructor

Parameters:

  • left (float, UnitT, optional) – Left (in mm units) or Class UnitT.

  • right (float, UnitT, optional) – Right (in mm units) or Class UnitT.

  • top (float, UnitT, optional) – Top (in mm units) or Class UnitT.

  • bottom (float, UnitT, optional) – Bottom (in mm units) or Class UnitT.

  • all (float, UnitT, optional) – Left, right, top, bottom (in mm units) or Class UnitT. If argument is present then left, right, top, and bottom arguments are ignored.

  • 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:

Spacing instance from style properties.

Return type:

Spacing

property prop_inner: Spacing

Gets/Sets Inner Spacing instance

Return type:

Spacing

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str