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

Synopsis

menu( [string] , [allowOptionBoxes=boolean], [deleteAllItems=boolean], [docTag=string], [enable=boolean], [familyImage=string], [helpMenu=boolean], [itemArray=boolean], [label=string], [mnemonic=string], [numberOfItems=boolean], [parent=string], [postMenuCommand=script], [postMenuCommandOnce=boolean], [tearOff=boolean])

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

menu is undoable, queryable, and editable.

This command creates a new menu and adds it to the default window's menubar if no parent is specified. The menu can be enabled/disabled. Note that this command may also be used on menu objects created using the command menuItem -sm/subMenu true.

Return value

string Full path name to the menu.

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

Flags

allowOptionBoxes, deleteAllItems, docTag, enable, familyImage, helpMenu, itemArray, label, mnemonic, numberOfItems, parent, postMenuCommand, postMenuCommandOnce, tearOff
Long name (short name) Argument types Properties
enable(en) boolean createqueryedit
Enables/disables the menu.
helpMenu(hm) boolean createqueryedit
Indicates that this menu is the help menu and will be the right most menu in the menu bar. On Unix systems the help menu is also right justified in the menu bar.
label(l) string createqueryedit
The text that is displayed for the menu. If no label is supplied then the menuName will be used.
mnemonic(mn) string createqueryedit
Set the Alt key to post that menu. The character specified must match the case of its corresponding character in the menu item text, but selection from the keyboard is case insensitive.
parent(p) string create
Specify the window that the menu will appear in.
tearOff(to) boolean create
Makes the menu tear-off-able.
allowOptionBoxes(aob) boolean createquery
Deprecated. All menus now always allow option boxes. Indicate whether the menu will be able to support option box menu items.
numberOfItems(ni) boolean query
Return number of items in the menu.
itemArray(ia) boolean query
Return string array of the menu item names.
postMenuCommand(pmc) script createedit
Specify a script to be executed when the 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 menu is shown.
deleteAllItems(dai) boolean createedit
Delete all the items in this menu.
familyImage(fi) string createqueryedit
The filename of the icon associated with the menu. This icon will be used if a menu item does not have an icon image defined.
docTag(dtg) string createqueryedit
Attaches a tag to the 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.window( menuBar=True, width=200 )
cmds.menu( label='File', tearOff=True )
cmds.menuItem( label='New' )
cmds.menuItem( label='Open' )
cmds.menuItem( label='Save' )
cmds.menuItem( divider=True )
cmds.menuItem( label='Quit' )
cmds.menu( label='Help', helpMenu=True )
cmds.menuItem( 'Application..."', label='"About' )
cmds.columnLayout()
cmds.button()
cmds.button()
cmds.button()
cmds.showWindow()