GuiPopUpMenuCtrlEx Class Reference

#include <guiPopUpCtrlEx.h>

Inheritance diagram for GuiPopUpMenuCtrlEx:


Public Member Functions
	GuiPopUpMenuCtrlEx (void)
	~GuiPopUpMenuCtrlEx ()
bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end.
bool	onAdd ()
	Called when this object is added to the scene.
void	onSleep ()
	Called when this object is asked to sleep.
void	setBitmap (const char *name)
void	sort ()
void	sortID ()
void	addEntry (const char *buf, S32 id, U32 scheme=0)
void	addScheme (U32 id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)
void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
void	onAction ()
	Occurs when this control performs its "action".
virtual void	closePopUp ()
void	clear ()
void	onMouseDown (const GuiEvent &event)
void	onMouseUp (const GuiEvent &event)
void	onMouseEnter (const GuiEvent &event)
void	onMouseLeave (const GuiEvent &)
void	setupAutoScroll (const GuiEvent &event)
void	autoScroll ()
bool	onKeyDown (const GuiEvent &event)
	Happens when a key is depressed.
void	reverseTextList ()
bool	getFontColor (ColorI &fontColor, S32 id, bool selected, bool mouseOver)
bool	getColoredBox (ColorI &boxColor, S32 id)
S32	getSelected ()
void	setSelected (S32 id)
void	setFirstSelected ()
void	setNoneSelected ()
const char *	getScriptValue ()
	Returns the value of the variable bound to this object.
const char *	getTextById (S32 id)
S32	findText (const char *text)
S32	getNumEntries ()
void	replaceText (S32)
	DECLARE_CONOBJECT (GuiPopUpMenuCtrlEx)
Static Public Member Functions
static void	initPersistFields (void)
	Register dynamic fields in a subclass of ConsoleObject.
Public Attributes
bool	mBackgroundCancel
GuiScrollCtrl::Region	mScrollDir
Protected Member Functions
virtual void	addChildren ()
virtual void	repositionPopup ()
Protected Attributes
GuiPopupTextListCtrlEx *	mTl
GuiScrollCtrl *	mSc
GuiPopUpBackgroundCtrlEx *	mBackground
Vector< Entry >	mEntries
Vector< Scheme >	mSchemes
S32	mSelIndex
S32	mMaxPopupHeight
F32	mIncValue
F32	mScrollCount
S32	mLastYvalue
GuiEvent	mEventSave
S32	mRevNum
bool	mInAction
bool	mReplaceText
bool	mMouseOver
bool	mRenderScrollInNA
bool	mReverseTextList
bool	mHotTrackItems
StringTableEntry	mBitmapName
Point2I	mBitmapBounds
GFXTexHandle	mTextureNormal
GFXTexHandle	mTextureDepressed
Private Types
typedef GuiTextCtrl	Parent
Classes
struct	Entry
struct	Scheme

Member Typedef Documentation

typedef GuiTextCtrl GuiPopUpMenuCtrlEx::Parent [private]

Reimplemented from GuiTextCtrl.

Constructor & Destructor Documentation

GuiPopUpMenuCtrlEx::GuiPopUpMenuCtrlEx ( void )

GuiPopUpMenuCtrlEx::~GuiPopUpMenuCtrlEx ( )

Member Function Documentation

virtual void GuiPopUpMenuCtrlEx::addChildren ( ) [protected, virtual]

virtual void GuiPopUpMenuCtrlEx::repositionPopup ( ) [protected, virtual]

bool GuiPopUpMenuCtrlEx::onWake ( ) [virtual]

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

Reimplemented from GuiTextCtrl.

bool GuiPopUpMenuCtrlEx::onAdd ( ) [virtual]

Called when this object is added to the scene.

Reimplemented from GuiTextCtrl.

void GuiPopUpMenuCtrlEx::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiTextCtrl.

void GuiPopUpMenuCtrlEx::setBitmap ( const char * name )

void GuiPopUpMenuCtrlEx::sort ( )

void GuiPopUpMenuCtrlEx::sortID ( )

void GuiPopUpMenuCtrlEx::addEntry	(	const char *	buf,
		S32	id,
		U32	scheme = `0`
	)

void GuiPopUpMenuCtrlEx::addScheme	(	U32	id,
		ColorI	fontColor,
		ColorI	fontColorHL,
		ColorI	fontColorSEL
	)

void GuiPopUpMenuCtrlEx::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 GuiTextCtrl.

