workbench/classes/zune/betterstring/doc/MCC_BetterString.doc

   1 TABLE OF CONTENTS
   2
   3 BetterString.mcc/BetterString.mcc
   4 BetterString.mcc/MUIA_BetterString_Columns
   5 BetterString.mcc/MUIA_BetterString_NoInput
   6 BetterString.mcc/MUIA_BetterString_SelectSize
   7 BetterString.mcc/MUIA_BetterString_StayActive
   8 BetterString.mcc/MUIM_BetterString_ClearSelected
   9 BetterString.mcc/MUIM_BetterString_FileNameStart
  10 BetterString.mcc/MUIM_BetterString_Insert
  11 \fBetterString.mcc/BetterString.mcc
  12
  13 BetterString is a stringgadget replacement. It is created for MUI, so using it
  14 should eliminate the problems with the original BOOPSI stringclass.
  15 The class offers the user to do number arithmetic, like increase, decrease and
  16 bin<->hex conversion. It has filename completion, ability to mark, cut, copy
  17 and paste text - Both via mouse and keyboard. The length of the contents
  18 buffer will dynamically be expanded to hold all of what the user type (unless
  19 a maximum length is given)
  20
  21 BetterString is released as POLYMORPH-WARE, which means that you need to pay
  22 or give me, whatever you want your users to pay or give you.
  23
  24 This autodoc only describes what is new, compared to the original "String.mui".
  25 All tags and methods of the old String.mui is supported, except edit hooks.
  26
  27 For feedback write to: Allan Odgaard
  28                        Dagmarsgade 36
  29                        DK-2200 Copenhagen
  30                 email: Duff@DIKU.DK
  31                   url: http://www.DIKU.dk/students/duff/
  32  Todo
  33 ¯¯¯¯¯¯
  34    The class can be set to remember what has been previously typed, and allows
  35    the user to go back and forth in the history buffer.
  36
  37 \fBetterString.mcc/MUIA_BetterString_Columns
  38
  39     NAME
  40         MUIA_BetterString_Columns -- [I..], ULONG
  41
  42     FUNCTION
  43         Set the width of the stringgadget (in characters)
  44         This tag is probably only useful for webbrowsers.
  45
  46 \fBetterString.mcc/MUIA_BetterString_NoInput
  47
  48     NAME
  49         MUIA_BetterString_NoInput -- [ISG], BOOL
  50
  51     FUNCTION
  52         Effectively turns the gadget into read-only mode.
  53
  54 \fBetterString.mcc/MUIA_BetterString_SelectSize
  55
  56     NAME
  57         MUIA_BetterString_SelectSize -- [.SG], LONG
  58
  59     FUNCTION
  60         Get or set the number of selected characters.
  61         A negative value indicates that the marking has happend right to left.
  62         A 0 means nothing is marked.
  63
  64     SEE ALSO
  65         MUIA_String_BufferPos (MUIA_String.Doc)
  66
  67 \fBetterString.mcc/MUIA_BetterString_StayActive
  68
  69     NAME
  70         MUIA_BetterString_StayActive -- [ISG], BOOL
  71
  72     FUNCTION
  73         Setting this attribute to TRUE will let the stringgadget stay active,
  74         even when the user hits return, or clicks outside the gadgets area.
  75
  76 \fBetterString.mcc/MUIM_BetterString_ClearSelected
  77
  78     NAME
  79         MUIM_BetterString_ClearSelected
  80
  81     SYNOPSIS
  82         DoMethod(obj, MUIM_BetterString_ClearSelected);
  83
  84     FUNCTION
  85         Clear all marked text, if any!
  86
  87     RESULT
  88         NONE
  89
  90 \fBetterString.mcc/MUIM_BetterString_FileNameStart
  91
  92     NAME
  93         MUIM_BetterString_FileNameStart
  94
  95     SYNOPSIS
  96         DoMethod(obj, MUIM_BetterString_FileNameStart, STRPTR buffer, LONG pos);
  97
  98     FUNCTION
  99         When the user press Amiga+TAB, then BetterString will call this
 100         method, with a pointer to the current buffer, and a cursor position.
 101         It expects the method to return the start position of the partial
 102         file, which the cursor is currently at.
 103
 104         Generally BetterString's own implementation is clever enough to find
 105         it, but if for example you use the stringgadget in a webbrowser, where
 106         the file is prefixed with "file://", then it isn't.
 107
 108     RESULT
 109         The start of the file or MUIR_BetterString_FileNameStart_Volume if no
 110         file is found, this will make BetterString treat the string as the
 111         beginning of a volumne, and make it do volume-completion instead.
 112
 113 \fBetterString.mcc/MUIM_BetterString_Insert
 114
 115     NAME
 116         MUIM_BetterString_Insert
 117
 118     SYNOPSIS
 119         DoMethod(obj, MUIM_BetterString_Insert, STRPTR text, LONG pos);
 120
 121     FUNCTION
 122         This will insert the given text.
 123         The position of the inserted text can either be a real position, or:
 124
 125           MUIV_BetterString_Insert_BufferPos
 126           MUIV_BetterString_Insert_StartOfLine
 127           MUIV_BetterString_Insert_EndOfLine
 128
 129
 130         If there isn't enough room to fit the complete string, then it will be
 131         truncated, and the user will get a DisplayBeep().
 132         If the cursor is to the right if the insertion place, then it will be
 133         moved.
 134
 135     RESULT
 136         NONE
 137
 138     SEE ALSO
 139         MUIA_String_Contents (MUIA_String.Doc)
 140 \f