Torque Game Engine Documentation TGE Version 1.5.2

Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

GuiTextCtrl Class Reference #include <guiTextCtrl.h> Inheritance diagram for GuiTextCtrl: [legend] Public Types enum   Constants { MAX_STRING_LENGTH = 1024 } Public Member Functions   DECLARE_CONOBJECT (GuiTextCtrl)   GuiTextCtrl () bool  onAdd ()   Called when this object is added to the scene. virtual bool  onWake ()   Called when this object is asked to wake up returns true if it's actually awake at the end. virtual void  onSleep ()   Called when this object is asked to sleep. virtual void  setText (const char *txt=NULL) virtual void  setTextID (S32 id) virtual void  setTextID (const char *id) const char *  getText () void  inspectPostApply ()   Called after any property of the object is changed in the world editor. void  onPreRender ()   Do special pre-render proecessing. void  onRender (Point2I offset, const RectI &updateRect)   Called when this control is to render itself. void  displayText (S32 xOffset, S32 yOffset) 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. Static Public Member Functions static void  initPersistFields ()   Register dynamic fields in a subclass of ConsoleObject. static bool  setText (void *obj, const char *data) static const char *  getTextProperty (void *obj, const char *data) Protected Attributes StringTableEntry  mInitialText StringTableEntry  mInitialTextID UTF8  mText [MAX_STRING_LENGTH+1] S32  mMaxStrLen Resource< GFont >  mFont Private Types typedef GuiControl  Parent Member Typedef Documentation typedef GuiControl GuiTextCtrl::Parent [private] Reimplemented from GuiControl. Reimplemented in DebugView, GuiWindowCtrl, GuiConsoleEditCtrl, GuiPopUpMenuCtrl, GuiTabPageCtrl, GuiTextEditCtrl, GuiTextEditSliderCtrl, GuiProgressCtrl, and GuiBubbleTextCtrl. Member Enumeration Documentation enum GuiTextCtrl::Constants Enumerator: MAX_STRING_LENGTH  Constructor & Destructor Documentation GuiTextCtrl::GuiTextCtrl (  )  Member Function Documentation GuiTextCtrl::DECLARE_CONOBJECT ( GuiTextCtrl   )  static void GuiTextCtrl::initPersistFields (  )  [static] Register dynamic fields in a subclass of ConsoleObject. See also: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup() Reimplemented from GuiControl. Reimplemented in GuiWindowCtrl, GuiConsoleEditCtrl, GuiPopUpMenuCtrl, GuiTabPageCtrl, GuiTextEditCtrl, and GuiTextEditSliderCtrl. bool GuiTextCtrl::onAdd (  )  [virtual] Called when this object is added to the scene. Reimplemented from GuiControl. Reimplemented in GuiPopUpMenuCtrl, and GuiTextEditCtrl. virtual bool GuiTextCtrl::onWake (  )  [virtual] Called when this object is asked to wake up returns true if it's actually awake at the end. Reimplemented from GuiControl. Reimplemented in GuiWindowCtrl, GuiTabPageCtrl, and GuiTextEditCtrl. virtual void GuiTextCtrl::onSleep (  )  [virtual] Called when this object is asked to sleep. Reimplemented from GuiControl. Reimplemented in GuiWindowCtrl, GuiPopUpMenuCtrl, GuiTabPageCtrl, and GuiTextEditCtrl. virtual void GuiTextCtrl::setText ( const char *  txt = NULL  )  [virtual] Reimplemented in GuiTabPageCtrl, GuiTextEditCtrl, and GuiTextEditSliderCtrl. virtual void GuiTextCtrl::setTextID ( S32  id  )  [virtual] virtual void GuiTextCtrl::setTextID ( const char *  id  )  [virtual] const char* GuiTextCtrl::getText (  )  [inline] static bool GuiTextCtrl::setText ( void *  obj, const char *  data   ) [inline, static] static const char* GuiTextCtrl::getTextProperty ( void *  obj, const char *  data   ) [inline, static] void GuiTextCtrl::inspectPostApply (  )  [virtual] Called after any property of the object is changed in the world editor. See also: inspectPreApply Reimplemented from GuiControl. void GuiTextCtrl::onPreRender (  )  [virtual] Do special pre-render proecessing. Reimplemented from GuiControl. Reimplemented in GuiTextEditCtrl, GuiTextEditSliderCtrl, and GuiProgressCtrl. void GuiTextCtrl::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 GuiControl. Reimplemented in DebugView, GuiWindowCtrl, GuiPopUpMenuCtrl, GuiTabPageCtrl, GuiTextEditCtrl, GuiTextEditSliderCtrl, and GuiProgressCtrl. void GuiTextCtrl::displayText ( S32  xOffset, S32  yOffset   ) const char* GuiTextCtrl::getScriptValue (  )  [virtual] Returns the value of the variable bound to this object. Reimplemented from GuiControl. Reimplemented in GuiPopUpMenuCtrl, GuiTextEditCtrl, and GuiProgressCtrl. void GuiTextCtrl::setScriptValue ( const char *  value  )  [virtual] Sets the value of the variable bound to this object. Reimplemented from GuiControl. Reimplemented in GuiTextEditCtrl, and GuiProgressCtrl. Field Documentation StringTableEntry GuiTextCtrl::mInitialText [protected] StringTableEntry GuiTextCtrl::mInitialTextID [protected] UTF8 GuiTextCtrl::mText[MAX_STRING_LENGTH+1] [protected] S32 GuiTextCtrl::mMaxStrLen [protected] Resource<GFont> GuiTextCtrl::mFont [protected]

---

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

© GarageGames.com Home Back to Top