pymel.core.windows.menu

menu(*args, **kwargs)

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.

Modifications

• added ability to query parent

Flags:

Long name (short name)		Argument Types	Properties
allowOptionBoxes (aob)		bool
	Deprecated. All menus now always allow option boxes. Indicate whether the menu will be able to support option box menu items.
defineTemplate (dt)		unicode
deleteAllItems (dai)		bool
	Delete all the items in this menu.
docTag (dtg)		unicode
	Attaches a tag to the menu.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
enable (en)		bool
	Enables/disables the menu.
exists (ex)		bool
familyImage (fi)		unicode
	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.
helpMenu (hm)		bool
	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.
itemArray (ia)		bool
	Return string array of the menu item names.
label (l)		unicode
	The text that is displayed for the menu. If no label is supplied then the menuName will be used.
mnemonic (mn)		unicode
	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.
numberOfItems (ni)		bool
	Return number of items in the menu.
parent (p)		unicode
	Specify the window that the menu will appear in.
postMenuCommand (pmc)		script
	Specify a script to be executed when the menu is about to be shown.
postMenuCommandOnce (pmo)		bool
	Indicate the -pmc/postMenuCommandshould only be invoked once. Default value is false, ie. the -pmc/postMenuCommandis invoked every time the menu is shown.
tearOff (to)		bool
	Makes the menu tear-off-able.
useTemplate (ut)		unicode
visible (vis)		bool

Derived from mel command maya.cmds.menu

Example:

import pymel.core as pm

import maya.cmds as cmds

pm.window( menuBar=True, width=200 )
# Result: ui.Window('window1') #
pm.menu( label='File', tearOff=True )
# Result: ui.Menu('window1|menu43') #
pm.menuItem( label='New' )
# Result: ui.CommandMenuItem('window1|menu43|menuItem414') #
pm.menuItem( label='Open' )
# Result: ui.CommandMenuItem('window1|menu43|menuItem415') #
pm.menuItem( label='Save' )
# Result: ui.CommandMenuItem('window1|menu43|menuItem416') #
pm.menuItem( divider=True )
# Result: ui.CommandMenuItem('window1|menu43|menuItem417') #
pm.menuItem( label='Quit' )
# Result: ui.CommandMenuItem('window1|menu43|menuItem418') #
pm.menu( label='Help', helpMenu=True )
# Result: ui.Menu('window1|menu44') #
pm.menuItem( 'Application..."', label='"About' )
# Result: ui.CommandMenuItem('window1|menu44|Application____') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout56') #
pm.button()
# Result: ui.Button('window1|columnLayout56|button48') #
pm.button()
# Result: ui.Button('window1|columnLayout56|button49') #
pm.button()
# Result: ui.Button('window1|columnLayout56|button50') #
pm.showWindow()