GuiTextEditCtrl Class Reference

#include <guiTextEditCtrl_ScriptBinding.h>

Inherits GuiControl.

Public Member Functions
Boolean	forceValidateText ()"
Integer	getCursorPos ()"
String	getInputMode ()
Boolean	getIsPassword ()
Boolean	getMaxLength ()
Boolean	getReturnCausesTab ()
Boolean	getSinkAllKeyEvents ()
void	selectAllText ()"
void	setCursorPos (newPos)"
void	setInputMode (mode)
void	setIsPassword (setting)
void	setMaxLength (max)
void	setReturnCausesTab (setting)
void	setSinkAllKeyEvents (setting)
Boolean	validate ()"
Public Member Functions inherited from GuiControl
void	addGuiControl (int controlId)
Integer	findHitControl (int x, int y)
String	getCenter ()
String	getExtent (...)
String	getGlobalCenter ()
String	getGlobalPosition ()
String	getMinExtent ()
Integer	getParent ()
String	getPosition ()
String	getText ()
Boolean	getTextExtend ()
Boolean	getTextWrap ()
String	getValue ()
Boolean	isActive ()
Boolean	isAwake ()
Boolean	isVisible ()
void	makeFirstResponder (isFirst)
void	performClick ()
Boolean	pointInControl (int x, int y)
void	reorderChild (child1, child2)
void	resize (int x, int y, int w, int h)
void	setActive (isActive)
void	setCanSave (bool canSave)
void	setCenter (int x, int y)
void	setExtent (int width, int height)
void	setFirstResponder ()
void	setPosition (int x, int y)
void	setPositionGlobal (int x, int y)
void	setProfile (GuiControlProfile p)
void	setText (text)
void	setTextExtend (setting)
void	setTextID (id)
void	setTextWrap (setting)
void	setValue (value)
void	setVisible (isVisible)

Member Function Documentation

forceValidateText()

Boolean forceValidateText

(

)

Calls the validation function for the control. This is depreciated. Please use validate() instead.

Returns

No return value.

getCursorPos()

Integer getCursorPos

(

)

Gets the current position of the text cursor in the control.

Returns

The current position of the text cursor in the control, where 0 is at the beginning of the line, 1 is after the first letter, and so on.

getInputMode()

String getInputMode

(

)

Gets the text edit InputMode.

Returns

The InputMode.

getIsPassword()

Boolean getIsPassword

(

)

Returns if the password flag is on.

Returns

Returns the state of the password flag.

getMaxLength()

Boolean getMaxLength

(

)

Returns if the current maxLength.

Returns

Returns the maxLength.

getReturnCausesTab()

Boolean getReturnCausesTab

(

)

Returns if the returnCausesTab flag is on.

Returns

Returns the state of the returnCausesTab flag.

getSinkAllKeyEvents()

Boolean getSinkAllKeyEvents

(

)

Returns if the sinkAllKeyEvents flag is on.

Returns

Returns the state of the sinkAllKeyEvents flag.

selectAllText()

void selectAllText

(

)

Selects all the text in the control.

Returns

No return value.

setCursorPos()

void setCursorPos

(

newPos

)

Sets the current position of the text cursor in the control.

Parameters

newPos

The new position to place the cursor at, where 0 is at the beginning of the line, 1 is after the first letter, and so on.

Returns

No return value.

setInputMode()

void setInputMode

(

mode

)

Sets the InputMode. Possible values include AllText, Decimal, Number, Alpha, and AlphaNumeric.

Parameters

mode	The InputMode to use.

Returns

No return value.

setIsPassword()

void setIsPassword

(

setting

)

Sets the password flag.

Parameters

setting

True to turn on the flag. False otherwise.

Returns

No return value

setMaxLength()

void setMaxLength

(

max

)

Sets the maxLength which is the max number of characters that can be entered in the text edit box.

Parameters

max	An integer value between 1 and 1024.

Returns

No return value

setReturnCausesTab()

void setReturnCausesTab

(

setting

)

Sets the returnCausesTab flag. If true, the pressing enter will attempt to tab to the next control. False will keep the focus in this control.

Parameters

setting

True to turn on the flag. False otherwise.

Returns

No return value

setSinkAllKeyEvents()

void setSinkAllKeyEvents

(

setting

)

Sets the sinkAllKeyEvents flag.

Parameters

setting

True to turn on the flag. False otherwise.

Returns

No return value

validate()

Boolean validate

(

)

Calls the validation function for the control.

Returns

No return value.