PopupMenu

Public Functions

PopupMenu()

~PopupMenu()

attachToMenuBar(GuiCanvas * owner, S32 pos, const char * title)

Places this menu in the menu bar of the application's main window.

Parameters:

canHandleID(U32 iD)

Returns true iff this menu contains an item that matches

iD

implemented on a per-platform basis. TODO: factor out common code

checkItem(S32 pos, bool checked)

implemented on a per-platform basis.

checkRadioItem(S32 firstPos, S32 lastPos, S32 checkPos)

All items at positions firstPos through lastPos are unchecked, and the item at checkPos is checked.

implemented on a per-platform basis.

createPlatformMenu()

Set to true if any menu or submenu handles a selection event.

Creates the platform specific menu object, a peer to this object. The platform menu must exist before calling any method that manipulates menu items or displays the menu. implementd on a per-platform basis.

createPlatformPopupMenuData()

DECLARE_CONOBJECT(PopupMenu )

deletePlatformPopupMenuData()

enableItem(S32 pos, bool enable)

implemented on a per-platform basis.

getBarTitle()

getItemCount()

Returns the number of items in the menu.

getPopupGUID()

Returns the popup GUID.

getPosOnMenuBar()

Returns the position index of this menu on the bar.

handleSelect(U32 command, const char * text)

A menu item in this menu has been selected by id.

Submenus are given a chance to respond to the command first. If no submenu can handle the command id, this menu handles it. The script callback this::onSelectItem( position, text) is called. If

text

handleSelectEvent(U32 popID, U32 command)

Helper function to allow menu selections from signal events.

Wraps canHandleID() and handleSelect() in one function without changing their internal functionality, so it should work regardless of platform.

insertItem(S32 pos, const char * title, const char * accelerator, const char * cmd)

pass NULL for

title

implementd on a per-platform basis. TODO: factor out common code

insertSubMenu(S32 pos, const char * title, PopupMenu * submenu)

pass NULL for

title

adds the submenu to the mSubmenus vector. implemented on a per-platform basis. TODO: factor out common code

isAttachedToMenuBar()

Returns true if this menu is attached to the menu bar.

isItemChecked(S32 pos)

onAdd()

Reimplemented from: SimObject

onAttachToMenuBar(GuiCanvas * canvas, S32 pos, const char * title)

Called when the menu has been attached to the menu bar.

onMenuSelect()

onMessageObjectReceived(StringTableEntry queue, Message * msg)

Reimplemented from: Dispatcher::IMessageListener

onMessageReceived(StringTableEntry queue, const char * msg, const char * data)

Reimplemented from: Dispatcher::IMessageListener

onRemove()

Reimplemented from: SimObject

onRemoveFromMenuBar(GuiCanvas * canvas)

Called when the menu has been removed from the menu bar.

removeFromMenuBar()

Removes this menu from the menu bar.

removeItem(S32 itemPos)

remove the menu item at

itemPos

implemented on a per-platform basis. TODO: factor out common code

setBarTitle(const char * val)

setItem(S32 pos, const char * title, const char * accelerator, const char * cmd)

Sets the name title and accelerator for an existing item.

showPopup(GuiCanvas * owner, S32 x, S32 y)

Displays this menu as a popup menu and blocks until the user has selected an item.

Parameters:

initPersistFields()