GuiPopUpMenuCtrl Class Reference

#include <guiPopUpCtrl.h>

Inheritance diagram for GuiPopUpMenuCtrl:


Public Member Functions
	GuiPopUpMenuCtrl (void)
	~GuiPopUpMenuCtrl ()
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, bool bNotifyScript=true)
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 (GuiPopUpMenuCtrl)
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
GuiPopupTextListCtrl *	mTl
GuiScrollCtrl *	mSc
GuiPopUpBackgroundCtrl *	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
StringTableEntry	mBitmapName
Point2I	mBitmapBounds
GFXTexHandle	mTextureNormal
GFXTexHandle	mTextureDepressed
Private Types
typedef GuiTextCtrl	Parent
Classes
struct	Entry
struct	Scheme

Member Typedef Documentation

typedef GuiTextCtrl GuiPopUpMenuCtrl::Parent [private]

Reimplemented from GuiTextCtrl.

Constructor & Destructor Documentation

GuiPopUpMenuCtrl::GuiPopUpMenuCtrl ( void )

GuiPopUpMenuCtrl::~GuiPopUpMenuCtrl ( )

Member Function Documentation

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

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

bool GuiPopUpMenuCtrl::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 GuiPopUpMenuCtrl::onAdd ( ) [virtual]

Called when this object is added to the scene.

Reimplemented from GuiTextCtrl.

void GuiPopUpMenuCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiTextCtrl.

void GuiPopUpMenuCtrl::setBitmap ( const char * name )

void GuiPopUpMenuCtrl::sort ( )

void GuiPopUpMenuCtrl::sortID ( )

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

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

void GuiPopUpMenuCtrl::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 GuiPopUpMenuCtrl::onAction ( ) [virtual]

Occurs when this control performs its "action".

Reimplemented from GuiControl.

virtual void GuiPopUpMenuCtrl::closePopUp ( ) [virtual]

void GuiPopUpMenuCtrl::clear ( )

Reimplemented from SimSet.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

void GuiPopUpMenuCtrl::setupAutoScroll ( const GuiEvent & event )

void GuiPopUpMenuCtrl::autoScroll ( )

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

Happens when a key is depressed.

Parameters:

event

Event descriptor (which contains the key)

Reimplemented from GuiControl.

void GuiPopUpMenuCtrl::reverseTextList ( )

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

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

S32 GuiPopUpMenuCtrl::getSelected ( )

void GuiPopUpMenuCtrl::setSelected	(	S32	id,
		bool	bNotifyScript = `true`
	)

void GuiPopUpMenuCtrl::setFirstSelected ( )

void GuiPopUpMenuCtrl::setNoneSelected ( )

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

Returns the value of the variable bound to this object.

Reimplemented from GuiTextCtrl.

const char* GuiPopUpMenuCtrl::getTextById ( S32 id )

S32 GuiPopUpMenuCtrl::findText ( const char * text )

S32 GuiPopUpMenuCtrl::getNumEntries ( ) [inline]

void GuiPopUpMenuCtrl::replaceText ( S32 )

GuiPopUpMenuCtrl::DECLARE_CONOBJECT ( GuiPopUpMenuCtrl )

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

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

Reimplemented from GuiTextCtrl.

Member Data Documentation

bool GuiPopUpMenuCtrl::mBackgroundCancel

GuiPopupTextListCtrl* GuiPopUpMenuCtrl::mTl [protected]

GuiScrollCtrl* GuiPopUpMenuCtrl::mSc [protected]

GuiPopUpBackgroundCtrl* GuiPopUpMenuCtrl::mBackground [protected]

Vector<Entry> GuiPopUpMenuCtrl::mEntries [protected]

Vector<Scheme> GuiPopUpMenuCtrl::mSchemes [protected]

S32 GuiPopUpMenuCtrl::mSelIndex [protected]

S32 GuiPopUpMenuCtrl::mMaxPopupHeight [protected]

F32 GuiPopUpMenuCtrl::mIncValue [protected]

F32 GuiPopUpMenuCtrl::mScrollCount [protected]

S32 GuiPopUpMenuCtrl::mLastYvalue [protected]

GuiEvent GuiPopUpMenuCtrl::mEventSave [protected]

S32 GuiPopUpMenuCtrl::mRevNum [protected]

bool GuiPopUpMenuCtrl::mInAction [protected]

bool GuiPopUpMenuCtrl::mReplaceText [protected]

bool GuiPopUpMenuCtrl::mMouseOver [protected]

bool GuiPopUpMenuCtrl::mRenderScrollInNA [protected]

bool GuiPopUpMenuCtrl::mReverseTextList [protected]

StringTableEntry GuiPopUpMenuCtrl::mBitmapName [protected]

Point2I GuiPopUpMenuCtrl::mBitmapBounds [protected]

GFXTexHandle GuiPopUpMenuCtrl::mTextureNormal [protected]

GFXTexHandle GuiPopUpMenuCtrl::mTextureDepressed [protected]

GuiScrollCtrl::Region GuiPopUpMenuCtrl::mScrollDir

GuiPopUpMenuCtrl 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