Write Direct Paragraph Area Gradient Class

Overview

Writer has an Area Gradient dialog section.

The ooodev.format.writer.direct.para.area.Gradient class is used to set the paragraph background gradient.

Writer Paragraph Area Gradient dialog — Fig. 962 Writer Paragraph Area Gradient dialog

There are many presets for gradient available. Using the PresetGradientKind enum, you can set the gradient to one of the presets.

Setup

General function used to run these examples:

from typing import TYPE_CHECKING, cast
from ooodev.format.writer.direct.para.area import Gradient, PresetGradientKind
from ooodev.office.write import Write
from ooodev.gui import GUI
from ooodev.loader.lo import Lo

if TYPE_CHECKING:
    from com.sun.star.text import TextRangeContentProperties  # service


def main() -> int:
    p_txt = (
        "To Sherlock Holmes she is always THE woman. I have seldom heard"
        " him mention her under any other name. In his eyes she eclipses"
        " and predominates the whole of her sex. It was not that he felt"
        " any emotion akin to love for Irene Adler. All emotions, and that"
        " one particularly, were abhorrent to his cold, precise but"
        " admirably balanced mind. He was, I take it, the most perfect"
        " reasoning and observing machine that the world has seen, but as a"
        " lover he would have placed himself in a false position. He never"
        " spoke of the softer passions, save with a gibe and a sneer. They"
        " were admirable things for the observer--excellent for drawing the"
        " veil from men's motives and actions. But for the trained reasoner"
        " to admit such intrusions into his own delicate and finely"
        " adjusted temperament was to introduce a distracting factor which"
        " might throw a doubt upon all his mental results. Grit in a"
        " sensitive instrument, or a crack in one of his own high-power"
        " lenses, would not be more disturbing than a strong emotion in a"
        " nature such as his. And yet there was but one woman to him, and"
        " that woman was the late Irene Adler, of dubious and questionable memory."
    )

    with Lo.Loader(Lo.ConnectSocket()):
        doc = Write.create_doc()
        GUI.set_visible(doc=doc)
        Lo.delay(300)
        GUI.zoom(GUI.ZoomEnum.ZOOM_100_PERCENT)
        cursor = Write.get_cursor(doc)

        gradient_style = Gradient.from_preset(PresetGradientKind.MAHOGANY)
        Write.append_para(cursor=cursor, text=p_txt, styles=[gradient_style])

        Lo.delay(1_000)
        Lo.close_doc(doc)
    return 0


if __name__ == "__main__":
    SystemExit(main())

Examples

Apply Gradient Color

Create a gradient for the paragraph background.

# ... other code

cursor = Write.get_cursor(doc)
gradient_style = Gradient.from_preset(PresetGradientKind.MAHOGANY)
Write.append_para(cursor=cursor, text=p_txt, styles=[gradient_style])

Writer Paragraph Area Gradient — Fig. 963 Writer Paragraph Area Gradient

Get Gradient from Paragraph

# ... other code
cursor = Write.get_cursor(doc)
gradient_style = Gradient.from_preset(PresetGradientKind.MAHOGANY)
Write.append_para(cursor=cursor, text=p_txt, styles=[gradient_style])

para_cursor = Write.get_paragraph_cursor(cursor)
para_cursor.gotoPreviousParagraph(False)
para_cursor.gotoEndOfParagraph(True)

text_para = cast("TextRangeContentProperties", para_cursor)

para_gradient = Gradient.from_obj(text_para.TextParagraph)
para_gradient.prop_name == str(PresetGradientKind.MAHOGANY)