checkBoxGrp

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

Synopsis

checkBoxGrp( [groupName] , [adjustableColumn=int], [adjustableColumn2=int], [adjustableColumn3=int], [adjustableColumn4=int], [adjustableColumn5=int], [adjustableColumn6=int], [annotation=string], [backgroundColor=[float, float, float]], [changeCommand=script], [changeCommand1=script], [changeCommand2=script], [changeCommand3=script], [changeCommand4=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], [editable=boolean], [enable=boolean], [enable1=boolean], [enable2=boolean], [enable3=boolean], [enable4=boolean], [enableBackground=boolean], [exists=boolean], [fullPathName=string], [height=int], [isObscured=boolean], [label=string], [label1=string], [label2=string], [label3=string], [label4=string], [labelArray2=[string, string]], [labelArray3=[string, string, string]], [labelArray4=[string, string, string, string]], [manage=boolean], [noBackground=boolean], [numberOfCheckBoxes=int], [numberOfPopupMenus=boolean], [offCommand=script], [offCommand1=script], [offCommand2=script], [offCommand3=script], [offCommand4=script], [onCommand=script], [onCommand1=script], [onCommand2=script], [onCommand3=script], [onCommand4=script], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [rowAttach=[int, string, int]], [useTemplate=string], [value1=boolean], [value2=boolean], [value3=boolean], [value4=boolean], [valueArray2=[boolean, boolean]], [valueArray3=[boolean, boolean, boolean]], [valueArray4=[boolean, boolean, boolean, boolean]], [vertical=boolean], [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.

checkBoxGrp 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 from one to four check boxes in a single row. They can have an optional text label. TelfBaseGrpCmd.cpp

Return value

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

Flags

Long name (short name)	Argument types	Properties
exists(ex)	boolean
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
defineTemplate(dt)	string
Puts a 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.
useTemplate(ut)	string
Force the command to use a command template other than the current one.
parent(p)	string
The parent layout for this control.
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.
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.
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.
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.
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.
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.
numberOfPopupMenus(npm)	boolean
Return the number of popup menus attached to 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.
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.
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.
enableBackground(ebg)	boolean
Enables the background color of the control.
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'")
fullPathName(fpn)	string
Return the full path name of the widget, which includes all the parents
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 is not exactly two columns.
columnWidth3(cw3)	[int, int, int]
Sets the column widths for all 3 columns. Ignored if there is not exactly 3 columns.
columnWidth4(cw4)	[int, int, int, int]
Sets the column widths for all 4 columns. Ignored if there is not exactly 4 columns.
columnWidth5(cw5)	[int, int, int, int, int]
Sets the column widths for all 5 columns. Ignored if there is not exactly 5 columns.
columnWidth6(cw6)	[int, int, int, int, int, int]
Sets the column widths for all 6 columns. Ignored if there is not exactly 6 columns.
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 is 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 is 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 is 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 is 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 is 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 is 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 is 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 is 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 is 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 is not exactly six columns.
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.
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 is 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 is 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 is 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 is 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 is not exactly 6 columns. Valid values are "left", "right", and "center".
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 is 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 is 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 is 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 is 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 is not exactly six columns.
numberOfCheckBoxes(ncb)	int
Number of check boxes in the group (1 - 4).
label(l)	string
When present on creation an optional text label will be built with the group. The string specifes the label text.
label1(l1)	string
label2(l2)	string
label3(l3)	string
label4(l4)	string
Specify label strings for the respective check boxes in the group.
labelArray2(la2)	[string, string]
labelArray3(la3)	[string, string, string]
labelArray4(la4)	[string, string, string, string]
Specify multiple labels in a single flag. These flags are ignored if the number of radio buttons doesn't match.
value1(v1)	boolean
value2(v2)	boolean
value3(v3)	boolean
value4(v4)	boolean
Values for the respective check boxes in the group.
valueArray2(va2)	[boolean, boolean]
valueArray3(va3)	[boolean, boolean, boolean]
valueArray4(va4)	[boolean, boolean, boolean, boolean]
Specifies multiple values in a single flag. These flags are ignored if the number of check boxes doesn't match.
changeCommand(cc)	script
Command executed when the group changes state. Note that this flag should not be used in conjunction with onCommand and offCommand. That is, one should either use changeCommand and test the state of a check box from inside the callback, or use onCommand and offCommand as separate callbacks.
changeCommand1(cc1)	script
changeCommand2(cc2)	script
changeCommand3(cc3)	script
changeCommand4(cc4)	script
Specify a changed state command for each respective check box.
onCommand(onc)	script
Command executed when any check box turns on.
onCommand1(on1)	script
onCommand2(on2)	script
onCommand3(on3)	script
onCommand4(on4)	script
On command for each respective check box.
offCommand(ofc)	script
Command executed when any check box turns off.
offCommand1(of1)	script
offCommand2(of2)	script
offCommand3(of3)	script
offCommand4(of4)	script
Off command for each respective check box.
enable1(en1)	boolean
enable2(en2)	boolean
enable3(en3)	boolean
enable4(en4)	boolean
Enable state of the individual check boxes.
editable(ed)	boolean
The edit state of the group. By default, this flag is set to true and the check box values may be changed by clicking on them. If false then the check boxes are 'read only' and can not be clicked on. The value of the check boxes can always be changed with the -v/value flags regardless of the state of the -ed/editable flag.
vertical(vr)	boolean
Whether the orientation of the checkbox controls in this group are horizontal (default) or vertical.

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

exampleWindow = cmds.window()
cmds.columnLayout()
cmds.checkBoxGrp( numberOfCheckBoxes=3, label='Three Buttons', labelArray3=['One', 'Two', 'Three'] )
cmds.checkBoxGrp( numberOfCheckBoxes=4, label='Four Buttons', labelArray4=['I', 'II', 'III', 'IV'] )
cmds.showWindow( exampleWindow )
# Place a single checkbox with a label width of 100 pixels, and a checkbox
# width of 165 pixels.  In this example, the two columns of the checkBoxGrp
# controlled by the columnWidth2 flag are the label column and the checkbox
# column.  Horizontal positioning of the checkbox can be controlled by
# adjusting the width of the first column.
exampleWindow = cmds.window()
cmds.rowLayout()
cmds.checkBoxGrp(columnWidth2=[100, 165], numberOfCheckBoxes=1, label='A Label', label1='A Checkbox', v1=True)
cmds.showWindow(exampleWindow)