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
FAQ
编程
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
应用程序接口
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
Rendering-Related Classes
注意! 这个版本的文档是过时的,因为它描述了一个较老的SDK版本!请切换到最新SDK版本的文档。
注意! 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

Unigine::WidgetEditLine Class

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

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

WidgetEditLine Class

Members


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

Constructor. Creates a text field.

Arguments

  • const Ptr<Gui> & gui - GUI, to which the text field will belong.
  • 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 ( ) #

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 ( ) #

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 ( ) #

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 ( ) #

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 ( ) #

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 ( ) #

Returns a position, from which the selection starts.

Return value

Position, from which the selection starts.

String getSelectionText ( ) #

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 ( ) #

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 ( ) #

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 - Four-component vector specifying the color in the RGBA format.

Math::vec4 getBackgroundColor ( ) #

Returns the current background color for the widget.

Return value

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 - Four-component vector specifying the color in the RGBA format.

Math::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 ( const Math::vec4 & color ) #

Sets the border color for the widget.

Arguments

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

Math::vec4 getBorderColor ( ) #

Returns the current border color for the widget.

Return value

Four-component vector specifying the color in the RGBA format.
Last update: 2019-12-25
Build: ()