ooodev.format.inner.direct.write.para.indent_space.indent module

Module for managing paragraph padding.

New in version 0.9.0.

class ooodev.format.inner.direct.write.para.indent_space.indent.Indent(*, before=None, after=None, first=None, auto=None)[source]

Bases: StyleBase

Paragraph 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

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

apply(obj: Any)[source]
apply(obj: Any, **kwargs)
apply(obj, **kwargs)

Applies writing mode to obj

Parameters:

obj (object) – UNO object.

Return type:

None

fmt_after(value)[source]

Gets a copy of instance with after margin set or removed

Parameters:

  • value (float, UnitT, optional) – Margin value (in mm units) or Class UnitT.

  • self (_TIndent) –

Returns:

Indent instance

Return type:

Indent

fmt_auto(value)[source]

Gets a copy of instance with auto set or removed

Parameters:

  • value (bool | None) – Auto value.

  • self (_TIndent) –

Returns:

Indent instance

Return type:

Indent

fmt_before(value)[source]

Gets a copy of instance with before margin set or removed

Parameters:

  • value (float, UnitT, optional) – Margin value (in mm units) or Class UnitT.

  • self (_TIndent) –

Returns:

Indent instance

Return type:

Indent

fmt_first(value)[source]

Gets a copy of instance with first indent margin set or removed

Parameters:

  • value (float, UnitT, optional) – Margin value (in mm units) or Class UnitT.

  • self (_TIndent) –

Returns:

Indent instance

Return type:

Indent

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:

Indent instance that represents obj writing mode.

Return type:

Indent

property auto: _TIndent

Gets copy of instance with auto set

Return type:

TypeVar(_TIndent, bound= Indent)

property default: _TIndent

Gets Indent default.

Return type:

TypeVar(_TIndent, bound= Indent)

property prop_after: UnitMM | None

Gets/Sets the right margin of the paragraph (in mm units).

Return type:

UnitMM | None

property prop_auto: bool | None

Gets/Sets if the first line should be indented automatically

Return type:

bool | None

property prop_before: UnitMM | None

Gets/Sets the left margin of the paragraph (in mm units).

Return type:

UnitMM | None

property prop_first: UnitMM | None

Gets/Sets the indent for the first line (in mm units).

Return type:

UnitMM | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind