#include <guiPopUpCtrl.h>

Inheritance diagram for GuiPopUpMenuCtrl:

Classes
struct	Entry

struct	Scheme

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. More...

bool	onAdd ()
	Called when this object is added to the scene. More...

void	onSleep ()
	Called when this object is asked to sleep. More...

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)

void	onAction ()
	Occurs when this control performs its "action". More...

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)

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. More...

const char *	getTextById (S32 id)

S32	findText (const char *text)

S32	getNumEntries ()

void	replaceText (S32)

	DECLARE_CONOBJECT (GuiPopUpMenuCtrl)

Public Member Functions inherited from GuiTextCtrl
	DECLARE_CONOBJECT (GuiTextCtrl)

	GuiTextCtrl ()

bool	onAdd ()
	Called when this object is added to the scene. More...

virtual void	setText (const char *txt=NULL)

virtual void	setTextID (S32 id)

virtual void	setTextID (const char *id)

const char *	getText ()

void	inspectPostApply ()

void	onPreRender ()
	Do special pre-render proecessing. More...

void	onRender (Point2I offset, const RectI &updateRect)

void	displayText (S32 xOffset, S32 yOffset)

const char *	getScriptValue ()
	Returns the value of the variable bound to this object. More...

void	setScriptValue (const char *value)
	Sets the value of the variable bound to this object. More...

Public Member Functions inherited from GuiControl
virtual void	getScrollLineSizes (U32 rowHeight, U32 columnWidth)

virtual void	getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)

void	awaken ()
	Called when this control and its children have been wired up. More...

void	sleep ()
	Called when this control is no more. More...

void	preRender ()
	Prerender this control and all its children. More...

virtual bool	onInputEvent (const InputEvent &event)
	General input handler. More...

virtual bool	ControlIsChild (GuiControl *child)

void	setControlProfile (GuiControlProfile *prof)

void	renderJustifiedText (Point2I offset, Point2I extent, const char *text)

void	inspectPreApply ()

void	setSizing (S32 horz, S32 vert)

void	write (Stream &stream, U32 tabStop, U32 flags)
	Overrides Parent Serialization to allow specific controls to not be saved (Dynamic Controls, etc) More...

bool	getCanSave ()
	Returns boolean specifying if a control can be serialized. More...

void	setCanSave (bool bCanSave)
	Set serialization flag. More...

bool	getCanSaveParent ()
	Returns boolean as to whether any parent of this control has the 'no serialization' flag set. More...

const Point2I &	getPosition ()
	Returns position of the control. More...

const Point2I &	getExtent ()
	Returns extents of the control. More...

const RectI &	getBounds ()
	Returns the bounds of the control. More...

const Point2I &	getMinExtent ()
	Returns minimum size the control can be. More...

const S32	getLeft ()
	Returns the X position of the control. More...

const S32	getTop ()
	Returns the Y position of the control. More...

const S32	getWidth ()
	Returns the width of the control. More...

const S32	getHeight ()
	Returns the height of the control. More...

virtual void	setVisible (bool value)

bool	isVisible ()
	Returns true if the object is visible. More...

void	setActive (bool value)

bool	isActive ()
	Returns true if this control is active. More...

bool	isAwake ()
	Returns true if this control is awake. More...

void	addObject (SimObject *obj)

void	removeObject (SimObject *obj)

GuiControl *	getParent ()
	Returns the control which owns this one. More...

GuiCanvas *	getRoot ()

Point2I	localToGlobalCoord (const Point2I &src)

Point2I	globalToLocalCoord (const Point2I &src)

virtual void	resize (const Point2I &newPosition, const Point2I &newExtent)

virtual void	setPosition (const Point2I &newPosition)

virtual void	setExtent (const Point2I &newExtent)

virtual void	setBounds (const RectI &newBounds)

virtual void	setLeft (S32 newLeft)

virtual void	setTop (S32 newTop)

virtual void	setWidth (S32 newWidth)

virtual void	setHeight (S32 newHeight)

virtual void	childResized (GuiControl *child)

virtual void	parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)

virtual bool	renderTooltip (Point2I cursorPos, const char *tipText=NULL)

void	renderChildControls (Point2I offset, const RectI &updateRect)

void	setUpdateRegion (Point2I pos, Point2I ext)

virtual void	setUpdate ()
	Sets the update area of the control to encompass the whole control. More...

virtual void	onRemove ()
	Called when this object is removed. More...

virtual void	onChildRemoved (GuiControl *child)
	Called when one of this objects children is removed. More...

virtual void	onChildAdded (GuiControl *child)
	Called when this object has a new child. More...

virtual bool	pointInControl (const Point2I &parentCoordPoint)

bool	cursorInControl ()
	Returns true if the global cursor is inside this control. More...

virtual GuiControl *	findHitControl (const Point2I &pt, S32 initialLayer=-1)

void	mouseLock (GuiControl *lockingControl)

void	mouseLock ()
	Turn on mouse locking with last used lock control. More...

void	mouseUnlock ()
	Unlock the mouse. More...

bool	isMouseLocked ()
	Returns true if the mouse is locked. More...

virtual void	onMouseMove (const GuiEvent &event)

virtual void	onMouseDragged (const GuiEvent &event)

virtual bool	onMouseWheelUp (const GuiEvent &event)

virtual bool	onMouseWheelDown (const GuiEvent &event)

virtual void	onRightMouseDown (const GuiEvent &event)

virtual void	onRightMouseUp (const GuiEvent &event)

virtual void	onRightMouseDragged (const GuiEvent &event)

virtual void	onMiddleMouseDown (const GuiEvent &event)

virtual void	onMiddleMouseUp (const GuiEvent &event)

virtual void	onMiddleMouseDragged (const GuiEvent &event)

virtual bool	onMouseDownEditor (const GuiEvent &event, Point2I offset)

virtual bool	onMouseUpEditor (const GuiEvent &event, Point2I offset)

virtual bool	onRightMouseDownEditor (const GuiEvent &event, Point2I offset)

virtual bool	onMouseDraggedEditor (const GuiEvent &event, Point2I offset)

virtual GuiControl *	findFirstTabable ()
	Find the first tab-accessable child of this control. More...

virtual GuiControl *	findLastTabable (bool firstCall=true)

virtual GuiControl *	findPrevTabable (GuiControl *curResponder, bool firstCall=true)

virtual GuiControl *	findNextTabable (GuiControl *curResponder, bool firstCall=true)

virtual void	setFirstResponder (GuiControl *firstResponder)

virtual void	makeFirstResponder (bool value)

bool	isFirstResponder ()
	Returns true if this control is a first responder. More...

virtual void	setFirstResponder ()
	Sets this object to be a first responder. More...

void	clearFirstResponder ()
	Clears the first responder for this chain. More...

GuiControl *	getFirstResponder ()
	Returns the first responder for this chain. More...

virtual void	onLoseFirstResponder ()
	Occurs when the first responder for this chain is lost. More...

void	addAcceleratorKey ()
	Adds the accelerator key for this object to the canvas. More...

virtual void	buildAcceleratorMap ()

virtual void	acceleratorKeyPress (U32 index)

virtual void	acceleratorKeyRelease (U32 index)

virtual bool	onKeyUp (const GuiEvent &event)

virtual bool	onKeyRepeat (const GuiEvent &event)

void	messageSiblings (S32 message)
	Send a message to all siblings. More...

virtual void	onMessage (GuiControl *sender, S32 msg)

virtual void	onDialogPush ()
	Called if this object is a dialog, when it is added to the visible layers. More...

virtual void	onDialogPop ()
	Called if this object is a dialog, when it is removed from the visible layers. More...

void	setConsoleVariable (const char *variable)

void	setConsoleCommand (const char *newCmd)

const char *	getConsoleCommand ()
	Returns the name of the function bound to this GuiControl. More...

LangTable *	getGUILangTable (void)

const UTF8 *	getGUIString (S32 id)

	DECLARE_CONOBJECT (GuiControl)

	GuiControl ()

virtual	~GuiControl ()

Public Member Functions inherited from SimGroup
	~SimGroup ()

void	addObject (SimObject *, SimObjectId)

void	addObject (SimObject , const char name)

virtual SimObject *	findObject (const char *name)
	Find an object in the group. More...

bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)) More...

	DECLARE_CONOBJECT (SimGroup)

Public Member Functions inherited from SimSet
	SimSet ()

	~SimSet ()

virtual void	onDeleteNotify (SimObject *object)

virtual U32	getTamlChildCount (void) const
	Called when Taml attempts to compile a list of children. More...

virtual SimObject *	getTamlChild (const U32 childIndex) const
	Called when Taml attempts to compile a list of children. More...

virtual void	addTamlChild (SimObject *pSimObject)
	Called when Taml attempts to populate an objects children during a read. More...

void	callOnChildren (const char method, S32 argc, const char argv[], bool executeOnChildGroups=true)

SimObject *	findObjectByInternalName (const char *internalName, bool searchChildren=false)

virtual bool	writeObject (Stream *stream)

virtual bool	readObject (Stream *stream)

void	lock ()

void	unlock ()

	DECLARE_CONOBJECT (SimSet)

void	_setVectorAssoc (const char *file, const U32 line)

virtual void	pushObject (SimObject *)

virtual void	popObject ()
	Remove an object from the end of the list. More...

void	bringObjectToFront (SimObject *obj)

void	pushObjectToBack (SimObject *obj)

SimObject *	front ()

SimObject *	first ()

SimObject *	last ()

bool	empty ()

S32	size () const

iterator	begin ()

iterator	end ()

value	operator[] (S32 index)

iterator	find (iterator first, iterator last, SimObject *obj)

iterator	find (SimObject *obj)

template<typename T >
bool	containsType (void)

virtual bool	reOrder (SimObject obj, SimObject target=0)

SimObject *	at (S32 index) const

void	deleteObjects (void)

void	clear ()

Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const

StringTableEntry	getSuperClassNamespace () const

void	setClassNamespace (const char *classNamespace)

void	setSuperClassNamespace (const char *superClassNamespace)

void	pushScriptCallbackGuard (void)

void	popScriptCallbackGuard (void)

S32	getScriptCallbackGuard (void)

Namespace *	getNamespace ()
	Return the object's namespace. More...

const char *	tabComplete (const char *prevText, S32 baseLen, bool)

virtual void	dump ()

virtual void	dumpClassHierarchy ()

SimObject *	clone (const bool copyDynamicFields)

virtual void	copyTo (SimObject *object)

template<typename T >
bool	isType (void)

virtual bool	handlesConsoleMethod (const char fname, S32 routingId)

	DECLARE_CONOBJECT (SimObject)

Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list. More...

void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted. More...

void	clearNotify (SimObject *obj)
	Notify an object when we are cleared. More...

void	clearAllNotifications ()
	Remove all notifications for this object. More...

void	processDeleteNotifies ()
	Send out deletion notifications. More...

void	registerReference (SimObject **obj)

void	unregisterReference (SimObject **obj)

const char *	getDataField (StringTableEntry slotName, const char *array)

void	setDataField (StringTableEntry slotName, const char array, const char value)

const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)

void	setPrefixedDataField (StringTableEntry fieldName, const char array, const char value)

const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)

void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char array, const char value, const S32 fieldType=-1)

StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)

U32	getDataFieldType (StringTableEntry slotName, const char *array)

SimFieldDictionary *	getFieldDictionary ()

void	clearDynamicFields (void)
	Clear all dynamic fields. More...

void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true. More...

bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true. More...

void	setInternalName (const char *newname)

StringTableEntry	getInternalName ()
	Get the internal of of this control. More...

virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File. More...

virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace. More...

SimObjectId	getId (void) const

StringTableEntry	getIdString (void) const

U32	getType () const

const StringTableEntry	getName (void) const

void	setId (SimObjectId id)

void	assignName (const char *name)

SimGroup *	getGroup () const

bool	isChildOfGroup (SimGroup *pGroup)

bool	isProperlyAdded () const

bool	isDeleted () const

bool	isRemoved () const

bool	isLocked ()

void	setLocked (bool b)

bool	isHidden ()

void	setHidden (bool b)

void	setProgenitorFile (const char *pFile)

StringTableEntry	getProgenitorFile (void) const

