ooodev.format.writer.direct.frame.type package
Module contents
- class ooodev.format.writer.direct.frame.type.Anchor(anchor=uno.Enum)[source]
Bases:
StyleBase
Anchor Position Class.
New in version 0.9.0.
- __init__(anchor=uno.Enum)[source]
Constructor
- Parameters:
anchor (AnchorKind) – Specifies the anchor position. Default is
AnchorKind.AT_PARAGRAPH
- Return type:
None
- classmethod from_obj(obj)[source]
- classmethod from_obj(obj, **kwargs)
- classmethod from_obj(obj, **kwargs)
Gets instance from object
- Parameters:
obj (object) – UNO Object.
- Returns:
Instance that represents Frame Anchor Position.
- Return type:
- property prop_anchor: AnchorKind
Gets/Sets Anchor position
- Return type:
- property prop_format_kind: FormatKind
Gets the kind of style
- Return type:
- class ooodev.format.writer.direct.frame.type.Position(*, horizontal=None, vertical=None, keep_boundaries=None, mirror_even=None)[source]
Bases:
StyleBase
Fill Transparency
New in version 0.9.0.
- __init__(*, horizontal=None, vertical=None, keep_boundaries=None, mirror_even=None)[source]
Constructor
- Parameters:
horizontal (Horizontal, optional) – Specifies the Horizontal position options. Not used when Anchor is set to
As Character
.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. Not used when Anchor is set to
As Character
.
- Return type:
None
- copy()[source]
- copy(**kwargs)
- copy(**kwargs)
Gets a copy of instance as a new instance
- Return type:
TypeVar
(_TPosition
, bound= Position)- Parameters:
self (_TPosition) –
- classmethod from_obj(obj)[source]
- classmethod from_obj(obj, **kwargs)
- classmethod from_obj(obj, **kwargs)
Gets instance from object
- Parameters:
obj (object) – UNO Object.
- Returns:
Instance that represents Frame Position.
- Return type:
- property prop_format_kind: FormatKind
Gets the kind of style
- Return type:
- property prop_horizontal: Horizontal | None
Gets/Sets horizontal value
- Return type:
Horizontal | None
- property prop_keep_boundaries: bool | None
Gets/Sets keep inside text boundaries
- Return type:
bool | None
- property prop_mirror_even: bool | None
Gets/Sets Mirror on even pages
- Return type:
bool | None
- class ooodev.format.writer.direct.frame.type.Size(width=None, height=None, auto_width=False, auto_height=False)[source]
Bases:
Size
Frame Type Size
New in version 0.9.0.
- __init__(width=None, height=None, auto_width=False, auto_height=False)[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
.
- Return type:
None
- apply(obj: Any)[source]
- apply(obj, **kwargs)
Applies style of current instance.
- Parameters:
obj (object) – UNO Object that styles are to be applied.
- Return type:
None
- copy()[source]
- copy(**kwargs)
- copy(**kwargs)
Gets a copy of instance as a new instance
- Return type:
TypeVar
(_TSize
, bound= Size)- Parameters:
self (_TSize) –
- classmethod from_obj(obj)[source]
- classmethod from_obj(obj, **kwargs)
- classmethod from_obj(obj, **kwargs)
Gets instance from object
- Parameters:
obj (object) – UNO Object.
- Returns:
Instance that represents Frame size.
- Return type:
- property prop_auto_height: bool
Gets/Sets auto height.
- Return type:
bool
- property prop_auto_width: bool
Gets/Sets auto width.
- Return type:
bool
- property prop_format_kind: FormatKind
Gets the kind of style
- Return type:
- property prop_height: RelativeSize | AbsoluteSize | None
Gets/Sets height.
- Return type:
RelativeSize | AbsoluteSize | None
- property prop_width: RelativeSize | AbsoluteSize | None
Gets/Sets width.
- Return type:
RelativeSize | AbsoluteSize | None