torque Torque Game Engine Documentation
TGE Version 1.5.2

GuiPopUpMenuCtrl Class Reference

#include <guiPopUpCtrl.h>

Inheritance diagram for GuiPopUpMenuCtrl:

Inheritance graph
[legend]

Public Member Functions

 GuiPopUpMenuCtrl (void)
 ~GuiPopUpMenuCtrl ()
bool onAdd ()
 Called when this object is added to the scene.
void onSleep ()
 Called when this object is asked to sleep.
void sort ()
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 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)
S32 getSelected ()
void setSelected (S32 id)
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.

Data Fields

GuiScrollCtrl::Region mScrollDir

Protected Member Functions

virtual void addChildren ()
virtual void repositionPopup ()

Protected Attributes

GuiPopUpTextListCtrlmTl
GuiScrollCtrlmSc
GuiPopUpBackgroundCtrlmBackground
Vector< EntrymEntries
Vector< SchememSchemes
S32 mSelIndex
S32 mMaxPopupHeight
F32 mIncValue
F32 mScrollCount
S32 mLastYvalue
GuiEvent mEventSave
S32 mRevNum
bool mInAction
bool mReplaceText

Private Types

typedef GuiTextCtrl Parent

Data Structures

struct  Entry
struct  Scheme

Member Typedef Documentation

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::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::sort (  ) 

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 (  ) 

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

Reimplemented from GuiControl.

void GuiPopUpMenuCtrl::onMouseUp ( const GuiEvent event  )  [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 
)

S32 GuiPopUpMenuCtrl::getSelected (  ) 

void GuiPopUpMenuCtrl::setSelected ( S32  id  ) 

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]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiTextCtrl.


Field Documentation

bool GuiPopUpMenuCtrl::mInAction [protected]




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen