GuiToolboxButtonCtrl Class Reference

#include <guiToolboxButtonCtrl.h>

Inheritance diagram for GuiToolboxButtonCtrl:

Inheritance graph

[legend]List of all members.


Public Member Functions
	DECLARE_CONOBJECT (GuiToolboxButtonCtrl)
	GuiToolboxButtonCtrl ()
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	inspectPostApply ()
	Called after any property of the object is changed in the world editor.
void	setNormalBitmap (StringTableEntry bitmapName)
void	setLoweredBitmap (StringTableEntry bitmapName)
void	setHoverBitmap (StringTableEntry bitmapName)
void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Protected Member Functions
void	renderButton (GFXTexHandle &texture, Point2I &offset, const RectI &updateRect)
void	renderStateRect (GFXTexHandle &texture, const RectI &rect)
Protected Attributes
StringTableEntry	mNormalBitmapName
StringTableEntry	mLoweredBitmapName
StringTableEntry	mHoverBitmapName
GFXTexHandle	mTextureNormal
GFXTexHandle	mTextureLowered
GFXTexHandle	mTextureHover
Private Types
typedef GuiButtonCtrl	Parent

Member Typedef Documentation

typedef GuiButtonCtrl GuiToolboxButtonCtrl::Parent [private]

Reimplemented from GuiButtonCtrl.

Constructor & Destructor Documentation

GuiToolboxButtonCtrl::GuiToolboxButtonCtrl ( )

Member Function Documentation

void GuiToolboxButtonCtrl::renderButton	(	GFXTexHandle &	texture,
		Point2I &	offset,
		const RectI &	updateRect
	)			`[protected]`

void GuiToolboxButtonCtrl::renderStateRect	(	GFXTexHandle &	texture,
		const RectI &	rect
	)			`[protected]`

GuiToolboxButtonCtrl::DECLARE_CONOBJECT ( GuiToolboxButtonCtrl )

static void GuiToolboxButtonCtrl::initPersistFields ( ) [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiButtonBaseCtrl.

bool GuiToolboxButtonCtrl::onWake ( ) [virtual]

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

Reimplemented from GuiButtonCtrl.

void GuiToolboxButtonCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

void GuiToolboxButtonCtrl::inspectPostApply ( ) [virtual]

Called after any property of the object is changed in the world editor.

See also:: inspectPreApply

Reimplemented from GuiControl.

void GuiToolboxButtonCtrl::setNormalBitmap ( StringTableEntry bitmapName )

void GuiToolboxButtonCtrl::setLoweredBitmap ( StringTableEntry bitmapName )

void GuiToolboxButtonCtrl::setHoverBitmap ( StringTableEntry bitmapName )

void GuiToolboxButtonCtrl::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 GuiButtonCtrl.

Member Data Documentation

StringTableEntry GuiToolboxButtonCtrl::mNormalBitmapName [protected]

StringTableEntry GuiToolboxButtonCtrl::mLoweredBitmapName [protected]

StringTableEntry GuiToolboxButtonCtrl::mHoverBitmapName [protected]

GFXTexHandle GuiToolboxButtonCtrl::mTextureNormal [protected]

GFXTexHandle GuiToolboxButtonCtrl::mTextureLowered [protected]

GFXTexHandle GuiToolboxButtonCtrl::mTextureHover [protected]