PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI Class Reference

NGUI text field UI implementation. More...

Inheritance diagram for PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI:
Collaboration diagram for PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI:

Public Member Functions

void StartTextInput (string labelText, string text, int maxLength, AcceptedTextDelegate acceptedText)
 Starts the text input field. More...
 
void Update ()
 Ensure that the text field keeps focus. More...
 
void CancelTextInput ()
 Cancels the text input field. More...
 
void AcceptTextInput ()
 Accepts the text input and calls the accept handler delegate. More...
 

Public Attributes

UIPanel panel
 The (optional) panel. More...
 
UILabel label
 The label that will contain any label text prompting the user what to enter. More...
 
UIInput textField
 The text field. More...
 
bool alwaysKeepFocus = true
 Set this true to prevent the user from deselecting the text field. More...
 

Detailed Description

NGUI text field UI implementation.

Member Function Documentation

◆ AcceptTextInput()

void PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI.AcceptTextInput ( )

Accepts the text input and calls the accept handler delegate.

◆ CancelTextInput()

void PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI.CancelTextInput ( )

Cancels the text input field.

Implements PixelCrushers.DialogueSystem.ITextFieldUI.

◆ StartTextInput()

void PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI.StartTextInput ( string  labelText,
string  text,
int  maxLength,
AcceptedTextDelegate  acceptedText 
)

Starts the text input field.

Parameters
labelTextThe label text.
textThe current value to use for the input field.
maxLengthMax length, or 0 for unlimited.
acceptedTextThe delegate to call when accepting text.

Implements PixelCrushers.DialogueSystem.ITextFieldUI.

◆ Update()

void PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI.Update ( )

Ensure that the text field keeps focus.

Member Data Documentation

◆ alwaysKeepFocus

bool PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI.alwaysKeepFocus = true

Set this true to prevent the user from deselecting the text field.

◆ label

UILabel PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI.label

The label that will contain any label text prompting the user what to enter.

◆ panel

UIPanel PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI.panel

The (optional) panel.

If your text field UI contains more than a label and text field, you should assign the panel, too.

◆ textField

UIInput PixelCrushers.DialogueSystem.NGUI.NGUITextFieldUI.textField

The text field.


The documentation for this class was generated from the following file: