Torque Game Engine Documentation
TGE Version 1.5.2

GuiConsoleTextCtrl Class Reference

#include <guiConsoleTextCtrl.h>

Inheritance diagram for GuiConsoleTextCtrl:


Public Types
enum	Constants { MAX_STRING_LENGTH = 255 }
Public Member Functions
	DECLARE_CONOBJECT (GuiConsoleTextCtrl)
	GuiConsoleTextCtrl ()
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.
virtual void	setText (const char *txt=NULL)
const char *	getText ()
void	calcResize ()
void	onPreRender ()
	Do special pre-render proecessing.
void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
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.
Protected Attributes
const char *	mConsoleExpression
const char *	mResult
Resource< GFont >	mFont
Private Types
typedef GuiControl	Parent

Member Typedef Documentation

typedef GuiControl GuiConsoleTextCtrl::Parent [private]

Reimplemented from GuiControl.

Member Enumeration Documentation

enum GuiConsoleTextCtrl::Constants

Enumerator:

MAX_STRING_LENGTH

Constructor & Destructor Documentation

GuiConsoleTextCtrl::GuiConsoleTextCtrl ( )

Member Function Documentation

GuiConsoleTextCtrl::DECLARE_CONOBJECT ( GuiConsoleTextCtrl )

static void GuiConsoleTextCtrl::initPersistFields ( ) [static]

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

Reimplemented from GuiControl.

bool GuiConsoleTextCtrl::onWake ( ) [virtual]

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

Reimplemented from GuiControl.

void GuiConsoleTextCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

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

const char* GuiConsoleTextCtrl::getText ( ) [inline]

void GuiConsoleTextCtrl::calcResize ( )

void GuiConsoleTextCtrl::onPreRender ( ) [virtual]

Do special pre-render proecessing.

Reimplemented from GuiControl.

void GuiConsoleTextCtrl::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.

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

Returns the value of the variable bound to this object.

Reimplemented from GuiControl.

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

Sets the value of the variable bound to this object.

Reimplemented from GuiControl.

Field Documentation

const char* GuiConsoleTextCtrl::mConsoleExpression [protected]

const char* GuiConsoleTextCtrl::mResult [protected]

Resource<GFont> GuiConsoleTextCtrl::mFont [protected]

GuiConsoleTextCtrl Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation