Unigine.WidgetEditText Class
| Inherits from: | Widget |
WidgetEditText Class
Properties
string Text#
The current contents of the text field.
set
Sets a text for the text field.
set value -
Text.
int NumLines#
The number of lines in the text field.
int SelectionLine#
A number of the line where selection starts.
int SelectionPosition#
A cursor position in the line where selection starts.
int CursorLine#
A number of the current line.
int CursorPosition#
A cursor position in the current line.
int Background#
A value indicating if a background texture is rendered for the text field. the default is 1.
set
Sets a value indicating if a background texture should be rendered for the text field.
set value -
Positive number to render a background texture, 0 not to render.
bool Editable#
A value indicating if the contents of the text field can be edited. the default is 1.
set
Sets a value indicating if the contents of the text field can be edited.
set value -
Positive number to make the text field editable, 0 to make it read-only.
vec4 SelectionColor#
Returns the current color used to highlight the current selection for the widget.
set
Sets the color to be used to highlight the current selection for the widget.
set value -
Four-component vector specifying the color in the RGBA format.
vec4 BackgroundColor#
Returns the current background color for the widget.
set
Sets the background color for the widget.
set value -
Four-component vector specifying the color in the RGBA format.
Members
WidgetEditText ( Gui gui, string str = 0 ) #
Constructor. Creates a multiline text field and adds it to the specified GUI.Arguments
- Gui gui - GUI, to which the text field will belong.
- string str - Initial value. This is an optional parameter.
WidgetEditText ( string str = 0 ) #
Constructor. Creates a multiline text field and adds it to the Engine GUI.Arguments
- string str - Initial value. This is an optional parameter.
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 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 contained in the line.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.
string GetSelectionText ( ) #
Returns the currently selected text.Return value
Currently selected text.void SetTokenColor ( string token, vec4 color ) #
Sets a color for 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
Color of the current token.void SetTokensColor ( string tokens, vec4 color ) #
Sets a color to given tokens. Each token will be highlighted with the provided 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.
Last update:
2021-04-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)