ooodev.format.writer.direct.obj.options package

Module contents

class ooodev.format.writer.direct.obj.options.Names(*, name=None, desc=None, alt=None)[source]

Bases: Names

Image Options Names

__init__(*, name=None, desc=None, alt=None)[source]

Constructor

Parameters:

name (str, optional) – Specifies name.
desc (str, optional) – Specifies description.
alt (str, optional) – Specifies alternative text.
prev (str, optional) – Specifies previous link.
next (str, optional) – Specifies next link.

Return type:

None

property prop_alt: SystemError | None

Gets/Sets Alternative text

Return type:: SystemError | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

prop_next: Descriptor to raise an exception when an attribute is accessed after deletion.

prop_prev: Descriptor to raise an exception when an attribute is accessed after deletion.

class ooodev.format.writer.direct.obj.options.Properties(printable=True)[source]

Bases: StyleBase

Image Options Properties.

New in version 0.9.0.

__init__(printable=True)[source]

Constructor

Parameters:: printable (bool, optional) – Specifies if Frame can be printed. Default True.
Return type:: None

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:: obj (object) – UNO Object.
Raises:: NotSupportedError – If obj is not supported.
Returns:: Instance that represents Image Properties.
Return type:: Properties

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_printable: bool | None

Gets/Sets print value

Return type:: bool | None

class ooodev.format.writer.direct.obj.options.Protect(size=None, position=None, content=None)[source]

Bases: StyleBase

Frame Protections

New in version 0.9.0.

__init__(size=None, position=None, content=None)[source]

Constructor

Parameters:

size (bool, optional) – Specifies size protection.
position (bool, optional) – Specifies position protection.
content (bool, optional) – Specifies content protection.

Return type:

None

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:: obj (object) – UNO Object.
Raises:: NotSupportedError – If obj is not supported.
Returns:: Instance that represents Frame Protection.
Return type:: Protect

property prop_content: bool | None

Gets/Sets content

Return type:: bool | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_position: bool | None

Gets/Sets position

Return type:: bool | None

property prop_size: bool | None

Gets/Sets size

Return type:: bool | None