This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Animations-Related Classes
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
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::WidgetEditLine Class

Header: #include <UnigineWidgets.h>
Inherits from: Widget

This class creates an editable single-line text field containing a text string.

See Also#

WidgetEditLine Class

Members


static WidgetEditLinePtr create ( const Ptr<Gui> & gui, const char * str = 0 ) #

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

Arguments

  • const Ptr<Gui> & gui - GUI, to which the text field will belong.
  • const char * str - Initial value. This is an optional parameter.

static WidgetEditLinePtr create ( const char * str = 0 ) #

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

Arguments

  • const char * str - Initial value. This is an optional parameter.

void setBackground ( int background ) #

Sets a value indicating if a background texture should be rendered for the text field. The default is 1.

Arguments

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

int getBackground ( ) const#

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. The default is 1.

void setCapacity ( int capacity ) #

Sets a maximum length of a string entered into the text field. The default is 1024.

Arguments

  • int capacity - Maximum number of characters.

int getCapacity ( ) const#

Returns the maximum length of a string entered into the text field.

Return value

Maximum number of characters. The default is 1024.

void setCursor ( int cursor ) #

Sets a cursor position in the text field.

Arguments

  • int cursor - Cursor position. The provided value will be saturated in the range from 0 to text field capacity.

int getCursor ( ) const#

Returns the current cursor position in the text field.

Return value

Cursor position.

void setEditable ( bool editable ) #

Sets a value indicating if the contents of the text field can be edited. The default is 1.

Arguments

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

bool isEditable ( ) const#

Returns a value indicating if the contents of the text field can be edited. The default is 1.

Return value

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

void setPassword ( bool password ) #

Turns the widget into a generic text field or into a password field. The default is 0.

Arguments

  • bool password - Positive number to make the widget a password field, 0 to make it a generic text field.

bool isPassword ( ) const#

Returns a value indicating if the text field is a password field (all entered characters show up as dots).

Return value

Positive number if the widget is a password field; otherwise, 0. The default is 0.

void setSelection ( int selection ) #

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

Arguments

  • int selection - Position, from which the selection will start.

int getSelection ( ) const#

Returns a position, from which the selection starts.

Return value

Position, from which the selection starts.

String getSelectionText ( ) const#

Returns currently selected text.

Return value

Currently selected text.

void setText ( const char * text ) #

Sets a text for the text field.

Arguments

  • const char * text - Text string.

const char * getText ( ) const#

Returns the current contents of the text field.

Return value

Text string.

void setValidator ( int validator ) #

Sets a validator for the text filed contents.

Arguments

  • int validator - One of the Gui:: Enumeration with VALIDATOR_* prefixes.

int getValidator ( ) const#

Returns the validator associated with the text field. The default is VALIDATOR_ANY.

Return value

One of the Gui:: Enumeration with VALIDATOR_* prefixes.

void clearSelectionText ( ) #

Deletes currently selected text.

void setBackgroundColor ( const Math::vec4 & color ) #

Sets the background color for the widget.

Arguments

  • const Math::vec4 & color - The four-component vector specifying the color in the RGBA format.

Math::vec4 getBackgroundColor ( ) const#

Returns the current background color for the widget.

Return value

The four-component vector specifying the color in the RGBA format.

void setSelectionColor ( const Math::vec4 & color ) #

Sets the color to be used to highlight the current selection for the widget.

Arguments

  • const Math::vec4 & color - The four-component vector specifying the color in the RGBA format.

Math::vec4 getSelectionColor ( ) const#

Returns the current color used to highlight the current selection for the widget.

Return value

The four-component vector specifying the color in the RGBA format.

void setBorderColor ( const Math::vec4 & color ) #

Sets the border color for the widget.

Arguments

  • const Math::vec4 & color - The four-component vector specifying the color in the RGBA format.

Math::vec4 getBorderColor ( ) const#

Returns the current border color for the widget.

Return value

The four-component vector specifying the color in the RGBA format.
Last update: 2023-01-11
Build: ()