SHIP:Property:textmodel:textwrap

From Serious Documentation
Jump to: navigation, search

Node: All Text Model Nodes

Property Data Type Description
textwrap Boolean Determines if a text line is permitted to automatically wrap to the following line if it will not fit on the current line. The default (unset) is true.

This is different than (but works in coordination with) textmultiline.

With textmultiline false neither wrapping, nor a multi-line text string (for example "hello\nworld") will be permitted to have text flow onto the second line of the rendered area. In other words, textmultiline controls absolutely the ability for text in any way to appear on more than one line or not.

In contrast, textwrap purely indicates if any given text segment, if its contents cannot fit on the currently rendering line, will or will not be automatically wrapped with the remainder of the text pushed to the next line. The textmultiline property works in conjunction by allowing or not allowing the remainder of the text to be displayed.

textwrap true attempts to break lines at logical places, for example after a "-" but before a "$". Not all Unicode characters and sequences are currently handled as this logic is (mindbogglingly) quite convoluted.

References