+ (id) multilineString
+ (id) multilineStringWithContents:(OBString *)contents
+ (id) readOnlyString
+ (id) readOnlyStringWithContents:(OBString *)contents
+ (id) secretStringWithContents:(OBString *)contents
+ (id) string
All constructors will set the frame to MUIV_Frame_String
+ (id) stringWithContents:(OBString *)contents
- (OBString *) accept
A string containing characters allowed as input for the string gadget. Whenever the user hits a character not found in MUIA_String_Accept, he will hear a beep and gadgets contents won't have changed.
- (OBString *) acknowledge
This attribute will be set to the contents of the string whenever the user hits return in the gadget. An application can listen with notification and take the appropriate action.
Using the TAB key or a mouse click to deactivate the gadget will not trigger MUIA_String_Acknowledge.
- (BOOL) advanceOnCR
Set this if you want carriages returns in string gadgets behave like the TAB key, i.e. pressing CR will activate the next/previous gadget in the cycle chain.
- (id) attachedList
This special attribute can be set to point to a valid MUI object of Listview class. This enables controlling the lists cursor from within the string gadget, all cursor key events will be forwarded.
- (LONG) bufferPos
MUIA_String_BufferPos can be used to get and set the position of the cursor in the string gadget. This attribute is probably not very interesting.
- (OBString *) contents
Get and set a string gadgets contents. You may not modify the returned string.
MUIA_String_Contents gets updated every time when the contents of the string gadget change. When you set up a notification on this attribute, you will hear about every keystroke.
- (LONG) displayPos
MUIA_String_DisplayPos can be used to get and set the number of the first character of the string to be displayed. This attribute is probably not very interesting.
- (BOOL) editable
- (LONG) format
Used to adjust the alignment of the input string.
- (ULONG) integer
Useful for turning a string gadget into an integer gadget. Setting this attribute puts the value with "%ld" into the gadget, getting it returns a longword containing the string gadgets contents as number.
You should set MUIA_String_Accept to "0123456789" or something like that to avoid wrong characters.
- (QUAD *) integer64
- (LONG) maxLen
Setup the maximum length for the string gadget. This attribute is only valid at object creation time.
Default maximum length is 80.
NOTE: The maximum length includes the 0-byte at the end of the string. To let the user enter e.g. 10 characters, you would have to specify a maxlen of 11.
- (BOOL) multiline
- (void) noNotifySetAdvanceOnCR:(BOOL)advanceoncr
- (void) noNotifySetAttachedList:(id)attachedlist
- (void) noNotifySetBufferPos:(LONG)bufferpos
- (void) noNotifySetContents:(OBString *)contents
- (void) noNotifySetDisplayPos:(LONG)displaypos
- (void) noNotifySetEditable:(BOOL)editable
- (void) noNotifySetInteger64:(QUAD *)integer64
- (void) noNotifySetInteger:(ULONG)integer
- (void) noNotifySetPlaceholder:(OBString *)placeholder
- (void) noNotifySetReject:(OBString *)reject
- (void) noNotifySetSpellChecking:(BOOL)spellchecking
- (OBString *) placeholder
This string is displayed when there is no other text in the field.
- (OBString *) reject
A string containing characters that should not be accepted as input for the string gadget. Whenever the user hits such a char, he will hear a beep and gadgets contents won't have changed.
- (LONG) scrollHeight
- (LONG) scrollLeft
- (LONG) scrollTop
- (LONG) scrollVisibleHeight
- (LONG) scrollVisibleWidth
- (LONG) scrollWidth
- (BOOL) secret
This attribute causes the string gadget to display only dots instead of the real contents. Useful for password requesters.
- (void) setAdvanceOnCR:(BOOL)advanceoncr
- (void) setAttachedList:(id)attachedlist
- (void) setBufferPos:(LONG)bufferpos
- (void) setContents:(OBString *)contents
- (void) setDisplayPos:(LONG)displaypos
- (void) setEditable:(BOOL)editable
- (void) setFormat:(LONG)format
CAUTION: this is an initializer attribute, meaning it cannot be changed after the underlying MUI object is instantiated
- (void) setInteger64:(QUAD *)integer64
- (void) setInteger:(ULONG)integer
- (void) setMaxLen:(LONG)maxlen
CAUTION: this is an initializer attribute, meaning it cannot be changed after the underlying MUI object is instantiated
- (void) setMultiline:(BOOL)multiline
CAUTION: this is an initializer attribute, meaning it cannot be changed after the underlying MUI object is instantiated
- (void) setPlaceholder:(OBString *)placeholder
- (void) setReject:(OBString *)reject
- (void) setSecret:(BOOL)secret
CAUTION: this is an initializer attribute, meaning it cannot be changed after the underlying MUI object is instantiated
- (void) setSpellChecking:(BOOL)spellchecking
- (BOOL) spellChecking