IUP - Portable User Interface


Creates an editable field with one line.


Ihandle* IupText(char *action); [in C]
iuptext{} -> (elem: iuplua_tag) [in IupLua3]
iup.text{} -> (elem: iuplua_tag) [in IupLua5]
text(action) [in LED]

action: name of the action generated when the user types something.

This function returns the identifier of the created text, or NULL if an error occurs.


APPEND: Inserts a text at the end of the current text.

INSERT: Inserts a text in the caret's position.

BORDER: Shows a border around the text.

NC: Maximum number of characters allowed.

CARET: Position of the insertion point.

READONLY: Allows the user only to read the contents, without changing it. Possible values: "YES", "NO" (default).

SELECTION: Selection interval.

SELECTEDTEXT: Selection text.

SIZE: Text size. Default: 5 characters width and 1 character height.

VALUE: Text entered by the user. If the element is already mapped, the string is directly copied to the native control (see IupMap).

The value can be any text, including '\n' characters indicating line change. Default: NULL when the element is not yet mapped; "" if it is.


ACTION: Action generated when a keyboard event occurs. The callback also receives the typed key.

int function(Ihandle *self, int c, char *after); [in C]
elem:action(c: number, after: string) -> (ret: number) [in IupLua]

c: Identifier of the typed key. Please refer to the Keyboard Codes table for a list of possible values.
after: Represents the new text value in case the key is validated (i.e. the callback returns IUP_DEFAULT).

If the function returns IUP_IGNORE, the system will ignore the typed character. If the function returns the code of any other key, IUP will treat this new key instead of the one typed by the user.


Text is always left aligned.

On the Windows driver, the action callback is not called for the function keys (K_F???).

The IupMask control can be used to create a mask and filter the text entered by the user.


See Also