Floattext.mui Class Reference¶

BOOPSI custom class Floattext.mui (MUI 3.8 dev). Each ### sub-section below documents one of the class's attributes or methods. Sub-classes of Floattext.mui are listed at the end under Sub-classes; the class hierarchy itself is documented in the MUI classes index.

Function index¶

Class definition

• Floattext.mui

Attributes

• MUIA_Floattext_Justify
• MUIA_Floattext_SkipChars
• MUIA_Floattext_TabSize
• MUIA_Floattext_Text

---

Floattext.mui¶

---

MUIA_Floattext_Justify¶

MUIA_Floattext_Justify -- (V4 ) [ISG], BOOL

Function

Indicate whether you want your the text aligned to the left and right border. MUI will try to insert spaces between words to reach this goal. If you want right aligned or centered text, use the MUIA_List_Format attribute.

See also

MUIA_Floattext_Text, MUIA_List_Format

---

MUIA_Floattext_SkipChars¶

MUIA_Floattext_SkipChars -- (V4 ) [IS.], STRPTR

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 attrinbute to "\1" to prevent floattext class from displaying unreadable crap.

See also

MUIA_Floattext_Text

---

MUIA_Floattext_TabSize¶

MUIA_Floattext_TabSize -- (V4 ) [IS.], LONG

Function

Adjust the tab size for a text. The tab size is measured in spaces, so if you plan to use tabs not only at the beginning of a paragraph, you should consider using the fixed width font. Tab size defaults to 8.

See also

MUIA_Floattext_Text

---

MUIA_Floattext_Text¶

MUIA_Floattext_Text -- (V4 ) [ISG], STRPTR

Function

String 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 won't 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 won't need to keep your text in memory. If memory is low, nothing will be displayed. Thats why you always have to be prepared for handling a NULL pointer when getting back MUIA_Floattext_Text. Setting MUIA_Floattext_Text to NULL means to clear the current 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.

Example

char *text = AllocVec(filesize,MEMF_ANY);
Read(file,text,filesize);
fto = FloattextObject,
MUIA_Floattext_Text,text,
End;
FreeVec(text);
/* ... if you need your text later, you can get it   */
/* with a simple get(fto,MUIA_Floattext_Text,&text); */

See also

MUIA_Floattext_Justify, MUIA_Floattext_TabSize, MUIA_Floattext_SkipChars

---