GuiIconButtonCtrl Class Reference

#include <guiIconButtonCtrl.h>

Inheritance diagram for GuiIconButtonCtrl:

Detailed Description

------------------------------------- Icon Button Control Draws the bitmap within a normal button control.

if the extent is set to (0,0) in the gui editor and apply hit, this control will set it's extent to be exactly the size of the normal bitmap (if present)

Public Types

TextLocNone

TextLocBottom

TextLocRight

TextLocTop

TextLocLeft

TextLocCenter

IconLocLeft

IconLocRight

IconLocNone

enum {
  TextLocNone,
  TextLocBottom,
  TextLocRight,
  TextLocTop,
  TextLocLeft,
  TextLocCenter
}

enum {
  IconLocLeft,
  IconLocRight,
  IconLocNone
}

Public Member Functions

DECLARE_CONOBJECT (GuiIconButtonCtrl)

GuiIconButtonCtrl ()

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 setBitmap (const char *name)

void setErrorBitmap (const char *name)

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 Types

stateNormal

stateMouseOver

statePressed

stateDisabled

enum {
  stateNormal,
  stateMouseOver,
  statePressed,
  stateDisabled
}

Protected Member Functions

void renderButton (Point2I &offset, const RectI &updateRect)

void renderBitmapArray (RectI &bounds, S32 state)

Protected Attributes

StringTableEntry mBitmapName

GFXTexHandle mTextureNormal

S32 mIconLocation

S32 mTextLocation

S32 mTextMargin

Point2I mButtonMargin

bool mFitBitmapToButton

StringTableEntry mErrorBitmapName

GFXTexHandle mErrorTextureHandle

Private Types

typedef GuiButtonCtrl Parent

Member Typedef Documentation

typedef GuiButtonCtrl GuiIconButtonCtrl::Parent [private]

Reimplemented from GuiButtonCtrl.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

stateNormal
stateMouseOver
statePressed
stateDisabled

anonymous enum

Enumerator:

TextLocNone
TextLocBottom
TextLocRight
TextLocTop
TextLocLeft
TextLocCenter

anonymous enum

Enumerator:

IconLocLeft
IconLocRight
IconLocNone

Constructor & Destructor Documentation

GuiIconButtonCtrl::GuiIconButtonCtrl ( )

Member Function Documentation

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

void GuiIconButtonCtrl::renderBitmapArray	(	RectI &	bounds,
		S32	state
	)			`[protected]`

GuiIconButtonCtrl::DECLARE_CONOBJECT ( GuiIconButtonCtrl )

static void GuiIconButtonCtrl::initPersistFields ( ) [static]

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

Reimplemented from GuiButtonBaseCtrl.

bool GuiIconButtonCtrl::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 GuiIconButtonCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

void GuiIconButtonCtrl::inspectPostApply ( ) [virtual]

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

See also:: inspectPreApply

Reimplemented from GuiControl.

void GuiIconButtonCtrl::setBitmap ( const char * name )

void GuiIconButtonCtrl::setErrorBitmap ( const char * name )

void GuiIconButtonCtrl::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 GuiIconButtonCtrl::mBitmapName [protected]

GFXTexHandle GuiIconButtonCtrl::mTextureNormal [protected]

S32 GuiIconButtonCtrl::mIconLocation [protected]

S32 GuiIconButtonCtrl::mTextLocation [protected]

S32 GuiIconButtonCtrl::mTextMargin [protected]

Point2I GuiIconButtonCtrl::mButtonMargin [protected]

bool GuiIconButtonCtrl::mFitBitmapToButton [protected]

StringTableEntry GuiIconButtonCtrl::mErrorBitmapName [protected]

GFXTexHandle GuiIconButtonCtrl::mErrorTextureHandle [protected]