WidgetEditText Class

WidgetEditText Class

Members

---

static WidgetEditText ( Gui gui, string str = 0 ) #

Constructor. Creates a multiline text field.

Arguments

• Gui gui - GUI, to which the text field will belong.
• string str - Initial value. This is an optional parameter.

WidgetEditText cast ( Widget widget ) #

Casts a WidgetEditText out of the Widget instance.

Arguments

• Widget widget - Widget instance.

Return value

WidgetEditText instance.

void setBackground ( int background ) #

Sets a value indicating if a background texture should be rendered for the text field.

Arguments

• int background - Positive number to render a background texture, 0 not to render.

int getBackground ( ) #

Returns a value indicating if a background texture is rendered for the text field.

Return value

Positive number if a background texture is rendered; otherwise, 0.

void setCursor ( int position, int line ) #

Sets the cursor to a given position in a given line.

Arguments

• int position - Position number.
• int line - Line number.

int getCursorLine ( ) #

Returns a number of the current line.

Return value

Line number.

int getCursorPosition ( ) #

Returns a cursor position in the current line.

Return value

Position number.

void setEditable ( int editable ) #

Sets a value indicating if the contents of the text field can be edited.

Arguments

• int editable - Positive number to make the text field editable, 0 to make it read-only.

int isEditable ( ) #

Returns a value indicating if the contents of the text field can be edited.

Return value

Positive number if the text field contents can be edited; otherwise, 0.

void setLineText ( int line, string str ) #

Sets new contents for a given line.

Arguments

• int line - Line number.
• string str - Text.

String getLineText ( int line ) #

Returns the text contained in a given line.

Arguments

• int line - Line number.

Return value

Text.

int getNumLines ( ) #

Returns the number of lines in the text field.

Return value

Number of lines.

void setSelection ( int position, int line ) #

Sets a line and a position, from which a new selection will start.

Arguments

• int position - Position number.
• int line - Line number.

int getSelectionLine ( ) #

Returns a number of the line where selection starts.

Return value

Line number.

int getSelectionPosition ( ) #

Returns a cursor position in the line where selection starts.

Return value

Position number.

String getSelectionText ( ) #

Returns the currently selected text.

Return value

Currently selected text.

void setText ( string text ) #

Sets a text for the text field.

Arguments

• string text - Text.

string getText ( ) #

Returns the current contents of the text field.

Return value

Text.

void setTokenColor ( string token, vec4 color ) #

Sets a color to a given token. The token will be highlighted with the provided color.

Arguments

• string token - Token (i.e. keyword, identifier, etc).
• vec4 color - Color.

vec4 getTokenColor ( string token ) #

Returns a color, which is used to highlight a given token.

Arguments

• string token - Token.

Return value

Current token color.

void setTokensColor ( string tokens, vec4 color ) #

Sets a color to given tokens. All tokens from the list will be highlighted with the color.

Arguments

• string tokens - Comma-separated list of tokens (i.e. keywords, identifiers, etc).
• vec4 color - Color.

int addLine ( string str = 0 ) #

Adds a new line to the widget.

Arguments

• string str - Text to add. This is an optional argument.

Return value

Number of the added line.

void clearSelectionText ( ) #

Deletes the currently selected text.

void removeLine ( int line ) #

Deletes a given line.

Arguments

• int line - Line number.

int type ( ) #

WidgetEditText type.

Return value

WidgetEditText type identifier.