ooodev.format.inner.direct.write.frame.options.properties module

class ooodev.format.inner.direct.write.frame.options.properties.Properties(editable=None, printable=None, txt_direction=None)[source]

Bases: StyleMulti

Frame Frame Options Properties.

New in version 0.9.0.

__init__(editable=None, printable=None, txt_direction=None)[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.

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 Option Properties.
Return type:: Properties

property prop_editable: bool | None

Gets/Sets editable value

Return type:: bool | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_inner_writing_mode: WritingMode | None

Return type:: WritingMode | None

property prop_printable: bool | None

Gets/Sets print value

Return type:: bool | None

property prop_txt_direction: TextDirectionKind | None

Gets/Sets text direction value

Return type:: TextDirectionKind | None

class ooodev.format.inner.direct.write.frame.options.properties.TextDirectionKind(value)[source]

Bases: Enum

Describes different writing directions

BT_LR = 5

Bottom-to-top, left-to-right (vertical)

Text within a line is written bottom-to-top. Lines and blocks are placed left-to-right.

LR_TB = 0

Left-to-right (LTR)

Text within lines is written left-to-right. Lines and blocks are placed top-to-bottom. Typically, this is the writing mode for normal alphabetic text.

PAGE = 4

Use super-ordinate object settings

Obtain writing mode from the current page. May not be used in page styles.

RL_TB = 1

Right-to-left (RTL).

text within a line are written right-to-left. Lines and blocks are placed top-to-bottom. Typically, this writing mode is used in Arabic and Hebrew text.

TB_LR = 3

Left-to-right (vertical).

Text within a line is written top-to-bottom. Lines and blocks are placed left-to-right. Typically, this writing mode is used in Mongolian text.

TB_RL = 2

Right-to-left (vertical).

Text within a line is written top-to-bottom. Lines and blocks are placed right-to-left. Typically, this writing mode is used in Chinese and Japanese text.

class ooodev.format.inner.direct.write.frame.options.properties.TextDirectionMode(mode=None)[source]