ooodev.format.calc.direct.cell.borders package

Module contents

class ooodev.format.calc.direct.cell.borders.Borders(*, right=None, left=None, top=None, bottom=None, border_side=None, vertical=None, horizontal=None, distance=None, diagonal_down=None, diagonal_up=None, shadow=None, padding=None)[source]

Bases: StyleMulti

Table Borders used in styles for table cells and ranges.

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

Calc Direct Cell Borders

New in version 0.9.0.

__init__(*, right=None, left=None, top=None, bottom=None, border_side=None, vertical=None, horizontal=None, distance=None, diagonal_down=None, diagonal_up=None, shadow=None, padding=None)[source]

Constructor

Parameters:

left (Side, optional) – Specifies the line style at the left edge.
right (Side, optional) – Specifies the line style at the right edge.
top (Side, optional) – Specifies the line style at the top edge.
bottom (Side, optional) – Specifies the line style at the bottom edge.
border_side (Side, optional) – Specifies the line style at the top, bottom, left, right edges. If this argument has a value then arguments top, bottom, left, right are ignored
horizontal (Side, optional) – Specifies the line style of horizontal lines for the inner part of a cell range.
vertical (Side, optional) – Specifies the line style of vertical lines for the inner part of a cell range.
distance (float, UnitT, optional) – Contains the distance between the lines and other contents in mm units or Class UnitT.
diagonal_down (Side, optional) – Specifies the line style from top-left to bottom-right diagonal.
diagonal_up (Side, optional) – Specifies the line style from bottom-left to top-right diagonal.
shadow (Shadow, optional) – Cell Shadow.
padding (padding, optional) – Cell padding.

Return type:

None

See also

Calc Direct Cell Borders

apply(obj: Any)[source]

apply(obj, **kwargs)

Applies padding to obj

Parameters:: obj (object) – Object that supports com.sun.star.style.ParagraphProperties 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, optional) – 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, optional) – Side value
self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_diagonal_down(value)[source]

Gets copy of instance with diagonal down set or removed

Parameters:

value (Side, optional) – Side value
self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_diagonal_up(value)[source]

Gets copy of instance with diagonal up set or removed

Parameters:

value (Side, optional) – Side value
self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_distance(value)[source]

Gets copy of instance with distance set or removed

Parameters:

value (float, UnitT, optional) – Distance value
self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_horizontal(value)[source]

Gets copy of instance with horizontal set or removed

Parameters:

value (Side, optional) – 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, optional) – 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 (Padding, optional) – 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, optional) – 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, optional) – 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, optional) – Side value
self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

fmt_vertical(value)[source]

Gets copy of instance with vertical set or removed

Parameters:

value (Side, optional) – Side value
self (_TBorders) –

Returns:

Borders instance

Return type:

Borders

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets Borders instance from object

Parameters:: obj (object) – UNO Object.
Raises:: NotSupportedServiceError – If obj is not supported.
Returns:: Borders that represents obj borders.
Return type:: Borders

property default: _TBorders

Gets Default Border.

Return type:: TypeVar(_TBorders, bound= Borders)

property empty: _TBorders

Gets Empty Border. When style is applied formatting is removed.

Return type:: TypeVar(_TBorders, bound= Borders)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_inner_border_table: TableBorderStruct

Gets border table instance

Return type:: TableBorderStruct

property prop_inner_diagonal_dn: Side | None

Gets inner Diagonal down instance

Return type:: Side | None

property prop_inner_diagonal_up: Side | None

Gets inner Diagonal up instance

Return type:: Side | None

property prop_inner_padding: Padding

Gets Padding instance

Return type:: Padding

property prop_inner_shadow: Shadow | None

Gets inner shadow instance

Return type:: Shadow | None

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

Bases: AbstractPadding

Paragraph Padding

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__(*, left=None, right=None, top=None, bottom=None, all=None)[source]

Constructor

Parameters:

left (float, UnitT, optional) – Left (in mm units) or Class UnitT.
right (float, UnitT, optional) – Right (in mm units) or Class UnitT.
top (float, UnitT, optional) – Top (in mm units) or Class UnitT.
bottom (float, UnitT, optional) – Bottom (in mm units) or Class UnitT.
all (float, UnitT, optional) – Left, right, top, bottom (in mm units) or Class UnitT. If argument is present then left, right, top, and bottom arguments are ignored.

Raises:

ValueError – If any argument value is less than zero.

Return type:

None

See also

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets Padding instance from object

Parameters:: obj (object) – UNO Object.
Raises:: NotSupportedServiceError – If obj is not supported.
Returns:: Padding that represents obj padding.
Return type:: Padding

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

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

Bases: ShadowStruct

Shadow struct

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__(*, location=ShadowLocation.BOTTOM_RIGHT, color=8421504, transparent=False, width=1.76)[source]

Constructor

Parameters:

location (ShadowLocation, optional) – contains the location of the shadow. Default to ShadowLocation.BOTTOM_RIGHT.
color (Color, optional) – contains the color value of the shadow. Defaults to StandardColor.GRAY.
transparent (bool, optional) – Shadow transparency. Defaults to False.
width (float, UnitT, optional) – contains the size of the shadow (in mm units) or Class UnitT. Defaults to 1.76.

Raises:

ValueError – If color or width are less than zero.

Return type:

None

Hint

ShadowLocation can be imported from ooo.dyn.table.shadow_location

See also