ooodev.format.writer.modify.frame.type package
Module contents
- class ooodev.format.writer.modify.frame.type.Anchor(*, anchor=AnchorKind.AT_PARAGRAPH, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Bases:
FrameStyleBaseMulti
Frame Style Type Anchor Position.
New in version 0.9.0.
- __init__(*, anchor=AnchorKind.AT_PARAGRAPH, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Constructor
- Parameters:
anchor (AnchorKind) – Specifies the anchor position. Default is
AnchorKind.AT_PARAGRAPH
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:
Anchor
instance from style properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str
- class ooodev.format.writer.modify.frame.type.Position(*, horizontal=None, vertical=None, keep_boundaries=None, mirror_even=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Bases:
FrameStyleBaseMulti
Frame Style Type position.
New in version 0.9.0.
- __init__(*, horizontal=None, vertical=None, keep_boundaries=None, mirror_even=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Constructor
- Parameters:
horizontal (Horizontal, optional) – Specifies the Horizontal position options.
vertical (Vertical, optional) – Specifies the Vertical position options.
keep_boundaries (bool, optional) – Specifies keep inside text boundaries.
mirror_even (bool, optional) – Specifies mirror on even pages.
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:
Position
instance from style properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str
- class ooodev.format.writer.modify.frame.type.Size(*, width=None, height=None, auto_width=False, auto_height=False, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Bases:
FrameStyleBaseMulti
Frame Style Type size.
New in version 0.9.0.
- __init__(*, width=None, height=None, auto_width=False, auto_height=False, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Constructor
- Parameters:
width (RelativeSize, AbsoluteSize, optional) – width value.
height (RelativeSize, AbsoluteSize, optional) – height value.
auto_width (bool, optional) – Auto Size Width. Default
False
.auto_height (bool, optional) – Auto Size Height. Default
False
.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:
Size
instance from style properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str