Torque Game Engine Documentation
TGE Version 1.5.2

GuiInspectorField Class Reference

#include <guiInspector.h>

Inheritance diagram for GuiInspectorField:


Public Member Functions
	GuiInspectorField (GuiInspectorGroup parent, SimObjectPtr< SimObject > target, AbstractClassRep::Field field)
	GuiInspectorField ()
	~GuiInspectorField ()
	DECLARE_CONOBJECT (GuiInspectorField)
virtual void	setTarget (SimObjectPtr< SimObject > target)
virtual void	setParent (GuiInspectorGroup *parent)
virtual void	setField (AbstractClassRep::Field field, const char arrayIndex=NULL)
virtual GuiControl *	constructEditControl ()
virtual void	updateValue (StringTableEntry newValue)
virtual StringTableEntry	getFieldName ()
virtual void	setData (StringTableEntry data)
virtual StringTableEntry	getData ()
virtual void	resize (const Point2I &newPosition, const Point2I &newExtent)
	Changes the size and/or position of this control.
virtual bool	onAdd ()
	Called when this object is added to the scene.
virtual void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
Data Fields
StringTableEntry	mCaption
GuiInspectorGroup *	mParent
SimObjectPtr< SimObject >	mTarget
AbstractClassRep::Field *	mField
StringTableEntry	mFieldArrayIndex
GuiControl *	mEdit
Static Public Attributes
static S32	smCaptionWidth
Protected Member Functions
void	registerEditControl (GuiControl *ctrl)
Private Types
typedef GuiControl	Parent

Member Typedef Documentation

typedef GuiControl GuiInspectorField::Parent [private]

Reimplemented from GuiControl.

Reimplemented in GuiInspectorDynamicField, GuiInspectorDatablockField, GuiInspectorTypeEnum, GuiInspectorTypeCheckBox, GuiInspectorTypeGuiProfile, GuiInspectorTypeFileName, GuiInspectorTypeColor, GuiInspectorTypeColorI, and GuiInspectorTypeColorF.

Constructor & Destructor Documentation

GuiInspectorField::GuiInspectorField	(	GuiInspectorGroup *	parent,
		SimObjectPtr< SimObject >	target,
		AbstractClassRep::Field *	field
	)

GuiInspectorField::GuiInspectorField ( )

GuiInspectorField::~GuiInspectorField ( )

Member Function Documentation

GuiInspectorField::DECLARE_CONOBJECT ( GuiInspectorField )

virtual void GuiInspectorField::setTarget ( SimObjectPtr< SimObject > target ) [inline, virtual]

virtual void GuiInspectorField::setParent ( GuiInspectorGroup * parent ) [inline, virtual]

virtual void GuiInspectorField::setField	(	AbstractClassRep::Field *	field,
		const char *	arrayIndex = `NULL`
	)			`[virtual]`

void GuiInspectorField::registerEditControl ( GuiControl * ctrl ) [protected]

virtual GuiControl* GuiInspectorField::constructEditControl ( ) [virtual]

Reimplemented in GuiInspectorDatablockField, GuiInspectorTypeEnum, GuiInspectorTypeCheckBox, GuiInspectorTypeGuiProfile, GuiInspectorTypeFileName, and GuiInspectorTypeColor.

virtual void GuiInspectorField::updateValue ( StringTableEntry newValue ) [virtual]

Reimplemented in GuiInspectorTypeEnum.

virtual StringTableEntry GuiInspectorField::getFieldName ( ) [virtual]

Reimplemented in GuiInspectorDynamicField.

virtual void GuiInspectorField::setData ( StringTableEntry data ) [virtual]

Reimplemented in GuiInspectorDynamicField, and GuiInspectorTypeEnum.

virtual StringTableEntry GuiInspectorField::getData ( ) [virtual]

Reimplemented in GuiInspectorDynamicField, and GuiInspectorTypeEnum.

virtual void GuiInspectorField::resize	(	const Point2I &	newPosition,
		const Point2I &	newExtent
	)			`[virtual]`

Changes the size and/or position of this control.

Parameters:

	newPosition	New position of this control
	newExtent	New size of this control

Reimplemented from GuiControl.

Reimplemented in GuiInspectorDynamicField, GuiInspectorTypeFileName, and GuiInspectorTypeColor.

virtual bool GuiInspectorField::onAdd ( ) [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

Reimplemented in GuiInspectorDynamicField.

virtual void GuiInspectorField::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 GuiInspectorDynamicField.

Field Documentation

S32 GuiInspectorField::smCaptionWidth [static]

StringTableEntry GuiInspectorField::mCaption

GuiInspectorGroup* GuiInspectorField::mParent

SimObjectPtr<SimObject> GuiInspectorField::mTarget

AbstractClassRep::Field* GuiInspectorField::mField

StringTableEntry GuiInspectorField::mFieldArrayIndex

GuiControl* GuiInspectorField::mEdit

GuiInspectorField Class Reference

Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Private Types

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation