pymel.core.windows.checkBoxGrp

static windows.checkBoxGrp(*args, **kwargs)

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/adjustableColumnflags. 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

Flags:
Long name (short name) Argument Types Properties
adjustableColumn (adj) int ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly six columns.
annotation (ann) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Annotate the control with an extra string value.
backgroundColor (bgc) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
   
changeCommand2 (cc2) script ../../../_images/create.gif ../../../_images/edit.gif
   
changeCommand3 (cc3) script ../../../_images/create.gif ../../../_images/edit.gif
   
changeCommand4 (cc4) script ../../../_images/create.gif ../../../_images/edit.gif
 
Specify a changed state command for each respective check box.
columnAlign (cal) int, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
Arguments are : column number, alignment type. Possible alignments are: left | right | center. Specifies alignment type for the specified column.
columnAlign2 (cl2) unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the text alignment of both columns. Ignored if there is not exactly two columns. Valid values are left, right, and center.
columnAlign3 (cl3) unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
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) unicode, unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
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) unicode, unicode, unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
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) unicode, unicode, unicode, unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the text alignment for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are left, right, and center.
columnAttach (cat) int, unicode, int ../../../_images/create.gif ../../../_images/edit.gif
 
Arguments are : column number, attachment type, and offset. Possible attachments are: left | right | both. Specifies column attachment types and offets.
columnAttach2 (ct2) unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the attachment type of both columns. Ignored if there is not exactly two columns. Valid values are left, right, and both.
columnAttach3 (ct3) unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
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) unicode, unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
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) unicode, unicode, unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
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) unicode, unicode, unicode, unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 

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.

columnWidth (cw) int, int ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the width of the first column. Ignored if there is not exactly one column.
columnWidth2 (cw2) int, int ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the column widths of both columns. Ignored if there is not exactly two columns.
columnWidth3 (cw3) int, int, int ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the column widths for all 3 columns. Ignored if there is not exactly 3 columns.
columnWidth4 (cw4) int, int, int, int ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the column widths for all 4 columns. Ignored if there is not exactly 4 columns.
columnWidth5 (cw5) int, int, int, int, int ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the column widths for all 5 columns. Ignored if there is not exactly 5 columns.
columnWidth6 (cw6) int, int, int, int, int, int ../../../_images/create.gif ../../../_images/edit.gif
 
Sets the column widths for all 6 columns. Ignored if there is not exactly 6 columns.
defineTemplate (dt) unicode ../../../_images/create.gif
 

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.

docTag (dtg) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 dragControlvalue 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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 dragControlvalue 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’

editable (ed) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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/valueflags regardless of the state of the -ed/editableflag.

enable (en) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

enable1 (en1) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
enable2 (en2) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
enable3 (en3) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
enable4 (en4) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Enable state of the individual check boxes.
enableBackground (ebg) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Enables the background color of the control.
exists (ex) bool ../../../_images/create.gif
 
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
fullPathName (fpn) unicode ../../../_images/query.gif
 
Return the full path name of the widget, which includes all the parents
height (h) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
isObscured (io) bool ../../../_images/query.gif
 

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.

label (l) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
When present on creation an optional text label will be built with the group. The string specifes the label text.
label1 (l1) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
label2 (l2) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
label3 (l3) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
label4 (l4) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specify label strings for the respective check boxes in the group.
labelArray2 (la2) unicode, unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
labelArray3 (la3) unicode, unicode, unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
labelArray4 (la4) unicode, unicode, unicode, unicode ../../../_images/create.gif ../../../_images/edit.gif
 
Specify multiple labels in a single flag. These flags are ignored if the number of radio buttons doesn’t match.
manage (m) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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.
numberOfCheckBoxes (ncb) int ../../../_images/create.gif
 
Number of check boxes in the group (1 - 4).
numberOfPopupMenus (npm) bool ../../../_images/query.gif
 
Return the number of popup menus attached to this control.
offCommand (ofc) script ../../../_images/create.gif ../../../_images/edit.gif
 
Command executed when any check box turns off.
offCommand1 (of1) script ../../../_images/create.gif ../../../_images/edit.gif
   
offCommand2 (of2) script ../../../_images/create.gif ../../../_images/edit.gif
   
offCommand3 (of3) script ../../../_images/create.gif ../../../_images/edit.gif
   
offCommand4 (of4) script ../../../_images/create.gif ../../../_images/edit.gif
 
Off command for each respective check box.
onCommand (onc) script ../../../_images/create.gif ../../../_images/edit.gif
 
Command executed when any check box turns on.
onCommand1 (on1) script ../../../_images/create.gif ../../../_images/edit.gif
   
onCommand2 (on2) script ../../../_images/create.gif ../../../_images/edit.gif
   
onCommand3 (on3) script ../../../_images/create.gif ../../../_images/edit.gif
   
onCommand4 (on4) script ../../../_images/create.gif ../../../_images/edit.gif
 
On command for each respective check box.
parent (p) unicode ../../../_images/create.gif ../../../_images/query.gif
 
The parent layout for this control.
popupMenuArray (pma) bool ../../../_images/query.gif
 
Return the names of all the popup menus attached to this control.
preventOverride (po) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
rowAttach (rat) int, unicode, int ../../../_images/create.gif ../../../_images/edit.gif
 
Arguments are : column, attachment type, offset. Possible attachments are: top | bottom | both. Specifies attachment types and offsets for the entire row.
useTemplate (ut) unicode ../../../_images/create.gif
 
Force the command to use a command template other than the current one.
value1 (v1) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
value2 (v2) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
value3 (v3) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
value4 (v4) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Values for the respective check boxes in the group.
valueArray2 (va2) bool, bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
valueArray3 (va3) bool, bool, bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
valueArray4 (va4) bool, bool, bool, bool ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies multiple values in a single flag. These flags are ignored if the number of check boxes doesn’t match.
vertical (vr) bool ../../../_images/create.gif ../../../_images/query.gif
 

Whether the orientation of the checkbox controls in this group are horizontal (default) or vertical. Flag can have multiple arguments, passed either as a tuple or a list.

visible (vis) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Command that gets executed when visible state of the control changes.
width (w) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.checkBoxGrp

Example:

import pymel.core as pm

exampleWindow = pm.window()
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout12') #
pm.checkBoxGrp( numberOfCheckBoxes=3, label='Three Buttons', labelArray3=['One', 'Two', 'Three'] )
# Result: ui.CheckBoxGrp('window1|columnLayout12|checkBoxGrp1') #
pm.checkBoxGrp( numberOfCheckBoxes=4, label='Four Buttons', labelArray4=['I', 'II', 'III', 'IV'] )
# Result: ui.CheckBoxGrp('window1|columnLayout12|checkBoxGrp2') #
pm.showWindow( exampleWindow )

Previous topic

pymel.core.windows.checkBox

Next topic

pymel.core.windows.clipEditor

Core

Core Modules

Other Modules

This Page