Go to: Synopsis. Return value. Flags. Python examples.


popupMenu( string , [allowOptionBoxes=boolean], [altModifier=boolean], [button=int], [ctrlModifier=boolean], [deleteAllItems=boolean], [itemArray=boolean], [markingMenu=boolean], [numberOfItems=boolean], [postMenuCommand=script], [postMenuCommandOnce=boolean], [shiftModifier=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

popupMenu is undoable, queryable, and editable.

This command creates a popup menu and attaches it to the current control if no parent is specified. The popup menu is posted with the right mouse button by default. Popup menus can be added to any kind of control, however, on some widgets, only the standard menu button (3rd mouse button) can be used to trigger popup menus. This is to meet generally accepted UI guidelines that assign the 3rd mouse button and only this one to popup menus, and also to prevent unexpected behavior of controls like text fields, that expect 1st and 2nd button to be reserved for contextual operations like text or item selection...

Return value

string Full path name to the menu.

In query mode, return type is based on queried flag.


allowOptionBoxes, altModifier, button, ctrlModifier, deleteAllItems, itemArray, markingMenu, numberOfItems, postMenuCommand, postMenuCommandOnce, shiftModifier
Long name (short name) Argument types Properties
altModifier(alt) boolean createqueryedit
Specify this flag if the Alt modifier must be pressed when posting the popup menu.
ctrlModifier(ctl) boolean createqueryedit
Specify this flag if the Cntl modifier must be pressed when posting the popup menu.
shiftModifier(sh) boolean createqueryedit
Specify this flag if the Shift modifier must be pressed when posting the popup menu.
button(b) int createqueryedit
Indicate which button posts the popup menu. Valid values range from 1 to 3 where 1 is the left most button on the mouse.
allowOptionBoxes(aob) boolean createquery
Indicate whether the menu will be able to support option box menu items. An error results if an option box item is added to a menu that doesn't allow them. This flag may be queried and must be specified when the popup menu is created. The default value is false.
markingMenu(mm) boolean createqueryedit
Set the marking menu state of this popup menu.
postMenuCommand(pmc) script createedit
Specify a script to be executed when the popup menu is about to be shown.
postMenuCommandOnce(pmo) boolean createqueryedit
Indicate the -pmc/postMenuCommand should only be invoked once. Default value is false, ie. the -pmc/postMenuCommand is invoked every time the popup menu is shown.
numberOfItems(ni) boolean query
Return number of items in the menu.
itemArray(ia) boolean query
Return string array of the menu item names.
deleteAllItems(dai) boolean edit
Delete all the items in this menu.

Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

cmds.popupMenu( button=1 )
cmds.checkBox( 'aCheckBox' )
cmds.popupMenu( parent='aCheckBox', alt=True, ctl=True )