optionMenuGrp

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

Synopsis

optionMenuGrp( [groupName] , [adjustableColumn=int], [adjustableColumn2=int], [adjustableColumn3=int], [adjustableColumn4=int], [adjustableColumn5=int], [adjustableColumn6=int], [annotation=string], [backgroundColor=[float, float, float]], [changeCommand=script], [columnAlign=[int, string]], [columnAlign2=[string, string]], [columnAlign3=[string, string, string]], [columnAlign4=[string, string, string, string]], [columnAlign5=[string, string, string, string, string]], [columnAlign6=[string, string, string, string, string, string]], [columnAttach=[int, string, int]], [columnAttach2=[string, string]], [columnAttach3=[string, string, string]], [columnAttach4=[string, string, string, string]], [columnAttach5=[string, string, string, string, string]], [columnAttach6=[string, string, string, string, string, string]], [columnOffset2=[int, int]], [columnOffset3=[int, int, int]], [columnOffset4=[int, int, int, int]], [columnOffset5=[int, int, int, int, int]], [columnOffset6=[int, int, int, int, int, int]], [columnWidth=[int, int]], [columnWidth1=int], [columnWidth2=[int, int]], [columnWidth3=[int, int, int]], [columnWidth4=[int, int, int, int]], [columnWidth5=[int, int, int, int, int]], [columnWidth6=[int, int, int, int, int, int]], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [exists=boolean], [extraLabel=string], [fullPathName=boolean], [height=int], [highlightColor=[float, float, float]], [isObscured=boolean], [itemListLong=boolean], [itemListShort=boolean], [label=string], [manage=boolean], [noBackground=boolean], [numberOfItems=boolean], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [rowAttach=[int, string, int]], [select=int], [useTemplate=string], [value=string], [visible=boolean], [visibleChangeCommand=script], [width=int])

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

optionMenuGrp is undoable, queryable, and editable.

All of the group commands position their individual controls in columns starting at column 1. The layout of each control (ie. column) can be customized using the -cw/columnWidth, -co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags. By default, columns are left aligned with no offset and are 100 pixels wide. Only one column in any group can be adjustable.

This command creates a pre-packaged collection of label text, option menu and an extra label. Both the label and extra label are optional. Subsequent calls to the menuItem command will place them in the option menu. When adding menu items to the option menu after the initialization step, use the name of the options menu itself. See the example below for more details. Note that commands attached to menu items will not get called. Use the -cc/changedCommand flag to be notified when the user changes the value of the option menu.

Return value

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

Flags

