Main   Class List   Namespace List   Wiki

GuiPopUpMenuCtrl Class Reference
[General Controls]

A control that allows to select a value from a drop-down list. More...

Inheritance diagram for GuiPopUpMenuCtrl:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void add (string name, int idNum, int scheme=0)
void addScheme (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)
void changeTextById (int id, string text)
void clearEntry (S32 entry)
int findText (string text)
 Returns the position of the first entry containing the specified text.
string getTextById (int id)
void replaceText (bool doReplaceText)
void setEnumContent (string class, string enum)
 This fills the popup with a classrep's field enumeration type info.
void setFirstSelected ([scriptCallback=true])
void setSelected (int id,[scriptCallback=true])

Public Attributes

filename bitmap
Point2I bitmapBounds
void clear
 Clear the popup list.
void forceClose
void forceOnAction
int getSelected
string getText
int maxPopupHeight
bool reverseTextList
bool sbUsesNAColor
void setNoneSelected
int size
 Get the size of the menu - the number of entries in it.
void sort
 Sort the list alphabetically.
void sortID
 Sort the list by ID.

Detailed Description

A control that allows to select a value from a drop-down list.

For a nearly identical GUI with additional features, use GuiPopUpMenuCtrlEx.

Example:
new GuiPopUpMenuCtrl()
{
   maxPopupHeight = "200";
   sbUsesNAColor = "0";
   reverseTextList = "0";
   bitmapBounds = "16 16";
   maxLength = "1024";
   position = "56 31";
   extent = "64 64";
   minExtent = "8 2";
   profile = "GuiPopUpMenuProfile";
   tooltipProfile = "GuiToolTipProfile";
};
Note:
This is definitely going to be deprecated soon.
See also:
GuiPopUpMenuCtrlEx for more features and better explanations.

Member Function Documentation

void GuiPopUpMenuCtrl::add ( string  name,
int  idNum,
int  scheme = 0 
)
void GuiPopUpMenuCtrl::addScheme ( int  id,
ColorI  fontColor,
ColorI  fontColorHL,
ColorI  fontColorSEL 
)
void GuiPopUpMenuCtrl::changeTextById ( int  id,
string  text 
)
void GuiPopUpMenuCtrl::clearEntry ( S32  entry  ) 
int GuiPopUpMenuCtrl::findText ( string  text  ) 

Returns the position of the first entry containing the specified text.

string GuiPopUpMenuCtrl::getTextById ( int  id  ) 
void GuiPopUpMenuCtrl::replaceText ( bool  doReplaceText  ) 
void GuiPopUpMenuCtrl::setEnumContent ( string  class,
string  enum 
)

This fills the popup with a classrep's field enumeration type info.

More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..

void GuiPopUpMenuCtrl::setFirstSelected (  ) 
void GuiPopUpMenuCtrl::setSelected ( int  id  ) 

Member Data Documentation

Clear the popup list.

Get the size of the menu - the number of entries in it.

Sort the list alphabetically.

Sort the list by ID.



Copyright © GarageGames, LLC. All Rights Reserved.