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

Module contents

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

Bases: PageStyleBaseMulti

Page Style Transparency.

New in version 0.9.0.

__init__(*, style=GradientStyle.LINEAR, offset=Offset(x=50, y=50), angle=0, border=0, grad_intensity=IntensityRange(start=0, end=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 (StyleParaKind, str, optional) – Specifies the Page Style that instance applies to. Default is Default Page Style.

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

  • style (GradientStyle) –

  • offset (Offset) –

  • angle (Angle | int) –

  • border (Intensity | int) –

  • grad_intensity (IntensityRange) –

Return type:

None

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_inner: Gradient

Gets/Sets Inner Transparency instance

Return type:

Gradient

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

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

Bases: PageStyleBaseMulti

Page Style Transparency.

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 (StyleParaKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.

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

Return type:

None

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 Page Style that instance applies to. Default is Default Page Style.

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

Returns:

Transparency instance from document properties.

Return type:

Transparency

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