Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

WidgetEditText Class

This class creates a simple editable multi-line text area containing text strings.

Notice
Word wrapping and rich text options are not supported for this class.

WidgetEditText Class

This class inherits from Widget

Members


WidgetEditText (Gui gui, string text = 0)

Constructor. Creates a multiline text field.

Arguments

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

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.

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.

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.

StringStack<256> 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.

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.

StringStack<256> getSelectionText ()

Returns the currently selected text.

Return value

Currently selected text.

string getText ()

Returns the current contents of the text field.

Return value

Text.

vec4 getTokenColor (string token)

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

Arguments

  • string token - Token.

Return value

Current token color.

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 removeLine (int line)

Deletes a given line.

Arguments

  • int line - Line number.

void setBackground (int mode)

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

Arguments

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

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.

void setEditable (int mode)

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

Arguments

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

void setLineText (int line, string text)

Sets new contents for a given line.

Arguments

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

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.

void setText (string text)

Sets a text for the text field.

Arguments

  • string text - 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.

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.
Last update: 2017-07-03