+ (id) textWithContents:(OBString *)contents
- (OBString *) contents

String to be displayed in a text object.

If the string is larger than available display space, it will be clipped. Setting MUIA_Text_Contents to NULL results in an empty text object.

The string is copied into a private buffer, you can destroy the original after using this tag.

Whenever MUI prints strings, they may contain some special character sequences defining format, color and style of the text.

'\n' Start a new line. With this character you can e.g. create multi line buttons.

ESC - Disable text engine, following chars will be printed without further parsing.

ESC u Set the soft style to underline.

ESC U Remove underline style.

ESC b Set the soft style to bold.

ESC i Set the soft style to italic.

ESC n Set the soft style back to normal.

ESC s Set the soft style to shadowed.

ESC S Remove shadowed style.

ESC t Set the soft style to outlined.

ESC T Remove outlined style.

ESC w Set the soft style to glow.

ESC W Remove glow style.

ESC g Set the soft style to ghosted.

ESC G Remove ghosted style.

ESC Use pen number n (2..9) as front pen. n must be a valid DrawInfo pen as specified in "intuition/screens.h". ESC M Use the text marking pen.

ESC c Center current (and following) line(s). This sequence is only valid at the beginning of a string or directly following a newline character.

ESC r Right justify current (and following) line(s). This sequence is only valid at the beginning of a string or directly following a newline character.

ESC l Left justify current (and following) line(s). This sequence is only valid at the beginning of a string or directly following a newline character.

ESC I[s] Draw MUI image with specification . See autodocs of image class for image spec definition.

ESC p[p] ESC P[p] Pen number

ESC p[RRGGBB] Direct RGB color value for truecolor displays.

ESC P[RRGGBB] ESC P[AARRGGBB] ESC P[AA------] Direct (A)RGB value specifying text color on truecolor displays. When AA------ is used, currently set color is not altered, only its alpha value (transparency).

Note: These rules apply to all MUI strings, not only to a text objects contents. You can e.g. format the columns of a listview or include images in a cycle gadgets entries.

- (id) initWithContents:(OBString *)contents
- (BOOL) marking
- (void) noNotifySetContents:(OBString *)contents
- (void) noNotifySetPreParse:(OBString *)preparse
- (void) noNotifySetSetVMax:(BOOL)setvmax
- (void) noNotifySetShorten:(LONG)shorten
- (void) noNotifySetTextControlChar:(char)textcontrolchar
- (OBString *) preParse

String containing format definitions to be parsed before the text from MUIA_Text_Contents is printed.

Using this tag, you can easily define different formats, colors and styles without modifying the original string.

- (void) setContents:(OBString *)contents
- (void) setHiChar:(char)hichar

CAUTION: this is an initializer attribute, meaning it cannot be changed after the underlying MUI object is instantiated

- (void) setMarking:(BOOL)marking

CAUTION: this is an initializer attribute, meaning it cannot be changed after the underlying MUI object is instantiated

- (void) setPreParse:(OBString *)preparse
- (void) setSetMax:(BOOL)setmax

CAUTION: this is an initializer attribute, meaning it cannot be changed after the underlying MUI object is instantiated

- (void) setSetMin:(BOOL)setmin

CAUTION: this is an initializer attribute, meaning it cannot be changed after the underlying MUI object is instantiated

- (void) setSetVMax:(BOOL)setvmax

Settings this to FALSE makes a TextObjects y-size unlimited. Defaults to TRUE which means the objects height is fixed.

- (void) setShorten:(LONG)shorten
- (void) setTextControlChar:(char)textcontrolchar
- (LONG) shorten
- (BOOL) shortened
- (char) textControlChar