Long name (short name)	Argument types	Properties
adjustableColumn(adj)	int
Specifies which column has an adjustable size that changes with the sizing of the layout. The column value is a 1-based index. You may also specify 0 to turn off the previous adjustable column.
adjustableColumn2(ad2)	int
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly two columns.
adjustableColumn3(ad3)	int
Specifies that the column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly three columns.
adjustableColumn4(ad4)	int
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly four columns.
adjustableColumn5(ad5)	int
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly five columns.
adjustableColumn6(ad6)	int
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly six columns.
annotation(ann)	string
Annotate the control with an extra string value.
backgroundColor(bgc)	[float, float, float]
The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
changeCommand(cc)	script
Command executed when a new item is selected.
columnAlign(cal)	[int, string]
Arguments are : column number, alignment type. Possible alignments are: left | right | center. Specifies alignment type for the specified column.
columnAlign2(cl2)	[string, string]
Sets the text alignment of both columns. Ignored if there are not exactly two columns. Valid values are "left", "right", and "center".
columnAlign3(cl3)	[string, string, string]
Sets the text alignment for all 3 columns. Ignored if there are not exactly 3 columns. Valid values are "left", "right", and "center".
columnAlign4(cl4)	[string, string, string, string]
Sets the text alignment for all 4 columns. Ignored if there are not exactly 4 columns. Valid values are "left", "right", and "center".
columnAlign5(cl5)	[string, string, string, string, string]
Sets the text alignment for all 5 columns. Ignored if there are not exactly 5 columns. Valid values are "left", "right", and "center".
columnAlign6(cl6)	[string, string, string, string, string, string]
Sets the text alignment for all 6 columns. Ignored if there are not exactly 6 columns. Valid values are "left", "right", and "center".
columnAttach(cat)	[int, string, int]
Arguments are : column number, attachment type, and offset. Possible attachments are: left | right | both. Specifies column attachment types and offets.
columnAttach2(ct2)	[string, string]
Sets the attachment type of both columns. Ignored if there are not exactly two columns. Valid values are "left", "right", and "both".
columnAttach3(ct3)	[string, string, string]
Sets the attachment type for all 3 columns. Ignored if there are not exactly 3 columns. Valid values are "left", "right", and "both".
columnAttach4(ct4)	[string, string, string, string]
Sets the attachment type for all 4 columns. Ignored if there are not exactly 4 columns. Valid values are "left", "right", and "both".
columnAttach5(ct5)	[string, string, string, string, string]
Sets the attachment type for all 5 columns. Ignored if there are not exactly 5 columns. Valid values are "left", "right", and "both".
columnAttach6(ct6)	[string, string, string, string, string, string]
Sets the attachment type for all 6 columns. Ignored if there are not exactly 6 columns. Valid values are "left", "right", and "both".
columnOffset2(co2)	[int, int]
This flag is used in conjunction with the -columnAttach2 flag. If that flag is not used then this flag will be ignored. It sets the offset for the two columns. The offsets applied are based on the attachments specified with the -columnAttach2 flag. Ignored if there are not exactly two columns.
columnOffset3(co3)	[int, int, int]
This flag is used in conjunction with the -columnAttach3 flag. If that flag is not used then this flag will be ignored. It sets the offset for the three columns. The offsets applied are based on the attachments specified with the -columnAttach3 flag. Ignored if there are not exactly three columns.
columnOffset4(co4)	[int, int, int, int]
This flag is used in conjunction with the -columnAttach4 flag. If that flag is not used then this flag will be ignored. It sets the offset for the four columns. The offsets applied are based on the attachments specified with the -columnAttach4 flag. Ignored if there are not exactly four columns.
columnOffset5(co5)	[int, int, int, int, int]
This flag is used in conjunction with the -columnAttach5 flag. If that flag is not used then this flag will be ignored. It sets the offset for the five columns. The offsets applied are based on the attachments specified with the -columnAttach5 flag. Ignored if there are not exactly five columns.
columnOffset6(co6)	[int, int, int, int, int, int]
This flag is used in conjunction with the -columnAttach6 flag. If that flag is not used then this flag will be ignored. It sets the offset for the six columns. The offsets applied are based on the attachments specified with the -columnAttach6 flag. Ignored if there are not exactly six columns.
columnWidth(cw)	[int, int]
Arguments are : column number, column width. Sets the width of the specified column where the first parameter specifies the column (1 based index) and the second parameter specifies the width.
columnWidth1(cw1)	int
Sets the width of the first column. Ignored if there is not exactly one column.
columnWidth2(cw2)	[int, int]
Sets the column widths of both columns. Ignored if there are not exactly two columns.
columnWidth3(cw3)	[int, int, int]
Sets the column widths for all 3 columns. Ignored if there are not exactly 3 columns.
columnWidth4(cw4)	[int, int, int, int]
Sets the column widths for all 4 columns. Ignored if there are not exactly 4 columns.
columnWidth5(cw5)	[int, int, int, int, int]
Sets the column widths for all 5 columns. Ignored if there are not exactly 5 columns.
columnWidth6(cw6)	[int, int, int, int, int, int]
Sets the column widths for all 6 columns. Ignored if there are not exactly 6 columns.
defineTemplate(dt)	string
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
docTag(dtg)	string
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
dragCallback(dgc)	script
Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form: global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys "dragControl", "x", "y", "modifiers". The "dragControl" value is a string and the other values are integers (eg the callback string could be "print '%(dragControl)s %(x)d %(y)d %(modifiers)d'")
dropCallback(dpc)	script
Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys "dragControl", "dropControl", "messages", "x", "y", "type". The "dragControl" value is a string and the other values are integers (eg the callback string could be "print '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'")
enable(en)	boolean
The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
enableBackground(ebg)	boolean
Enables the background color of the control.
exists(ex)	boolean
Returns whether the specified object exists or not. Other flags are ignored.
extraLabel(el)	string
If present on creation this specifies that there will be an extra label to the right of the option menu. Sets the string to be the extra label text.
fullPathName(fpn)	boolean
Return the full path name of the widget, which includes all the parents
height(h)	int
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
highlightColor(hlc)	[float, float, float]
The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
isObscured(io)	boolean
Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's window is invisible or iconified.
itemListLong(ill)	boolean
Returns the long names of the items.
itemListShort(ils)	boolean
Returns the short names of the items.
label(l)	string
If present on creation this specifies that there will be a label to the left of the option menu. Sets the string to be the label text.
manage(m)	boolean
Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
noBackground(nbg)	boolean
Clear/reset the control's background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
numberOfItems(ni)	boolean
Returns the number of items.
numberOfPopupMenus(npm)	boolean
Return the number of popup menus attached to this control.
parent(p)	string
The parent layout for this control.
popupMenuArray(pma)	boolean
Return the names of all the popup menus attached to this control.
preventOverride(po)	boolean
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
rowAttach(rat)	[int, string, int]
Arguments are : column, attachment type, offset. Possible attachments are: top | bottom | both. Specifies attachment types and offsets for the entire row.
select(sl)	int
Selects an item by index. The first item is 1.
useTemplate(ut)	string
Force the command to use a command template other than the current one.
value(v)	string
Select an item by value. Also, returns the text of the currently selected item.
visible(vis)	boolean
The visible state of the control. A control is created visible by default. Note that a control's actual appearance is also dependent on the visible state of its parent layout(s).
visibleChangeCommand(vcc)	script
Command that gets executed when visible state of the control changes.
width(w)	int
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

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

#    Create a window with two option menu groups.
#
window = cmds.window( title='Example 1' )
cmds.columnLayout()

#    Create a couple of option menu groups.
#
colors = cmds.optionMenuGrp(label='Colors')
cmds.menuItem( label='Red' )
cmds.menuItem( label='Green' )
cmds.optionMenuGrp( l='Position' )
cmds.menuItem( label='Left' )
cmds.menuItem( label='Center' )
cmds.menuItem( label='Right' )

#    Now add an additional item to the first option menu.
#
cmds.menuItem(parent=(colors +'|OptionMenu'), label='Blue' )
cmds.showWindow( window )

#    Create another window with an option menu group.
#
window = cmds.window( title='Example 2' )
cmds.columnLayout()
cmds.optionMenuGrp( label='Size', extraLabel='cm', columnWidth=(2, 80) )
cmds.menuItem( label='10' )
cmds.menuItem( label='100' )
cmds.menuItem( label='1000' )
cmds.showWindow( window )