ooodev.format.writer.modify.frame.options package

Module contents

class ooodev.format.writer.modify.frame.options.Align(*, adjust=VertAdjustKind.TOP, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Bases: FrameStyleBaseMulti

Frame Style Options Align.

New in version 0.9.0.

__init__(*, adjust=VertAdjustKind.TOP, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Constructor

Parameters:

  • adjust (VertAdjustKind) – Specifies Vertical Adjustment. Default VertAdjustKind.TOP

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

Align instance from style properties.

Return type:

Align

property prop_inner: Align

Gets/Sets Inner Align instance

Return type:

Align

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.writer.modify.frame.options.Properties(*, editable=None, printable=None, txt_direction=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Bases: FrameStyleBaseMulti

Frame Style Options Properties.

New in version 0.9.0.

__init__(*, editable=None, printable=None, txt_direction=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Constructor

Parameters:

  • editable (bool, optional) – Specifies if Frame is editable in read-only document.

  • printable (bool, optional) – Specifies if Frame can be printed.

  • txt_direction (TextDirectionKind, optional) – Specifies text direction.

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

Properties instance from style properties.

Return type:

Properties

property prop_inner: Properties

Gets/Sets Inner Properties instance

Return type:

Properties

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.writer.modify.frame.options.Protect(*, size=None, position=None, content=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Bases: FrameStyleBaseMulti

Frame Style Options Protect.

New in version 0.9.0.

__init__(*, size=None, position=None, content=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Constructor

Parameters:

  • size (bool, optional) – Specifies size protection.

  • position (bool, optional) – Specifies position protection.

  • content (bool, optional) – Specifies content protection.

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

Protect instance from style properties.

Return type:

Protect

property prop_inner: Protect

Gets/Sets Inner Protect instance

Return type:

Protect

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str