ooodev.format.writer.direct.para.borders package

Module contents

class ooodev.format.writer.direct.para.borders.Borders(*, right=None, left=None, top=None, bottom=None, all=None, shadow=None, padding=None, merge=None)[source]

Bases: StyleMulti

Border used in styles for characters.

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

See also

New in version 0.9.0.

__init__(*, right=None, left=None, top=None, bottom=None, all=None, shadow=None, padding=None, merge=None)[source]

Constructor

Parameters:

  • left (Side, None, optional) – Determines the line style at the left edge.

  • right (Side, None, optional) – Determines the line style at the right edge.

  • top (Side, None, optional) – Determines the line style at the top edge.

  • bottom (Side, None, optional) – Determines the line style at the bottom edge.

  • all (Side, None, optional) – Determines the line style at the top, bottom, left, right edges. If this argument has a value then arguments top, bottom, left, right are ignored

  • shadow (BorderShadow, None, optional) – Character Shadow

  • padding (BorderPadding, None, optional) – Character padding

  • merge (bool, None, optional) – Merge with next paragraph

Return type:

None

See also

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

Applies padding to obj

Parameters:

obj (object) – Object that supports com.sun.star.style.CharacterProperties service.

Return type:

None

fmt_border_side(value)[source]

Gets copy of instance with left, right, top, bottom sides set or removed

Parameters:

  • value (Side | None) – Side value

  • self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_bottom(value)[source]

Gets copy of instance with bottom set or removed

Parameters:

  • value (Side | None) – Side value

  • self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_left(value)[source]

Gets copy of instance with left set or removed

Parameters:

  • value (Side | None) – Side value

  • self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_padding(value)[source]

Gets copy of instance with padding set or removed

Parameters:

  • value (BorderPadding | None) – Padding value

  • self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_right(value)[source]

Gets copy of instance with right set or removed

Parameters:

  • value (Side | None) – Side value

  • self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_shadow(value)[source]

Gets copy of instance with shadow set or removed

Parameters:

  • value (Shadow | None) – Shadow value

  • self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_top(value)[source]

Gets copy of instance with top set or removed

Parameters:

  • value (Side | None) – Side value

  • self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

classmethod from_obj(obj)[source]
classmethod from_obj(obj, **kwargs)
classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:

obj (object) – UNO object that supports com.sun.star.style.ParagraphProperties service.

Raises:

ServiceNotSupported – If obj does not support com.sun.star.style.ParagraphProperties service.

Returns:

Borders instance that represents the obj borders.

Return type:

Borders

property default: _TBorders

Gets Default Border.

Return type:

TypeVar(_TBorders, bound= Borders)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_inner_padding: InnerPadding | None

Gets Padding instance

Return type:

InnerPadding | None

property prop_inner_shadow: InnerShadow | None

Gets Shadow instance

Return type:

InnerShadow | None

property prop_inner_sides: Sides | None

Gets Sides instance

Return type:

Sides | None

class ooodev.format.writer.direct.para.borders.Padding(*, left=None, right=None, top=None, bottom=None, all=None)[source]

Bases: AbstractPadding

Paragraph Border Padding

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

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

New in version 0.9.0.

property default: _TPadding

Gets BorderPadding default.

Return type:

TypeVar(_TPadding, bound= Padding)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

class ooodev.format.writer.direct.para.borders.Shadow(*, location=ShadowLocation.BOTTOM_RIGHT, color=8421504, transparent=False, width=1.76)[source]

Bases: ShadowStruct

Shadow format for paragraph border