void	setPeriodicTimerID (const S32 timerID)

S32	getPeriodicTimerID (void) const

bool	isPeriodicTimerActive (void) const

bool	isSelected () const

bool	isExpanded () const

void	setSelected (bool sel)

void	setExpanded (bool exp)

void	setModDynamicFields (bool dyn)

void	setModStaticFields (bool sta)

	SimObject (const U8 namespaceLinkMask=LinkSuperClassName\|LinkClassName)

virtual	~SimObject ()

virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup. More...

virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup. More...

virtual void	onNameChange (const char *name)
	Called when the object's name is changed. More...

virtual void	onStaticModified (const char slotName, const char newValue=NULL)

virtual void	onEditorEnable ()
	Called when the editor is activated. More...

virtual void	onEditorDisable ()
	Called when the editor is deactivated. More...

bool	registerObject ()

bool	registerObject (U32 id)

bool	registerObject (const char *name)

bool	registerObject (const char *name, U32 id)

void	unregisterObject ()

void	deleteObject ()

bool	addToSet (SimObjectId)

bool	addToSet (const char *)

bool	removeFromSet (SimObjectId)

bool	removeFromSet (const char *)

virtual bool	writeField (StringTableEntry fieldname, const char *value)

virtual void	writeFields (Stream &stream, U32 tabStop)

virtual void	buildFilterList ()

void	addFieldFilter (const char *fieldName)

void	removeFieldFilter (const char *fieldName)

void	clearFieldFilters ()

bool	isFiltered (const char *fieldName)

void	assignFieldsFrom (SimObject *obj)

void	assignDynamicFieldsFrom (SimObject *obj)

Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name. More...

virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep. More...

bool	setField (const char fieldName, const char value)
	Set the value of a field. More...

virtual	~ConsoleObject ()

const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified. More...

AbstractClassRep::FieldList &	getModifiableFieldList ()

bool &	getDynamicGroupExpand ()

S32	getClassId (U32 netClassGroup) const

const char *	getClassName () const

Static Public Member Functions
static void	initPersistFields (void)

Static Public Member Functions inherited from GuiTextCtrl
static void	initPersistFields ()

static bool	setText (void obj, const char data)

static const char *	getTextProperty (void obj, const char data)

Static Public Member Functions inherited from GuiControl
static void	initPersistFields ()

Public Attributes
bool	mBackgroundCancel

GuiScrollCtrl::Region	mScrollDir

Protected Member Functions
virtual void	addChildren ()

virtual void	repositionPopup ()

Protected Member Functions inherited from GuiTextCtrl
S32	textBufferWidth (StringBuffer buffer)

StringBuffer	truncate (StringBuffer buffer, StringBuffer terminationString, S32 width)

Protected Member Functions inherited from GuiControl
const char *	execConsoleCallback ()
	Executes mConsoleCommand, and returns the result. More...

const char *	execAltConsoleCallback ()
	Executes mAltConsoleCommand, and returns the result. More...

void	setVariable (const char *value)

void	setIntVariable (S32 value)

void	setFloatVariable (F32 value)

const char *	getVariable ()
	Returns value of control's bound variable as a string. More...

S32	getIntVariable ()
	Returns value of control's bound variable as a integer. More...

F32	getFloatVariable ()
	Returns value of control's bound variable as a float. More...

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

TextureHandle	mTextureNormal

TextureHandle	mTextureDepressed

Protected Attributes inherited from GuiTextCtrl
StringTableEntry	mInitialText

StringTableEntry	mInitialTextID

UTF8	mText [MAX_STRING_LENGTH+1]

S32	mMaxStrLen

Resource< GFont >	mFont

bool	mTruncateWhenUnfocused

Protected Attributes inherited from GuiControl
S32	mHorizSizing
	Set from horizSizingOptions. More...

S32	mVertSizing
	Set from vertSizingOptions. More...

StringTableEntry	mConsoleVariable

StringTableEntry	mConsoleCommand

StringTableEntry	mAltConsoleCommand

StringTableEntry	mAcceleratorKey

StringTableEntry	mTooltip

Additional Inherited Members
Public Types inherited from GuiTextCtrl
enum	Constants { MAX_STRING_LENGTH = 1024 }

