Write Direct Paragraph Text Flow

Overview

Specify hyphenation and pagination options.

Writer has an Text Flow dialog tab.

The ooodev.format.writer.direct.para.text_flow.Breaks, ooodev.format.writer.direct.para.text_flow.FlowOptions and ooodev.format.writer.direct.para.text_flow.Hyphenation classes is used to set the paragraph text flow.

Fig. 997 Writer Paragraph Text Flow dialog.

Setup

General function used to run these examples:

from ooodev.office.write import Write
from ooodev.gui import GUI
from ooodev.loader.lo import Lo
from ooodev.format.writer.direct.para.text_flow import Breaks, BreakType, FlowOptions, Hyphenation

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(True, doc)
        Lo.delay(500)
        GUI.zoom(GUI.ZoomEnum.ENTIRE_PAGE)

        cursor = Write.get_cursor(doc)
        tf = Hyphenation(auto=True)
        Write.append_para(cursor=cursor, text=p_txt, styles=[tf])

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


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

Examples

Generally, if paragraph alignment is set using Write then the alignment style only applies to current paragraph.

Auto Hyphenation

Apply automatic hyphenation.

# ... other code
cursor = Write.get_cursor(doc)
tf = Hyphenation(auto=True)
Write.append_para(cursor=cursor, text=p_txt, styles=[tf])

Fig. 998 Writer Style Inspector with the paragraph text flow settings.

Set Flow Options

# ... other code
cursor = Write.get_cursor(doc)
flow_opt = FlowOptions(orphans=3, widows=4, keep=True)
Write.append_para(cursor=cursor, text=p_txt, styles=[flow_opt])

Set Breaks

# ... other code
cursor = Write.get_cursor(doc)
Write.append_para(cursor=cursor, text="Set Break in next paragraph...")
tf_breaks = Breaks(type=BreakType.PAGE_BEFORE, style="Right Page")
Write.append_para(cursor=cursor, text=p_txt, styles=[tf_breaks])