GuiTextCtrl Class Reference

#include <guiTextCtrl.h>

Inheritance diagram for GuiTextCtrl:

Inheritance graph
[legend]
List of all members.

Public Types

 MAX_STRING_LENGTH = 1024
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 processing.
void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.
void displayText (S32 xOffset, S32 yOffset)
void autoResize ()
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< GFontmFont

Private Types

typedef GuiContainer Parent

Member Typedef Documentation


Member Enumeration Documentation

Enumerator:
MAX_STRING_LENGTH 


Constructor & Destructor Documentation

GuiTextCtrl::GuiTextCtrl (  ) 


Member Function Documentation

GuiTextCtrl::DECLARE_CONOBJECT ( GuiTextCtrl   ) 

static void GuiTextCtrl::initPersistFields (  )  [static]

bool GuiTextCtrl::onAdd (  )  [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

Reimplemented in GuiPopUpMenuCtrl, GuiPopUpMenuCtrlEx, 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 GuiPopUpMenuCtrl, GuiPopUpMenuCtrlEx, GuiTabPageCtrl, and GuiTextEditCtrl.

virtual void GuiTextCtrl::onSleep (  )  [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

Reimplemented in GuiPopUpMenuCtrl, GuiPopUpMenuCtrlEx, GuiTabPageCtrl, and GuiTextEditCtrl.

virtual void GuiTextCtrl::setText ( const char *  txt = NULL  )  [virtual]

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 processing.

Reimplemented from GuiContainer.

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 GuiPopUpMenuCtrl, GuiPopUpMenuCtrlEx, GuiTabPageCtrl, GuiTextEditCtrl, GuiTextEditSliderCtrl, and GuiProgressCtrl.

void GuiTextCtrl::displayText ( S32  xOffset,
S32  yOffset 
)

void GuiTextCtrl::autoResize (  ) 

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

Returns the value of the variable bound to this object.

Reimplemented from GuiControl.

Reimplemented in GuiPopUpMenuCtrl, GuiPopUpMenuCtrlEx, 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.


Member Data Documentation

UTF8 GuiTextCtrl::mText[MAX_STRING_LENGTH+1] [protected]