Unigine.WidgetEditLine Class
| Inherits: | Widget |
This class creates an editable single-line text field containing a text string.
WidgetEditLine Class
Properties
string Text#
The current contents of the text field.
set
Sets a text for the text field.
set value -
Text string.
int Selection#
A position, from which the selection starts.
set
Sets a position, from which a new selection will start.
set value -
Position, from which the selection will start.
int Cursor#
The current cursor position in the text field.
set
Sets a cursor position in the text field.
set value -
Cursor position. The provided value will be saturated in the range from 0 to text field capacity.
int Capacity#
The maximum length of a string entered into the text field.
set
Sets a maximum length of a string entered into the text field. The default is 1024.
set value -
Maximum number of characters.
int Background#
A value indicating if a background texture is rendered for the text field.
set
Sets a value indicating if a background texture should be rendered for the text field. The default is 1.
set value -
Positive number to render a background texture, 0 not to render.
int Validator#
The validator associated with the text field. the default is VALIDATOR_ANY.
set
Sets a validator for the text filed contents.
set value -
One of the GUI_VALIDATOR_* pre-defined variables.
bool IsPassword#
A value indicating if the text field is a password field (all entered characters show up as dots).
set
Turns the widget into a generic text field or into a password field. The default is 0.
set value -
Positive number to make the widget a password field, 0 to make it a generic text field.
bool IsEditable#
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. The default is 1.
set value -
Positive number to make the text field editable, 0 to make it read-only.
vec4 BorderColor#
Returns the current border color for the widget.
set
Sets the border color for the widget.
set value -
Four-component vector specifying the color in the RGBA format.
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
static WidgetEditLine ( Gui gui, string str = 0 ) #
Constructor. Creates a text field.Arguments
- Gui gui - GUI, to which the text field will belong.
- string str - Initial value. This is an optional parameter.
string GetSelectionText ( ) #
Returns currently selected text.Return value
Currently selected text.void ClearSelectionText ( ) #
Deletes currently selected text.void SetBackgroundColor ( vec4 color ) #
Sets the background color for the widget.Arguments
- vec4 color - Four-component vector specifying the color in the RGBA format.
vec4 GetBackgroundColor ( ) #
Returns the current background color for the widget.Return value
Four-component vector specifying the color in the RGBA format.void SetSelectionColor ( vec4 color ) #
Sets the color to be used to highlight the current selection for the widget.Arguments
- vec4 color - Four-component vector specifying the color in the RGBA format.
vec4 GetSelectionColor ( ) #
Returns the current color used to highlight the current selection for the widget.Return value
Four-component vector specifying the color in the RGBA format.void SetBorderColor ( vec4 color ) #
Sets the border color for the widget.Arguments
- vec4 color - Four-component vector specifying the color in the RGBA format.
vec4 GetBorderColor ( ) #
Returns the current border color for the widget.Return value
Four-component vector specifying the color in the RGBA format.Last update:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)