workbench/classes/zune/nlist/docs/MCC_NFloattext.doc

   1 TABLE OF CONTENTS
   2
   3 NFloattext.mcc/NFloattext.mcc
   4 NFloattext.mcc/MUIA_NFloattext_Align
   5 NFloattext.mcc/MUIA_NFloattext_Justify
   6 NFloattext.mcc/MUIA_NFloattext_SkipChars
   7 NFloattext.mcc/MUIA_NFloattext_TabSize
   8 NFloattext.mcc/MUIA_NFloattext_Text
   9 NFloattext.mcc/MUIM_NFloattext_GetEntry
  10 \fNFloattext.mcc/NFloattext.mcc
  11
  12         NFloattext class is a subclass of NList class that takes
  13         a big text string as input and splits it up into several
  14         lines to be dislayed. Formatting capabilities include
  15         paragraphs an justified text with word wrap. That MCC
  16         public custom class  work near the same way as Floattext.
  17
  18         All you can do with NFloattext can be done directly using
  19         NList and its word wrap capabilities. NFloattext is here
  20         to give easy use and transition from Floattext.
  21
  22         Now NList package provide a Floattext.mui replacement
  23         which use directly this class. Unfortunately the
  24         repacement Floattext.mui have to have the same major release
  25         number than original Floattext.mui to be accepted by MUI,
  26         so it will have to be update with each new MUI remease.  :(
  27
  28         By default, MUIA_NList_Input is FALSE and MUIA_NList_TypeSelect
  29         is MUIV_NList_TypeSelect_Char, alowing char selection and copy
  30         to clipboard. If you set MUIA_NList_Input to TRUE, then
  31         MUIA_NList_TypeSelect default to MUIV_NList_TypeSelect_Line as
  32         usual.
  33
  34         NFloattext don't copy the string text, so it needs to copy
  35         the string line to a buffer when you do a MUIM_NFloattext_GetEntry
  36         or MUIM_List_GetEntry, so the return pointer will be invalid
  37         after next GetEntry call (the new one will be valid of course).
  38
  39         Using the old MUIA_Floattext_Text from standard Floadtext class
  40         instead of MUIA_NFloattext_Text will make NFloattext copy
  41         the text like in Floattext class.
  42
  43         Note that MUIM_NList_GetEntry work as describe in NList, so
  44         as NFloattext use word wrap entries, you should use better
  45         MUIM_NFloattext_GetEntry or MUIM_List_GetEntry. Or use
  46         MUIM_NList_GetEntryInfo and MUIM_NList_GetEntry.
  47
  48 \fNFloattext.mcc/MUIA_NFloattext_Align
  49
  50     NAME
  51         MUIA_NFloattext_Align -- [ISG], LONG
  52
  53     SPECIAL INPUTS
  54         ALIGN_LEFT
  55         ALIGN_CENTER
  56         ALIGN_RIGHT
  57         ALIGN_JUSTIFY
  58
  59     FUNCTION
  60         Indicate what alignment you want.
  61         It can be done with an escape alignment sequence
  62         in the Format preparse string or in the text string
  63         (for each linefeed separated lines) itself.
  64
  65         setting it will set MUIA_NFloattext_Justify to
  66         TRUE if ALIGN_JUSTIFY, else to FALSE.
  67
  68     SEE ALSO
  69         MUIA_NFloattext_Justify, MUIA_NList_Format
  70 \fNFloattext.mcc/MUIA_NFloattext_Justify
  71
  72     NAME
  73         MUIA_NFloattext_Justify -- [ISG], BOOL
  74
  75     FUNCTION
  76         Same as Floattext.mui/MUIA_Floattext_Justify.
  77
  78         if TRUE, MUIA_NFloattext_Align will be set to
  79         ALIGN_JUSTIFY, else to ALIGN_LEFT.
  80
  81     SEE ALSO
  82         MUIA_NFloattext_Align, MUIA_NList_Format
  83 \fNFloattext.mcc/MUIA_NFloattext_SkipChars
  84
  85     NAME
  86         MUIA_NFloattext_SkipChars -- [ISG], char *
  87
  88     FUNCTION
  89         Same as NList.mcc/MUIA_NList_SkipChars
  90         and Floattext.mui/MUIA_Floattext_SkipChars.
  91
  92     SEE ALSO
  93         MUIA_NList_SkipChars, MUIA_Floattext_SkipChars
  94 \fNFloattext.mcc/MUIA_NFloattext_TabSize
  95
  96     NAME
  97         MUIA_NFloattext_TabSize -- [ISG], LONG
  98
  99     FUNCTION
 100         Same as NList.mcc/MUIA_NList_TabSize
 101         and Floattext.mui/MUIA_Floattext_TabSize.
 102
 103         Tab size defaults to 8.
 104
 105     SEE ALSO
 106         MUIA_NList_TabSize, MUIA_Floattext_TabSize
 107 \fNFloattext.mcc/MUIA_NFloattext_Text
 108
 109     NAME
 110         MUIA_NFloattext_Text -- [ISG], STRPTR
 111
 112     FUNCTION
 113         Same as Floattext.mui/MUIA_Floattext_Text.
 114
 115         String of characters to be displayed as floattext.
 116         This string may contain linefeeds or carriage retruns to mark
 117         the end of paragraphs or tab characters for indention.
 118
 119         NFloattext will automatically format the text according
 120         to the width of the NFloattext object. If a word
 121         won't fit into the current line, it will be wrapped.
 122
 123         NFloattext don't copies the string into a private buffer
 124         as Floattext do it, so you need to keep your text in
 125         memory, but it uses less memory.
 126
 127         If you want NFloattext to copy the text, just use
 128         MUIA_Floattext_Text which will do it for compatibility.
 129
 130         Setting MUIA_NFloattext_Text to NULL means to clear
 131         the current text.
 132
 133         Please note that justification and word wrap is a
 134         complicated operation and may take a considerable
 135         amount of time, especially with long texts on slow
 136         machines.
 137
 138 \fNFloattext.mcc/MUIM_NFloattext_GetEntry
 139
 140     NAME
 141         MUIM_NFloattext_GetEntry --
 142
 143     SYNOPSIS
 144         DoMethod(obj,MUIM_NFloattext_GetEntry,LONG pos, APTR *entry);
 145
 146     FUNCTION
 147         Same function as List.mui/MUIM_List_GetEntry.
 148
 149         You'll get pointer to a null terminated string buffer which
 150         is a copy of the asked visible entry.
 151
 152         Unlike with Floattext, the returned string will be valid only
 153         until next MUIM_NFloattext_GetEntry/MUIM_List_GetEntry call
 154         if the entry was word wrapped.
 155         I'll try to make it stay valid when using MUIM_List_GetEntry
 156         only if someone report me some compatibility problem because
 157         doing that will use more memory.
 158
 159     SEE ALSO
 160         MUIM_NList_GetEntry, MUIM_NList_GetEntryInfo, MUIM_List_GetEntry
 161 \f