Static Public Attributes inherited from GuiControl
static GuiEditCtrl *	smEditorHandle = NULL

static S32	smCursorChanged = -1
	Has this control modified the cursor? -1 or type. More...

static bool	smDesignTime = false

static GuiControl *	smPrevResponder = NULL

static GuiControl *	smCurResponder = NULL

Protected Types inherited from SimObject
enum	SimObjectNSLinkType { LinkClassName = BIT(0), LinkSuperClassName = BIT(1) }

Static Protected Member Functions inherited from SimObject
static bool	setClass (void obj, const char data)

static bool	setSuperClass (void obj, const char data)

static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)

static bool	writeInternalName (void *obj, StringTableEntry pFieldName)

static bool	setParentGroup (void obj, const char data)

static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)

static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)

static bool	writeClass (void *obj, StringTableEntry pFieldName)

static SimObject::Notify *	allocNotify ()
	Get a free Notify structure. More...

static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free. More...

Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Constructor & Destructor Documentation

GuiPopUpMenuCtrl ( void )

~GuiPopUpMenuCtrl ( )

Member Function Documentation

void addChildren ( )

protectedvirtual

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

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

void autoScroll ( )

void clear ( )

void closePopUp ( )

virtual

DECLARE_CONOBJECT ( GuiPopUpMenuCtrl )

S32 findText ( const char * text )

bool getColoredBox	(	ColorI &	boxColor,
		S32	id
	)

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

S32 getNumEntries ( )

inline

const char * getScriptValue ( )

virtual

Returns the value of the variable bound to this object.

Reimplemented from GuiControl.

S32 getSelected ( )

const char * getTextById ( S32 id )

void initPersistFields ( void )

static

void onAction ( )

virtual

Occurs when this control performs its "action".

Reimplemented from GuiControl.

bool onAdd ( void )

virtual

Called when this object is added to the scene.

Reimplemented from GuiControl.

bool onKeyDown ( const GuiEvent & event )

virtual

Happens when a key is depressed

Parameters

event Event descriptor (which contains the key)

Reimplemented from GuiControl.

void onMouseDown ( const GuiEvent & event )

virtual

Reimplemented from GuiControl.

void onMouseEnter ( const GuiEvent & event )

virtual

Reimplemented from GuiControl.

void onMouseLeave ( const GuiEvent & )

virtual

Reimplemented from GuiControl.

void onMouseUp ( const GuiEvent & event )

virtual

Reimplemented from GuiControl.

void 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.

void onSleep ( )

virtual

Called when this object is asked to sleep.

Reimplemented from GuiTextCtrl.

bool onWake ( )

virtual

Initial value:

{

object->replaceText(dAtoi(argv[2]))

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

Reimplemented from GuiTextCtrl.

void replaceText ( S32 boolVal )

void repositionPopup ( )

protectedvirtual

void reverseTextList ( )

void setBitmap ( const char * name )

void setFirstSelected ( )

void setNoneSelected ( )

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

void setupAutoScroll ( const GuiEvent & event )

void sort ( )

void sortID ( )

Member Data Documentation

GuiPopUpBackgroundCtrl* mBackground

protected

bool mBackgroundCancel

Point2I mBitmapBounds

protected

StringTableEntry mBitmapName

protected

Vector<Entry> mEntries

protected

GuiEvent mEventSave

protected

bool mInAction

protected

F32 mIncValue

protected

S32 mLastYvalue

protected

S32 mMaxPopupHeight

protected

bool mMouseOver

protected

bool mRenderScrollInNA

protected

bool mReplaceText

protected

bool mReverseTextList

protected

S32 mRevNum

protected

GuiScrollCtrl* mSc

protected

Vector<Scheme> mSchemes

protected

F32 mScrollCount

protected

GuiScrollCtrl::Region mScrollDir

S32 mSelIndex

protected

TextureHandle mTextureDepressed

protected

TextureHandle mTextureNormal

protected

GuiPopupTextListCtrl* mTl

protected

The documentation for this class was generated from the following files:

gui/guiPopUpCtrl.h
gui/guiPopUpCtrl.cc

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation