torque Torque Game Engine Documentation
TGE Version 1.5.2

GuiTextEditCtrl Class Reference

#include <guiTextEditCtrl.h>

Inheritance diagram for GuiTextEditCtrl:

Inheritance graph
[legend]

Public Member Functions

 GuiTextEditCtrl ()
 ~GuiTextEditCtrl ()
 DECLARE_CONOBJECT (GuiTextEditCtrl)
bool onAdd ()
 Called when this object is added to the scene.
bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
void onSleep ()
 Called when this object is asked to sleep.
void getText (char *dest)
bool initCursors ()
void getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
 Get information about the cursor.
void setText (S32 tag)
virtual void setText (const UTF8 *txt)
virtual void setText (const UTF16 *txt)
S32 getCursorPos ()
void reallySetCursorPos (const S32 newPos)
void selectAllText ()
void forceValidateText ()
const char * getScriptValue ()
 Returns the value of the variable bound to this object.
void setScriptValue (const char *value)
 Sets the value of the variable bound to this object.
bool onKeyDown (const GuiEvent &event)
 Happens when a key is depressed.
void onMouseDown (const GuiEvent &event)
void onMouseDragged (const GuiEvent &event)
void onMouseUp (const GuiEvent &event)
void onCopy (bool andCut)
void onPaste ()
void onUndo ()
virtual void setFirstResponder ()
 Sets this object to be a first responder.
virtual void onLoseFirstResponder ()
 Occurs when the first responder for this chain is lost.
void parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)
 Called when this objects parent is resized.
bool hasText ()
void onStaticModified (const char *slotName)
 Called when a static field is modified.
void onPreRender ()
 Do special pre-render proecessing.
void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.
virtual void drawText (const RectI &drawRect, bool isFocused)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Protected Member Functions

void saveUndoState ()
S32 setCursorPos (const Point2I &offset)
void updateHistory (StringBuffer *txt, bool moveIndex)
void playDeniedSound ()
void execConsoleCallback ()

Protected Attributes

StringBuffer mTextBuffer
StringTableEntry mValidateCommand
StringTableEntry mEscapeCommand
AudioProfilemDeniedSound
S32 mNumFramesElapsed
U32 mTimeLastCursorFlipped
ColorI mCursorColor
bool mCursorOn
GuiCursormEditCursor
bool mInsertOn
S32 mMouseDragStart
Point2I mTextOffset
bool mTextOffsetReset
bool mDragHit
bool mTabComplete
S32 mScrollDir
StringBuffer mUndoText
S32 mUndoBlockStart
S32 mUndoBlockEnd
S32 mUndoCursorPos
S32 mBlockStart
S32 mBlockEnd
S32 mCursorPos
bool mHistoryDirty
S32 mHistoryLast
S32 mHistoryIndex
S32 mHistorySize
bool mPasswordText
StringTableEntry mPasswordMask
bool mSinkAllKeyEvents
UTF16 ** mHistoryBuf

Private Types

typedef GuiTextCtrl Parent

Static Private Attributes

static U32 smNumAwake

Member Typedef Documentation

Reimplemented from GuiTextCtrl.

Reimplemented in GuiConsoleEditCtrl, and GuiTextEditSliderCtrl.


Constructor & Destructor Documentation

GuiTextEditCtrl::GuiTextEditCtrl (  ) 

GuiTextEditCtrl::~GuiTextEditCtrl (  ) 


Member Function Documentation

void GuiTextEditCtrl::saveUndoState (  )  [protected]

S32 GuiTextEditCtrl::setCursorPos ( const Point2I offset  )  [protected]

void GuiTextEditCtrl::updateHistory ( StringBuffer txt,
bool  moveIndex 
) [protected]

void GuiTextEditCtrl::playDeniedSound (  )  [protected]

void GuiTextEditCtrl::execConsoleCallback (  )  [protected]

GuiTextEditCtrl::DECLARE_CONOBJECT ( GuiTextEditCtrl   ) 

static void GuiTextEditCtrl::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from GuiTextCtrl.

Reimplemented in GuiConsoleEditCtrl, and GuiTextEditSliderCtrl.

bool GuiTextEditCtrl::onAdd (  )  [virtual]

Called when this object is added to the scene.

Reimplemented from GuiTextCtrl.

bool GuiTextEditCtrl::onWake (  )  [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiTextCtrl.

void GuiTextEditCtrl::onSleep (  )  [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiTextCtrl.

void GuiTextEditCtrl::getText ( char *  dest  ) 

Reimplemented in GuiTextEditSliderCtrl.

bool GuiTextEditCtrl::initCursors (  ) 

void GuiTextEditCtrl::getCursor ( GuiCursor *&  cursor,
bool &  showCursor,
const GuiEvent lastGuiEvent 
) [virtual]

Get information about the cursor.

Parameters:
cursor Cursor information will be stored here
showCursor Will be set to true if the cursor is visible
lastGuiEvent GuiEvent containing cursor position and modifyer keys (ie ctrl, shift, alt etc)

Reimplemented from GuiControl.

void GuiTextEditCtrl::setText ( S32  tag  ) 

Reimplemented in GuiTextEditSliderCtrl.

virtual void GuiTextEditCtrl::setText ( const UTF8 txt  )  [virtual]

Reimplemented from GuiTextCtrl.

Reimplemented in GuiTextEditSliderCtrl.

virtual void GuiTextEditCtrl::setText ( const UTF16 txt  )  [virtual]

S32 GuiTextEditCtrl::getCursorPos (  )  [inline]

void GuiTextEditCtrl::reallySetCursorPos ( const S32  newPos  ) 

void GuiTextEditCtrl::selectAllText (  ) 

void GuiTextEditCtrl::forceValidateText (  ) 

const char* GuiTextEditCtrl::getScriptValue (  )  [virtual]

Returns the value of the variable bound to this object.

Reimplemented from GuiTextCtrl.

void GuiTextEditCtrl::setScriptValue ( const char *  value  )  [virtual]

Sets the value of the variable bound to this object.

Reimplemented from GuiTextCtrl.

bool GuiTextEditCtrl::onKeyDown ( const GuiEvent event  )  [virtual]

Happens when a key is depressed.

Parameters:
event Event descriptor (which contains the key)

Reimplemented from GuiControl.

Reimplemented in GuiConsoleEditCtrl, and GuiTextEditSliderCtrl.

void GuiTextEditCtrl::onMouseDown ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

Reimplemented in GuiTextEditSliderCtrl.

void GuiTextEditCtrl::onMouseDragged ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

Reimplemented in GuiTextEditSliderCtrl.

void GuiTextEditCtrl::onMouseUp ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

Reimplemented in GuiTextEditSliderCtrl.

void GuiTextEditCtrl::onCopy ( bool  andCut  ) 

void GuiTextEditCtrl::onPaste (  ) 

void GuiTextEditCtrl::onUndo (  ) 

virtual void GuiTextEditCtrl::setFirstResponder (  )  [virtual]

Sets this object to be a first responder.

Reimplemented from GuiControl.

virtual void GuiTextEditCtrl::onLoseFirstResponder (  )  [virtual]

Occurs when the first responder for this chain is lost.

Reimplemented from GuiControl.

void GuiTextEditCtrl::parentResized ( const Point2I oldParentExtent,
const Point2I newParentExtent 
) [virtual]

Called when this objects parent is resized.

Parameters:
oldParentExtent The old size of the parent object
newParentExtent The new size of the parent object

Reimplemented from GuiControl.

bool GuiTextEditCtrl::hasText (  ) 

void GuiTextEditCtrl::onStaticModified ( const char *  slotName  )  [virtual]

Called when a static field is modified.

Specifically, this is called by setDataField when a static field is modified, see the console details.

Reimplemented from SimObject.

void GuiTextEditCtrl::onPreRender (  )  [virtual]

Do special pre-render proecessing.

Reimplemented from GuiTextCtrl.

Reimplemented in GuiTextEditSliderCtrl.

void GuiTextEditCtrl::onRender ( Point2I  offset,
const RectI updateRect 
) [virtual]

Called when this control is to render itself.

Parameters:
offset The location this control is to begin rendering
updateRect The screen area this control has drawing access to

Reimplemented from GuiTextCtrl.

Reimplemented in GuiTextEditSliderCtrl.

virtual void GuiTextEditCtrl::drawText ( const RectI drawRect,
bool  isFocused 
) [virtual]


Field Documentation

U32 GuiTextEditCtrl::smNumAwake [static, private]

bool GuiTextEditCtrl::mCursorOn [protected]

bool GuiTextEditCtrl::mInsertOn [protected]

bool GuiTextEditCtrl::mDragHit [protected]




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen