tk2dUITextInput Class Reference

TextInput control. More...

List of all members.

Public Member Functions

void SetFocus (bool focus)
 Sets or removes focus from the text input Currently you will need to manually need to remove focus and set focus on the new textinput if you wish to do this from a textInput callback, eg. auto advance when enter is pressed.

Public Attributes

tk2dUIItem selectionBtn
 UItem that will make cause TextInput to become selected on click.
tk2dTextMesh inputLabel
 TextMesh while text input will be displayed.
tk2dTextMesh emptyDisplayLabel
 TextMesh that will be displayed if nothing in inputLabel and is not selected.
GameObject unSelectedStateGO
 State to be active if text input is not selected.
GameObject selectedStateGO
 Stated to be active if text input is selected.
GameObject cursor
 Text cursor to be displayed at next of text input on selection.
float fieldLength = 1
 How long the field is (visible)
int maxCharacterLength = 30
 Maximum number of characters allowed for input.
string emptyDisplayText
 Text to be displayed when no text is entered and text input is not selected.
bool isPasswordField = false
 If set to true (is a password field), then all characters will be replaced with password char.
string passwordChar = "*"
 Each character in the password field is replaced with the first character of this string Default: * if string is empty.

Properties

string Text [get, set]
 Update the input text.

Detailed Description

TextInput control.


Member Function Documentation

void tk2dUITextInput.SetFocus ( bool  focus)

Sets or removes focus from the text input Currently you will need to manually need to remove focus and set focus on the new textinput if you wish to do this from a textInput callback, eg. auto advance when enter is pressed.


Member Data Documentation

Text cursor to be displayed at next of text input on selection.

TextMesh that will be displayed if nothing in inputLabel and is not selected.

Text to be displayed when no text is entered and text input is not selected.

How long the field is (visible)

TextMesh while text input will be displayed.

If set to true (is a password field), then all characters will be replaced with password char.

Maximum number of characters allowed for input.

Each character in the password field is replaced with the first character of this string Default: * if string is empty.

Stated to be active if text input is selected.

UItem that will make cause TextInput to become selected on click.

State to be active if text input is not selected.


Property Documentation

string tk2dUITextInput.Text [get, set]

Update the input text.