This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

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

static WidgetEditLine ( string str = 0 ) #

Constructor. Creates a text field and adds it to the Engine GUI.

Arguments

  • 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.
Last update: 2020-07-31
Build: ()