ooodev.format.writer.modify.page.header.transparency package

Module contents

class ooodev.format.writer.modify.page.header.transparency.Gradient(*, style=GradientStyle.LINEAR, offset=Offset(x=50, y=50), angle=0, border=0, grad_intensity=IntensityRange(start=100, end=100), style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Bases: PageStyleBaseMulti

Page Header Transparent Gradient

See also

New in version 0.9.0.

__init__(*, style=GradientStyle.LINEAR, offset=Offset(x=50, y=50), angle=0, border=0, grad_intensity=IntensityRange(start=100, end=100), style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Constructor

Parameters:

  • style (GradientStyle, optional) – Specifies the style of the gradient. Defaults to GradientStyle.LINEAR.

  • offset (offset, optional) – Specifies the X-coordinate (start) and Y-coordinate (end), where the gradient begins. X is effectively the center of the RADIAL, ELLIPTICAL, SQUARE and RECT style gradients. Defaults to Offset(50, 50).

  • angle (Angle, int, optional) – Specifies angle of the gradient. Defaults to 0.

  • border (int, optional) – Specifies percent of the total width where just the start color is used. Defaults to 0.

  • grad_intensity (IntensityRange, optional) – Specifies the intensity at the start point and stop point of the gradient. Defaults to IntensityRange(0, 0).

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

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

Return type:

None

See also

classmethod from_style(doc, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

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

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

Returns:

Gradient instance from document properties.

Return type:

Gradient

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_inner: Gradient

Gets/Sets Inner Gradient instance

Return type:

Gradient

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

class ooodev.format.writer.modify.page.header.transparency.Transparency(*, value=0, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Bases: PageStyleBaseMulti

Header Transparent Transparency

See also

New in version 0.9.0.

__init__(*, value=0, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Constructor

Parameters:

  • value (Intensity, int, optional) – Specifies the transparency value from 0 to 100.

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

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

Return type:

None

See also

classmethod from_style(doc, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

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

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

Returns:

Transparency instance from document properties.

Return type:

Transparency

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_inner: Transparency

Gets/Sets Inner Transparency instance

Return type:

Transparency

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str