Torque3D Documentation / _generateds / GuiTextEditCtrl

GuiTextEditCtrl

Engine/source/gui/controls/guiTextEditCtrl.h

More...

Private Types

Parent 

Protected Functions

Public Functions

bool
dealWithEnter(bool clearResponder)
DECLARE_DESCRIPTION("A <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that allows <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> edit <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> single line of text. " )
drawText(const RectI & drawRect, bool isFocused)
getRenderText(char * dest)
const char *

Returns the value of the variable bound to this object.

getText(char * dest)

Get the contents of the control.

bool
invalidText(bool playSound)
bool
bool

Called when this object is added to the scene.

onCopy(bool andCut)
bool

Happens when a key is depressed.

Occurs when the control loses first-responder status.

Do special pre-render processing.

onRender(Point2I offset, const RectI & updateRect)

Called when this control is to render itself.

onStaticModified(const char * slotName, const char * newValue)

Specifically, these are called by setDataField when a static or dynamic field is modified, see the console details.

Sets this object to be a first responder.

setScriptValue(const char * value)

Sets the value of the variable bound to this object.

setSinkAllKeys(bool state)

Public Static Functions

const char *
getPlaceholderText(void * obj, const char * data)
bool
setPlaceholderText(void * object, const char * index, const char * data)

Detailed Description

Private Types

typedef GuiTextCtrl Parent 

Protected Attributes

S32 mBlockEnd 
S32 mBlockStart 
ColorI mCursorColor 
bool mCursorOn 
S32 mCursorPos 
SFXTrack * mDeniedSound 
S32 mDoubleClickTimeMS 
bool mDragHit 
String mEscapeCommand 
UTF16 ** mHistoryBuf 
bool mHistoryDirty 
S32 mHistoryIndex 
S32 mHistoryLast 
S32 mHistorySize 
bool mInsertOn 
S32 mMouseDragStart 
S32 mMouseUpTime 
S32 mNumFramesElapsed 
StringTableEntry mPasswordMask 
bool mPasswordText 
StringTableEntry mPlaceholderText 
S32 mScrollDir 
bool mSinkAllKeyEvents 

If set, any non-ESC key is handled here or not at all.

bool mTabComplete 
StringBuffer mTextBuffer 
Point2I mTextOffset 
bool mTextOffsetReset 
bool mTextValid 
U32 mTimeLastCursorFlipped 
S32 mUndoBlockEnd 
S32 mUndoBlockStart 
S32 mUndoCursorPos 
StringBuffer mUndoText 
String mValidateCommand 

Protected Functions

calculateCursorPos(const Point2I & globalPos)

DECLARE_CALLBACK(void , onReturn , () )

DECLARE_CALLBACK(void , onTabComplete , (const char *val) )

DECLARE_CALLBACK(void , onValidate , () )

execConsoleCallback()

findNextWord()

findPrevWord()

handleCharInput(U16 ascii)

playDeniedSound()

saveUndoState()

updateHistory(StringBuffer * txt, bool moveIndex)

Public Functions

GuiTextEditCtrl()

~GuiTextEditCtrl()

clearSelectedText()

dealWithEnter(bool clearResponder)

DECLARE_CONOBJECT(GuiTextEditCtrl )

DECLARE_DESCRIPTION("A <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that allows <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> edit <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> single line of text. " )

drawText(const RectI & drawRect, bool isFocused)

forceValidateText()

getCursorPos()

getPlaceholderText()

getRenderText(char * dest)

getScriptValue()

Reimplemented from: GuiTextCtrl

getSinkAllKeys()

getText(char * dest)

Get the contents of the control.

dest should be of size GuiTextCtrl::MAX_STRING_LENGTH+1.

hasText()

invalidText(bool playSound)

isAllTextSelected()

isPasswordText()

isValidText()

onAdd()

Reimplemented from: GuiTextCtrl

onCopy(bool andCut)

onKeyDown(const GuiEvent & event)

Reimplemented from: GuiControl

Reimplemented by: GuiConsoleEditCtrl, GuiTextEditSliderBitmapCtrl, GuiTextEditSliderCtrl

onLoseFirstResponder()

Reimplemented from: GuiControl

onMouseDown(const GuiEvent & event)

Reimplemented from: GuiControl

Reimplemented by: GuiTextEditSliderBitmapCtrl, GuiTextEditSliderCtrl

onMouseDragged(const GuiEvent & event)

Reimplemented from: GuiControl

Reimplemented by: GuiTextEditSliderBitmapCtrl, GuiTextEditSliderCtrl

onMouseUp(const GuiEvent & event)

Reimplemented from: GuiControl

Reimplemented by: GuiTextEditSliderBitmapCtrl, GuiTextEditSliderCtrl

onPaste()

onPreRender()

Reimplemented from: GuiTextCtrl

Reimplemented by: GuiTextEditSliderBitmapCtrl, GuiTextEditSliderCtrl

onRender(Point2I offset, const RectI & updateRect)

Reimplemented from: GuiTextCtrl

Reimplemented by: GuiTextEditSliderBitmapCtrl, GuiTextEditSliderCtrl

onStaticModified(const char * slotName, const char * newValue)

Reimplemented from: SimObject

onUndo()

selectAllText()

setCursorPos(const S32 newPos)

setFirstResponder()

Reimplemented from: GuiControl

setPlaceholderText(const char * txt)

setScriptValue(const char * value)

Reimplemented from: GuiTextCtrl

setSinkAllKeys(bool state)

setText(const UTF16 * txt)

setText(const UTF8 * txt)

setText(S32 tag)

validText()

Public Static Functions

getPlaceholderText(void * obj, const char * data)

initPersistFields()

setPlaceholderText(void * object, const char * index, const char * data)