| Index | Parent | String class |
The String class is used to create simple string gadgets or a very big text input objects.
If you want scroll bars around the string object, use the TextInputScroll class. It has the same attributes and methods of String class.
String is a subclass of TextInput.mcc, so you must have TextInput.mcc in MUI:Libs/MUI to use it. TextInput.mcc is copyright of Oliver Wagner.
| Attributes | |||
|---|---|---|---|
| Name | Type | Class | Note |
| Accept | S | ISGN | Only the chars in this string will be accepted |
| Acknowledge | B | GN | Notified (use Everytime) when the user press return in the object |
| AdvanceOnCR | B | ISGN | Pressing return activate the next object in the cycle chain |
| AlwaysNotifyNC | B | ISGN | Both NewContents and Integer (if IsNumeric is 1) are notified on Acknowledge if and only if its value changed (actual value is different from previous one). Setting to attribute to 1 makes String class to notify NewContents and Integer anytime. |
| AttachedList | S | IS | This the name of an already existing (N)Listview object. Up/down arrows pressed-event in the String object is sent to the Listview. Note that the Listview object can't be remove or disposed anymore. |
| AutoExpand | N | ISGN | Auto expand size when needed |
| BlinkRate | N | ISGN | Frequency of the blink of the cursor |
| BookMark1 | N | ISGN | Set/Get the bookmark n.1 |
| BookMark2 | N | ISGN | Set/Get the bookmark n.2 |
| BookMark3 | N | ISGN | Set/Get the bookmark n.3 |
| Changed | B | GN | Notified when the contents changes |
| Contents | S | ISGN | The contents of the string; notified whenever it changes |
| CursorPos | N | SGN | Position of the cursor |
| CursorStyle | N | ISGN | |
| DefPopUp | B | I | Set to 0 if you don't want the default context menu and/or you want to use your won one. |
| Editable | B | ISGN | If 0, the contents can't be modified |
| Format | M | ISGN G2N | A number or one of:
|
| Integer | N | ISGN | The integer contents of the object; it has sense especially if IsNumeric is 1. |
| IsNumeric | B | ISGN | If set to 1 you get a numeric string object. |
| IsOld | B | ISGN | |
| Lines | N | GN | Notified when the number of the lines changes |
| MarkEnd | M | ISGN G2N | Set/Get the end of a block. May be the string NOMARK to delete the mark |
| MarkStart | M | ISGN G2N | Set/Get the start of a block May be the string NOMARK to delete the mark |
| MaxLen | N | ISG | Max len (+1) in chars for the string. Default 79 (it means 78 chars) |
| MaxLines | N | IG | Max number of lines |
| MaxVal | N | ISGN | Max val for Integer |
| MinimumWidth | N | ISGN | Min width for the object |
| MinVal | N | ISGN | Min val for Integer |
| MinVersion | N | I | Min version of Textinput.mcc . |
| MultiLine | B | IG | If set to 1, the object is multi line |
| NewContents | S | GN | It is notified on Acknowledge |
| NoCopy | N | ISGN | Forbid to copy the contents (or part of it) |
| NoExtraSpacing | B | ISG | |
| NoInput | B | IG | No input gadget |
| Preparse | S | ISGN | A pre parse text |
| ProhibitParse | N | ISGN | |
| Quiet | B | SGN | |
| Reject | S | ISGN | Chars in this string will be rejected |
| RemainActive | B | ISGN | Remain active if the user presses return |
| ResetMarkOnCursor | B | ISGN | Removes text mark when a cursor movement is executed. |
| Secret | B | ISGN | Don't show the contents (e.g. for passwords) |
| SetMax | B | ISGN | If set to 1, the object width is limited to its contents size. Default 0 |
| SetMin | B | ISGN | If set to 1, the object minimum width is set to the contents size. Default 0 |
| SetVMax | B | ISGN | If set to 0, the object is y-size unlimited. Default 1 |
| SetVMin | B | ISGN | If set to 0, the object y-size is set to its contents height. It has sense iff MultiLine is 1. Default 1 |
| StringFont | M | ISGN G2N | A number or one of:
|
| Styles | M | ISGN G2N | A number or one of:
|
| SuggestParse | N | ISGN | |
| TabLen | N | ISGN | Tab len |
| Tabs | M | ISGN G2N | A number or one of:
|
| TopLine | N | ISGN | The first visible line |
| UseWinBorder | B | I | TextInputScroll only. Use window border scroller |
| VertScrollerOnly | B | I | TextInputScroll only. Do not show the horiz scroller |
| WordWrap | B | ISGN | Activate word wrap mode |
| Methods | ||
|---|---|---|
| Name | Parameters | Note |
| AppendText | <text> | Append text to the object. |
| DoBottom | ||
| DoBS | ||
| DoBSSOL | ||
| DoBSWord | ||
| DoCopy | ||
| DoCut | ||
| DoCutLine | ||
| DoDecrementDec | ||
| DoDel | ||
| DoDelEOL | ||
| DoDelLine | ||
| DoDelWord | ||
| DoDown | ||
| DoGotoBookmark1 | ||
| DoGotoBookmark2 | ||
| DoGotoBookmark3 | ||
| DoIncrementDec | ||
| DoInsertFile | <file> | |
| DoLeft | ||
| DoLineEnd | ||
| DoLineStart | ||
| DoMarkAll | ||
| DoMarkStart | ||
| DoNextGadget | ||
| DoNextWord | ||
| DoPageDown | ||
| DoPageUp | ||
| DoPaste | ||
| DoPopUp | ||
| DoPrevWord | ||
| DoRedo | ||
| DoReVert | ||
| DoRight | ||
| DoSetBookmark1 | ||
| DoSetBookmark2 | ||
| DoSetBookmark3 | ||
| DoTab | ||
| DoToggleCase | ||
| DoToggleCaseEow | ||
| DoToggleWordWrap | ||
| DoTop | ||
| DoUndo | ||
| DoUp | ||
| ExternalEdit | ||
| InsertFromFile | <file> | |
| InsertText | <text> | |
| LoadFromFile | <file> | |
| SaveToFile | <file> | |