Unigine::WidgetEditText Class

WidgetEditText Class

Members

void setText ( const char * text ) #

Arguments

• const char * text - The text contained in the text field.

const char * getText() const#

Return value

Current text contained in the text field.

int getNumLines() const#

Return value

Current number of lines.

int getSelectionLine() const#

Return value

Current line number.

int getSelectionPosition() const#

Return value

Current position number.

int getCursorLine() const#

Return value

Current line number.

int getCursorPosition() const#

Return value

Current position number.

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

Arguments

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

Math::vec4 getNumberColor() const#

Return value

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

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

Arguments

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

Math::vec4 getSelectionColor() const#

Return value

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

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

Arguments

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

Math::vec4 getBackgroundColor() const#

Return value

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

void setBackground ( int background ) #

Arguments

• int background - The 1 is to render a background texture; 0 is not to render.

int getBackground() const#

Return value

Current 1 is to render a background texture; 0 is not to render.

void setEditable ( bool editable ) #

Arguments

• bool editable - Set true to enable editing of the text field contents; false - to disable it.

bool isEditable() const#

Return value

true if editing of the text field contents is enabled; otherwise false.

int getCursorPositionX() const#

Return value

Current value of the text cursor position X coordinate, in pixels.

int getCursorPositionY() const#

Return value

Current value of the text cursor position Y coordinate, in pixels.

int getCursorWidth() const#

Return value

Current text cursor width, in pixels.

void setUseScrollWheelEnabled ( bool enabled ) #

Arguments

• bool enabled - Set true to enable changing the line on scrolling; false - to disable it.

bool isUseScrollWheelEnabled() const#

Return value

true if changing the line on scrolling is enabled; otherwise false.

void setStyleTextureBackground ( const char * background ) #

Arguments

• const char * background - The path to the texture to be used as a background of the widget.

const char * getStyleTextureBackground() const#

Return value

Current path to the texture to be used as a background of the widget.

void setStyleTextureSelection ( const char * selection ) #

Arguments

• const char * selection - The path to the texture to be used as a background for the selected text.

const char * getStyleTextureSelection() const#

Return value

Current path to the texture to be used as a background for the selected text.

---

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

Constructor. Creates a multiline 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 WidgetEditTextPtr create ( const char * str = 0 ) #

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

Arguments

• const char * 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, const char * str ) #

Sets new contents for a given line.

Arguments

• int line - Line number.
• const char * str - Text.

String getLineText ( int line ) const#

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

Returns the currently selected text.

Return value

Currently selected text.

void setTokenColor ( const char * token, const Math::vec4 & color ) #

Sets a color for a given token. The token will be highlighted with the provided color.

Arguments

• const char * token - Token (i.e. keyword, identifier, etc).
• const Math::vec4 & color - Color.

Math::vec4 getTokenColor ( const char * token ) const#

Returns a color, which is used to highlight a given token.

Arguments

• const char * token - Token (i.e. keyword, identifier, etc).

Return value

Color of the current token.

void setTokensColor ( const char * tokens, const Math::vec4 & color ) #

Sets a color to given tokens. Each token will be highlighted with the provided color.

Arguments

• const char * tokens - Comma-separated list of tokens (i.e. keywords, identifiers, etc).
• const Math::vec4 & color - Color.

int addLine ( const char * str = 0 ) #

Adds a new line to the widget.

Arguments

• const char * 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.

int getLineWidth ( int line, int end = -1 ) const#

Returns the text line width (space taken by symbols).

Arguments

• int line - The line index from 0 to the total number of lines.
• int end - The index of the last symbol up to which the line width is returned. If set to -1, the whole set of symbols in the line is taken.

Return value

The text line width, in pixels.