Torque Game Engine Documentation
TGE Version 1.5.2

GuiListBoxCtrl Class Reference

#include <guiListBoxCtrl.h>

Inheritance diagram for GuiListBoxCtrl:


Public Member Functions
	GuiListBoxCtrl ()
	~GuiListBoxCtrl ()
	DECLARE_CONOBJECT (GuiListBoxCtrl)
S32	getItemCount ()
S32	getSelCount ()
S32	getSelectedItem ()
void	getSelectedItems (Vector< S32 > &Items)
S32	getItemIndex (LBItem *item)
StringTableEntry	getItemText (S32 index)
void	setCurSel (S32 index)
void	setCurSelRange (S32 start, S32 stop)
void	setItemText (S32 index, StringTableEntry text)
S32	addItem (StringTableEntry text, void *itemData=NULL)
S32	addItemWithColor (StringTableEntry text, ColorF color=ColorF(-1,-1,-1), void *itemData=NULL)
S32	insertItem (S32 index, StringTableEntry text, void *itemData=NULL)
S32	insertItemWithColor (S32 index, StringTableEntry text, ColorF color=ColorF(-1,-1,-1), void *itemData=NULL)
S32	findItemText (StringTableEntry text, bool caseSensitive=false)
void	setItemColor (S32 index, ColorF color)
void	clearItemColor (S32 index)
void	deleteItem (S32 index)
void	clearItems ()
void	clearSelection ()
void	removeSelection (LBItem *item, S32 index)
void	removeSelection (S32 index)
void	addSelection (LBItem *item, S32 index)
void	addSelection (S32 index)
void	setMultipleSelection (bool allowMultipleSelect=true)
void	updateSize ()
virtual void	parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)
	Called when this objects parent is resized.
virtual bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end.
virtual void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
virtual void	onRenderItem (RectI itemRect, LBItem *item)
void	drawBox (const Point2I &box, S32 size, ColorI &outlineColor, ColorI &boxColor)
virtual void	onMouseDown (const GuiEvent &event)
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
static U32	getStringElementCount (const char *string)
static const char *	getStringElement (const char *inString, const U32 index)
Data Fields
VectorPtr< LBItem * >	mItems
VectorPtr< LBItem * >	mSelectedItems
bool	mMultipleSelections
Point2I	mItemSize
bool	mFitParentWidth
LBItem *	mLastClickItem
Private Types
typedef GuiControl	Parent
Data Structures
struct	LBItem

Member Typedef Documentation

typedef GuiControl GuiListBoxCtrl::Parent [private]

Reimplemented from GuiControl.

Reimplemented in GuiDirectoryFileListCtrl.

Constructor & Destructor Documentation

GuiListBoxCtrl::GuiListBoxCtrl ( )

GuiListBoxCtrl::~GuiListBoxCtrl ( )

Member Function Documentation

GuiListBoxCtrl::DECLARE_CONOBJECT ( GuiListBoxCtrl )

static void GuiListBoxCtrl::initPersistFields ( ) [static]

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

Reimplemented from GuiControl.

S32 GuiListBoxCtrl::getItemCount ( )

S32 GuiListBoxCtrl::getSelCount ( )

S32 GuiListBoxCtrl::getSelectedItem ( )

void GuiListBoxCtrl::getSelectedItems ( Vector< S32 > & Items )

S32 GuiListBoxCtrl::getItemIndex ( LBItem * item )

StringTableEntry GuiListBoxCtrl::getItemText ( S32 index )

void GuiListBoxCtrl::setCurSel ( S32 index )

void GuiListBoxCtrl::setCurSelRange	(	S32	start,
		S32	stop
	)

void GuiListBoxCtrl::setItemText	(	S32	index,
		StringTableEntry	text
	)

S32 GuiListBoxCtrl::addItem	(	StringTableEntry	text,
		void *	itemData = `NULL`
	)

S32 GuiListBoxCtrl::addItemWithColor	(	StringTableEntry	text,
		ColorF	color = `ColorF(-1,-1,-1)`,
		void *	itemData = `NULL`
	)

S32 GuiListBoxCtrl::insertItem	(	S32	index,
		StringTableEntry	text,
		void *	itemData = `NULL`
	)

S32 GuiListBoxCtrl::insertItemWithColor	(	S32	index,
		StringTableEntry	text,
		ColorF	color = `ColorF(-1,-1,-1)`,
		void *	itemData = `NULL`
	)

S32 GuiListBoxCtrl::findItemText	(	StringTableEntry	text,
		bool	caseSensitive = `false`
	)

void GuiListBoxCtrl::setItemColor	(	S32	index,
		ColorF	color
	)

void GuiListBoxCtrl::clearItemColor ( S32 index )

void GuiListBoxCtrl::deleteItem ( S32 index )

void GuiListBoxCtrl::clearItems ( )

void GuiListBoxCtrl::clearSelection ( )

void GuiListBoxCtrl::removeSelection	(	LBItem *	item,
		S32	index
	)

void GuiListBoxCtrl::removeSelection ( S32 index )

void GuiListBoxCtrl::addSelection	(	LBItem *	item,
		S32	index
	)

void GuiListBoxCtrl::addSelection ( S32 index )

void GuiListBoxCtrl::setMultipleSelection ( bool allowMultipleSelect = true ) [inline]

void GuiListBoxCtrl::updateSize ( )

virtual void GuiListBoxCtrl::parentResized	(	const Point2I &	oldParentExtent,
		const Point2I &	newParentExtent
	)			`[virtual]`

Called when this objects parent is resized.

Parameters:

	oldParentExtent	The old size of the parent object
	newParentExtent	The new size of the parent object

Reimplemented from GuiControl.

virtual bool GuiListBoxCtrl::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 GuiDirectoryFileListCtrl.

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

virtual void GuiListBoxCtrl::onRenderItem	(	RectI	itemRect,
		LBItem *	item
	)			`[virtual]`

void GuiListBoxCtrl::drawBox	(	const Point2I &	box,
		S32	size,
		ColorI &	outlineColor,
		ColorI &	boxColor
	)

virtual void GuiListBoxCtrl::onMouseDown ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

Reimplemented in GuiDirectoryFileListCtrl.

static U32 GuiListBoxCtrl::getStringElementCount ( const char * string ) [static]

static const char* GuiListBoxCtrl::getStringElement	(	const char *	inString,
		const U32	index
	)			`[static]`

Field Documentation

VectorPtr<LBItem*> GuiListBoxCtrl::mItems

VectorPtr<LBItem*> GuiListBoxCtrl::mSelectedItems

bool GuiListBoxCtrl::mMultipleSelections

Point2I GuiListBoxCtrl::mItemSize

bool GuiListBoxCtrl::mFitParentWidth

LBItem* GuiListBoxCtrl::mLastClickItem

GuiListBoxCtrl Class Reference

Public Member Functions

Static Public Member Functions

Data Fields

Private Types

Data Structures

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation