Floattext.mui

Super class

Background

Floattext class is a subclass of list class that takes a big text string as
input and splits it up into several lines to be dislayed. Formatting
capabilities include paragraphs an justified text with word wrap.

SEE ALSO

MUIA_Floattext_SkipChars

NAME

FUNCTION

Defines an array of characters that shall be skipped when displaying the
text. If you e.g. want to display a fido message and know it has some CTRL-A
control characters in it, you could set this attribute to "\1" to prevent
Floattext class from displaying unreadable crap.

SEE ALSO

MUIA_Floattext_Text

NAME

FUNCTION

Strings of characters to be displayed as floattext. This string may contain
linefeeds to mark the end of paragraphs or tab characters for indention.

MUI will automatically format the text according to the width of the
floattext object. If a word doen not fit into the current line, it will be
wrapped.

If you plan to use tabs not only at the beginning of a line you should
consider using the configured fixed width font.

MUI copies the complete string into a private buffer, you don't need to keep
your text in memory. If memory is low, nothing will be displayed. That's why
you always have to be prepared for handling a NULL pointer when getting back
MUIA_Floattext_Text.

Please note that justification and word wrap with proportional fonts is a
complicated operation and may take a considerable amount of time, especially
with long texts on slow machines.

Any active text styles (i.e. bold text or colors) will be reset at the end
of a paragraph indicated by a line feed character (0x0a, \n). However, it is
possible to switch off this behaviour by setting the attribute
MUIA_Floattext_KeepStyles to TRUE.