Torque3D Documentation / _generateds / GuiPopUpMenuCtrl

GuiPopUpMenuCtrl

consoledoc.h

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

More...

Public Attributes

Public Functions

void
add(string name, int idNum, uint scheme)
void
addScheme(uint id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)
void
changeTextById(int id, string text)
void

Clear the popup list.

void
clearEntry(int entry)
int
findText(string text)

Returns the position of the first entry containing the specified text or -1 if not found.

void
int

Gets the selected index.

string
string
getTextById(int id)
void
replaceText(bool doReplaceText)
void
setEnumContent(string className, string enumName)

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

void
setFirstSelected(bool scriptCallback)
void
setSelected(int id, bool scriptCallback)
int
size()

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

void
sort()

Sort the list alphabetically.

void

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.

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:

GuiPopUpMenuCtrlEx for more features and better explanations.

Public Attributes

filename bitmap 
Point2I bitmapBounds 
int maxPopupHeight 
bool reverseTextList 
bool sbUsesNAColor 

Public Functions

add(string name, int idNum, uint scheme)

addScheme(uint id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)

changeTextById(int id, string text)

clear()

Clear the popup list.

clearEntry(int entry)

findText(string text)

Returns the position of the first entry containing the specified text or -1 if not found.

forceClose()

forceOnAction()

getSelected()

Gets the selected index.

getText()

getTextById(int id)

replaceText(bool doReplaceText)

setEnumContent(string className, string enumName)

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

setFirstSelected(bool scriptCallback)

setNoneSelected()

setSelected(int id, bool scriptCallback)

size()

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

sort()

Sort the list alphabetically.

sortID()

Sort the list by ID.