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
isPROPORTIONAL
,AT_LEAST
,LEADING
, orFIXED
.
- Return type:
None
Note
If
ModeKind
isSINGLE
,LINE_1_15
,LINE_1_5
, orDOUBLE
thenvalue
is ignored.If
ModeKind
isAT_LEAST
,LEADING
, orFIXED
thenvalue
is a float (in mm units
) or Class UnitTIf
ModeKind
isPROPORTIONAL
then value is an int representing percentage. For example95
equals95%
,130
equals130%
- 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 representsobj
line spacing.- Return type:
- property default: _TLineSpacing
Gets
LineSpacing
default.- Return type:
TypeVar
(_TLineSpacing
, bound= LineSpacing)
- property prop_format_kind: FormatKind
Gets the kind of style
- Return type:
- property prop_inner: LineSpacingStruct
Gets Line Spacing instance
- Return type:
- 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