void GuiPopUpMenuCtrlEx::onAction ( ) [virtual]

Occurs when this control performs its "action".

Reimplemented from GuiControl.

virtual void GuiPopUpMenuCtrlEx::closePopUp ( ) [virtual]

void GuiPopUpMenuCtrlEx::clear ( )

Reimplemented from SimSet.

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

Reimplemented from GuiControl.

void GuiPopUpMenuCtrlEx::onMouseUp ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiPopUpMenuCtrlEx::onMouseEnter ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiPopUpMenuCtrlEx::onMouseLeave ( const GuiEvent & ) [virtual]

Reimplemented from GuiControl.

void GuiPopUpMenuCtrlEx::setupAutoScroll ( const GuiEvent & event )

void GuiPopUpMenuCtrlEx::autoScroll ( )

bool GuiPopUpMenuCtrlEx::onKeyDown ( const GuiEvent & event ) [virtual]

Happens when a key is depressed.

Parameters:

event

Event descriptor (which contains the key)

Reimplemented from GuiControl.

void GuiPopUpMenuCtrlEx::reverseTextList ( )

bool GuiPopUpMenuCtrlEx::getFontColor	(	ColorI &	fontColor,
		S32	id,
		bool	selected,
		bool	mouseOver
	)

bool GuiPopUpMenuCtrlEx::getColoredBox	(	ColorI &	boxColor,
		S32	id
	)

S32 GuiPopUpMenuCtrlEx::getSelected ( )

void GuiPopUpMenuCtrlEx::setSelected ( S32 id )

void GuiPopUpMenuCtrlEx::setFirstSelected ( )

void GuiPopUpMenuCtrlEx::setNoneSelected ( )

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

Returns the value of the variable bound to this object.

Reimplemented from GuiTextCtrl.

const char* GuiPopUpMenuCtrlEx::getTextById ( S32 id )

S32 GuiPopUpMenuCtrlEx::findText ( const char * text )

S32 GuiPopUpMenuCtrlEx::getNumEntries ( ) [inline]

void GuiPopUpMenuCtrlEx::replaceText ( S32 )

GuiPopUpMenuCtrlEx::DECLARE_CONOBJECT ( GuiPopUpMenuCtrlEx )

static void GuiPopUpMenuCtrlEx::initPersistFields ( void ) [static]

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

Reimplemented from GuiTextCtrl.

Member Data Documentation

bool GuiPopUpMenuCtrlEx::mBackgroundCancel

GuiPopupTextListCtrlEx* GuiPopUpMenuCtrlEx::mTl [protected]

GuiScrollCtrl* GuiPopUpMenuCtrlEx::mSc [protected]

GuiPopUpBackgroundCtrlEx* GuiPopUpMenuCtrlEx::mBackground [protected]

Vector<Entry> GuiPopUpMenuCtrlEx::mEntries [protected]

Vector<Scheme> GuiPopUpMenuCtrlEx::mSchemes [protected]

S32 GuiPopUpMenuCtrlEx::mSelIndex [protected]

S32 GuiPopUpMenuCtrlEx::mMaxPopupHeight [protected]

F32 GuiPopUpMenuCtrlEx::mIncValue [protected]

F32 GuiPopUpMenuCtrlEx::mScrollCount [protected]

S32 GuiPopUpMenuCtrlEx::mLastYvalue [protected]

GuiEvent GuiPopUpMenuCtrlEx::mEventSave [protected]

S32 GuiPopUpMenuCtrlEx::mRevNum [protected]

bool GuiPopUpMenuCtrlEx::mInAction [protected]

bool GuiPopUpMenuCtrlEx::mReplaceText [protected]

bool GuiPopUpMenuCtrlEx::mMouseOver [protected]

bool GuiPopUpMenuCtrlEx::mRenderScrollInNA [protected]

bool GuiPopUpMenuCtrlEx::mReverseTextList [protected]

bool GuiPopUpMenuCtrlEx::mHotTrackItems [protected]

StringTableEntry GuiPopUpMenuCtrlEx::mBitmapName [protected]

Point2I GuiPopUpMenuCtrlEx::mBitmapBounds [protected]

GFXTexHandle GuiPopUpMenuCtrlEx::mTextureNormal [protected]

GFXTexHandle GuiPopUpMenuCtrlEx::mTextureDepressed [protected]

GuiScrollCtrl::Region GuiPopUpMenuCtrlEx::mScrollDir

GuiPopUpMenuCtrlEx Class Reference

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Classes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation