ooodev.format.draw.direct.para.indent_spacing package

Submodules

Module contents

class ooodev.format.draw.direct.para.indent_spacing.Indent(*, before=None, after=None, first=None, auto=None)[source]

Bases: Indent

Shape Indent

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together properties.

See also

Write Direct Paragraph Indent & Spacing

New in version 0.9.0.

__init__(*, before=None, after=None, first=None, auto=None)[source]

Constructor

Parameters:

before (float, UnitT, optional) – Determines the left margin of the paragraph (in mm units) or Class UnitT.
after (float, UnitT, optional) – Determines the right margin of the paragraph (in mm units) or Class UnitT.
first (float, UnitT, optional) – specifies the indent for the first line (in mm units) or Class UnitT.
auto (bool, optional) – Determines if the first line should be indented automatically.

Return type:

None

See also

Write Direct Paragraph Indent & Spacing

class ooodev.format.draw.direct.para.indent_spacing.LineSpacing(*, mode=None, value=0)[source]

Bases: StyleMulti

Paragraph Line Spacing

Any properties starting with prop_ set or get current instance values.

See also

Write Direct Paragraph Indent & Spacing

__init__(*, mode=None, value=0)[source]

Constructor

Parameters:

mode (ModeKind, optional) – Determines the mode that is used to apply units.
value (Real, UnitT, optional) – Value of line spacing. Only applies when ModeKind is PROPORTIONAL, AT_LEAST, LEADING, or FIXED.

Return type:

None

Note

If ModeKind is SINGLE, LINE_1_15, LINE_1_5, or DOUBLE then value is ignored.

If ModeKind is AT_LEAST, LEADING, or FIXED then value is a float (in mm units) or Class UnitT

If ModeKind is PROPORTIONAL then value is an int representing percentage. For example 95 equals 95%, 130 equals 130%

See also

Write Direct Paragraph Indent & Spacing

apply(obj: Any)[source]

apply(obj, **kwargs)

Applies writing mode to obj

Parameters:: obj (object) – UNO object that supports com.sun.star.style.ParagraphProperties service.
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:: LineSpacing instance that represents obj line spacing.
Return type:: LineSpacing

property default: _TLineSpacing

Gets LineSpacing default.

Return type:: TypeVar(_TLineSpacing, bound= LineSpacing)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_inner: LineSpacingStruct

Gets Line Spacing instance

Return type:: LineSpacingStruct

property prop_mode: ModeKind | None

Gets the mode that is used to apply units.

Return type:: ModeKind | None

property prop_value: int | float | None

Gets the Value of line spacing.

Return type:: int | float | None

class ooodev.format.draw.direct.para.indent_spacing.Spacing(*, above=None, below=None, style_no_space=None)[source]

Bases: Spacing

Paragraph Spacing

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together properties.

See also

Write Direct Paragraph Indent & Spacing

New in version 0.17.8.

__init__(*, above=None, below=None, style_no_space=None)[source]

Constructor

Parameters:

above (float, UnitT, optional) – Determines the top margin of the paragraph (in mm units) or Class UnitT.
below (float, UnitT, optional) – Determines the bottom margin of the paragraph (in mm units) or Class UnitT.
style_no_space (bool, optional) – Do not add space between paragraphs of the same style.

Return type:

None

See also

Write Direct Paragraph Indent & Spacing