ooodev.format.draw.modify.indent_space package

Submodules

Module contents

class ooodev.format.draw.modify.indent_space.Indent(*, before=None, after=None, first=None, auto=None, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[source]

Bases: ParaStyleBaseMulti

Indent Style values.

See also

New in version 0.17.12.

__init__(*, before=None, after=None, first=None, auto=None, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[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. See note below.

  • style_name (FamilyGraphics, str, optional) – Specifies the Style that instance applies to. Default is Default standard Style.

  • style_family (str, DrawStyleFamilyKind, optional) – Family Style. Defaults to graphics.

Return type:

None

Note

The auto argument is suppose to set the styles ParaIsAutoFirstLineIndent property. The ParaIsAutoFirstLineIndent is suppose to be part of the com.sun.star.style.ParagraphProperties service; However, for some reason it is missing for Draw styles. Setting this auto argument will result in a print warning message in verbose mode. It is better to not set this argument. It is left in just in case it starts working in the future.

There is a option in the Indent and Spacing dialog Automatic. It seems to work, but it is not clear how it is implemented. It is not clear if it is a style property.

See also

classmethod from_style(doc, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

  • style_name (FamilyGraphics, str, optional) – Specifies the Style that instance applies to. Default is FamilyGraphics.DEFAULT_DRAWING_STYLE.

  • style_family (DrawStyleFamilyKind, str, optional) – Style family. Default DrawStyleFamilyKind.GRAPHICS.

Returns:

Indent instance from document properties.

Return type:

Indent

property prop_inner: Indent

Gets/Sets Inner Font instance

Return type:

Indent

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.draw.modify.indent_space.LineSpacing(*, mode=None, value=0, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[source]

Bases: ParaStyleBaseMulti

Line Spacing Style values.

See also

New in version 0.17.12.

__init__(*, mode=None, value=0, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[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.

  • style_name (FamilyGraphics, str, optional) – Specifies the Style that instance applies to. Default is Default standard Style.

  • style_family (str, DrawStyleFamilyKind, optional) – Family Style. Defaults to graphics.

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

classmethod from_style(doc, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

  • style_name (FamilyGraphics, str, optional) – Specifies the Style that instance applies to. Default is FamilyGraphics.DEFAULT_DRAWING_STYLE.

  • style_family (DrawStyleFamilyKind, str, optional) – Style family. Default DrawStyleFamilyKind.GRAPHICS.

Returns:

LineSpacing instance from document properties.

Return type:

LineSpacing

property prop_inner: LineSpacing

Gets/Sets Inner Font instance

Return type:

LineSpacing

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.draw.modify.indent_space.Spacing(*, above=None, below=None, style_no_space=None, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[source]

Bases: ParaStyleBaseMulti

Spacing Style values.

See also

New in version 0.17.12.

__init__(*, above=None, below=None, style_no_space=None, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[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. See note below.

  • style_name (FamilyGraphics, str, optional) – Specifies the Style that instance applies to. Default is Default standard Style.

  • style_family (str, DrawStyleFamilyKind, optional) – Family Style. Defaults to graphics.

Return type:

None

Note

The style_no_space argument is suppose to set the styles ParaContextMargin property. The ParaContextMargin is suppose to be part of the com.sun.star.style.ParagraphProperties service; However, for some reason it is missing for Draw styles. Setting this style_no_space argument will result in a print warning message in verbose mode. It is better to not set this argument. It is left in just in case it starts working in the future.

There is a option in the Indent and Spacing dialog Do not add space between paragraphs of the same style. It seems to work, but it is not clear how it is implemented. It is not clear if it is a style property.

See also

classmethod from_style(doc, style_name='standard', style_family=DrawStyleFamilyKind.GRAPHICS)[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

  • style_name (FamilyGraphics, str, optional) – Specifies the Style that instance applies to. Default is FamilyGraphics.DEFAULT_DRAWING_STYLE.

  • style_family (DrawStyleFamilyKind, str, optional) – Style family. Default DrawStyleFamilyKind.GRAPHICS.

Returns:

Spacing instance from document properties.

Return type:

Spacing

property prop_inner: Spacing

Gets/Sets Inner Font instance

Return type:

Spacing

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str