ooodev.format.draw.direct.para.indent_spacing.line_spacing module

Module for managing paragraph Line Spacing.

New in version 0.17.8.

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

Bases: StyleMulti

Paragraph Line Spacing

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

__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%

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)
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