GuiPopUpMenuCtrl

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

Inherit:

GuiTextCtrl

Description

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

Example:

newGuiPopUpMenuCtrl()
{
   maxPopupHeight = "200";
   sbUsesNAColor = "0";
   reverseTextList = "0";
   bitmapBounds = "16 16";
   maxLength = "1024";
   position = "56 31";
   extent = "64 64";
   minExtent = "8 2";
   profile = "GuiPopUpMenuProfile";
   tooltipProfile = "GuiToolTipProfile";
};

Methods

void GuiPopUpMenuCtrl::add(string name, int idNum, int scheme)

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, string)

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)

Fields

filename GuiPopUpMenuCtrl::bitmap

Point2I GuiPopUpMenuCtrl::bitmapBounds

void GuiPopUpMenuCtrl::clear

Clear the popup list.

void GuiPopUpMenuCtrl::forceClose

void GuiPopUpMenuCtrl::forceOnAction

int GuiPopUpMenuCtrl::getSelected

string GuiPopUpMenuCtrl::getText

int GuiPopUpMenuCtrl::maxPopupHeight

bool GuiPopUpMenuCtrl::reverseTextList

bool GuiPopUpMenuCtrl::sbUsesNAColor

void GuiPopUpMenuCtrl::setNoneSelected

int GuiPopUpMenuCtrl::size

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

void GuiPopUpMenuCtrl::sort

Sort the list alphabetically.

void GuiPopUpMenuCtrl::sortID

Sort the list by ID.