pymel.core.uitypes.ChannelBox

class ChannelBox

class counterpart of mel function channelBox

This command creates a channel box, which is sensitive to the active list. It displays certain attributes (channels) of the last node on the active list, and provides a two-way connection to keep the widget up to date. Note: when setting the color of attribute names, that color is only valid for its current Maya session; each subsequent session will display the default color for the attribute name(s) listed in the Channel Box. Any subsequent attributes that are added to the Channel Box will be affected by prior regular expressions in their current Maya session.

dragCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.channelBox

dropCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.channelBox

execute(val=True, **kwargs)

Immediately executes the command string once for every cell (or every selected cell, if the boolean argument is TRUE) in the channel box, for every matching selected object (ie, for every object would be affected if you changed a cell value.) Before the command is executed, “#A” is substituted with the name of the attribute, and “#N” with the name of the node, and “#P” with the full path name of the node.

Derived from mel command maya.cmds.channelBox

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.channelBox

getAttrBgColor(**kwargs)

Controls the background text color of specific attribute names. As with the foreground option, this text coloring also depends on the node name choice for the nodeRegex flag. Arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. If attrRegex is unspecified then it will assume a value of “*” for a regular expression. The same idea simultaneously applies to the flag nodeRegex. Note: nodes that are renamed will have their node name coloring be affected in the channel box.

Derived from mel command maya.cmds.channelBox

getAttrColor(**kwargs)

Controls the foreground text color of specific attribute names. This text coloring also depends on the node name choice for the nodeRegex flag. Arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. If attrRegex is unspecified then it will assume a value of “*” for a regular expression. The same idea simultaneously applies to the flag nodeRegex. Note: nodes that are renamed will have their node name coloring be affected in the channel box.

Derived from mel command maya.cmds.channelBox

getAttrFilter(**kwargs)

Specifies the name of an itemFilter object to be placed on the channel box. This filters the attributes displayed. A filter of “0” can be used to reset the filter.

Derived from mel command maya.cmds.channelBox

getAttrRegex(**kwargs)

Specifies a valid regular expression to specify which attribute names should be selected for foreground text coloring. If attrRegex is unspecified then it will assume a value of “*” for a regular expression. The same idea simultaneously applies to the flag nodeRegex. The attrColor flag is required to be specified. Note: this regular expression will be treated as though it were case-insensitve

Derived from mel command maya.cmds.channelBox

getAttributeEditorMode(**kwargs)

Modifies what appears in the channel box for use in the attribute editor. Default is false. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

getBackgroundColor(**kwargs)

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.

Derived from mel command maya.cmds.channelBox

getContainerAtTop(**kwargs)

This flag can be used to specify whether or not the container is drawn at the top of the channel box when a node in the container is selected.

Derived from mel command maya.cmds.channelBox

getDocTag(**kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.channelBox

getEnable(**kwargs)

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.

Derived from mel command maya.cmds.channelBox

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.channelBox

getEnableLabelSelection(**kwargs)

Enables the selection of attributes in the channelBox when used in conjunction with -attributeEditorMode. Default is false. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

getFieldWidth(**kwargs)

An optional flag which is used to modify the width assigned to fields appearing in the channelBox.

Derived from mel command maya.cmds.channelBox

getFixedAttrList(**kwargs)

Forces the channel box to only display attributes with the specified names, in the order they are specified. If an empty list is specified, then the channel box will revert to its default behaviour of listing all keyable attributes.

Derived from mel command maya.cmds.channelBox

getFullPathName(**kwargs)

Return the full path name of the widget, which includes all the parents

Derived from mel command maya.cmds.channelBox

getHeight(**kwargs)

The height 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.channelBox

getHistoryObjectList(**kwargs)

Returns a list of strings, the names of every INPUT node associated with an object on the main object list that is of the same type as the node displayed in the INPUT section of the channel box.

Derived from mel command maya.cmds.channelBox

getHyperbolic(**kwargs)

Determines whether or not the distance that the mouse has been dragged should be interpreted as a linear or hyperbolic function. The default is set to hyperbolic being false.

Derived from mel command maya.cmds.channelBox

getIsObscured(**kwargs)

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.

Derived from mel command maya.cmds.channelBox

getLabelWidth(**kwargs)

An optional flag which is used to modify the width assigned to labels appearing in the channelBox.

Derived from mel command maya.cmds.channelBox

getLongNames(**kwargs)

Controls whether long or short attribute names will be used in the interface. Note that this flag is ignored if the -niceNames flag is set. Default is short names. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

getMainListConnection(**kwargs)

Specifies the name of a selectionConnection object which the editor will use as its source of content. The channel box will only display the (last) item contained in the selectionConnection object. If a NULL string (“”) is specified, then the channel box will revert to its default behaviour of working on the active list.

Derived from mel command maya.cmds.channelBox

getMainObjectList(**kwargs)

Returns a list of strings, the names of every object on the active list that is the same type as the object displayed in the top (main) section of the channel box.

Derived from mel command maya.cmds.channelBox

getManage(**kwargs)

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.

Derived from mel command maya.cmds.channelBox

getMaxHeight(**kwargs)

An optional flag which is used to limit the height of the channelBox.

Derived from mel command maya.cmds.channelBox

getMaxWidth(**kwargs)

An optional flag which is used to limit the width of the channelBox.

Derived from mel command maya.cmds.channelBox

getNiceNames(**kwargs)

Controls whether the attribute names will be displayed in a more user-friendly, readable way. When this is on, the longNames flag is ignored. When this is off, attribute names will be displayed either long or short, according to the longNames flag. Default is on. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

getNodeRegex(**kwargs)

Specifies a valid regular expression to specify which node names should (potentially) have their attributes selected for foreground text coloring. If nodeRegex is unspecified then it will assume a value of “*’ for a regular expression. The same idea simultaneously applies to the flag attrRegex. The attrColor flag is required to be specified. Note: this regular expression will be treated as though it were case-insensitve Note: nodes in namespaces have regular expressions applied as though those nodes weren’t in namespaces

Derived from mel command maya.cmds.channelBox

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.channelBox

getOutputObjectList(**kwargs)

Returns a list of strings, the names of every OUTPUT node associated an object on the main object list that is of the same type as the node displayed in the OUTPUT section of the channel box.

Derived from mel command maya.cmds.channelBox

getPopupMenuArray(**kwargs)

Return the names of all the popup menus attached to this control.

Derived from mel command maya.cmds.channelBox

getPrecision(**kwargs)

Controls the number of digits to the right of the decimal point that will be displayed for float-valued channels. Default is 3. Queried, returns an int.

Derived from mel command maya.cmds.channelBox

getPreventOverride(**kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.channelBox

getRotationContext(**kwargs)

This flag can be used to specify the name of the rotation context that should be used by the channel box. If no rotationContext is specified a default context will created and used.

Derived from mel command maya.cmds.channelBox

getScaleContext(**kwargs)

This flag can be used to specify the name of the scale context that should be used by the channel box. If no scaleContext is specified a default context will be created and used.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.channelBox

getSelectedHistoryAttributes(**kwargs)

Returns a list of strings, the names of all the selected attributes in the INPUT section of the channel box.

Derived from mel command maya.cmds.channelBox

getSelectedMainAttributes(**kwargs)

Returns a list of strings, the names of all the selected attributes in the top section of the channel box.

Derived from mel command maya.cmds.channelBox

getSelectedOutputAttributes(**kwargs)

Returns a list of strings, the names of all the selected attributes in the OUTPUT section of the channel box.

Derived from mel command maya.cmds.channelBox

getSelectedShapeAttributes(**kwargs)

Returns a list of strings, the names of all the selected attributes in the middle (shape) section of the channel box.

Derived from mel command maya.cmds.channelBox

getShapeObjectList(**kwargs)

Returns a list of strings, the names of every shape associated with an object on the main object list that is of the same type as the object displayed in the middle (shape) section of the channel box.

Derived from mel command maya.cmds.channelBox

getShowNamespace(**kwargs)

Controls whether or not the namespace of an object is displayed if the object is not in the root namespace.

Derived from mel command maya.cmds.channelBox

getShowTransforms(**kwargs)

Controls whether this control will display transform attributes only, or all other attributes. False by default. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

getSpeed(**kwargs)

Controls the speed at which the attributes are changed based on the distance the mouse has been dragged. Common settings for slow/medium/fast are 0.1/1.0/10.0 respectively. The default is 1.0.

Derived from mel command maya.cmds.channelBox

getTranslationContext(**kwargs)

This flag can be used to specify the name of the translation context that should be used by the channel box. If no translationContext is specified a default context will created and used.

Derived from mel command maya.cmds.channelBox

getUseManips(**kwargs)

When you click on a field or label in the channel box, the tool switches to a manipulator that can change that value if you drag in the 3d view. This flag controls the kind of manips. Allowed values are “none” (self-explanatory), “invisible” (you won’t see anything, but dragging in the window will adjust any of the selected attributes), and “standard” (the same as invisible, except for scale, rotate, and translate, which will be represented by their usual manips.)

Derived from mel command maya.cmds.channelBox

getVisible(**kwargs)

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).

Derived from mel command maya.cmds.channelBox

getVisibleChangeCommand(**kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.channelBox

getWidth(**kwargs)

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.channelBox

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.channelBox

setAttrBgColor(val=True, **kwargs)

Controls the background text color of specific attribute names. As with the foreground option, this text coloring also depends on the node name choice for the nodeRegex flag. Arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. If attrRegex is unspecified then it will assume a value of “*” for a regular expression. The same idea simultaneously applies to the flag nodeRegex. Note: nodes that are renamed will have their node name coloring be affected in the channel box.

Derived from mel command maya.cmds.channelBox

setAttrColor(val=True, **kwargs)

Controls the foreground text color of specific attribute names. This text coloring also depends on the node name choice for the nodeRegex flag. Arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. If attrRegex is unspecified then it will assume a value of “*” for a regular expression. The same idea simultaneously applies to the flag nodeRegex. Note: nodes that are renamed will have their node name coloring be affected in the channel box.

Derived from mel command maya.cmds.channelBox

setAttrFilter(val=True, **kwargs)

Specifies the name of an itemFilter object to be placed on the channel box. This filters the attributes displayed. A filter of “0” can be used to reset the filter.

Derived from mel command maya.cmds.channelBox

setAttrRegex(val=True, **kwargs)

Specifies a valid regular expression to specify which attribute names should be selected for foreground text coloring. If attrRegex is unspecified then it will assume a value of “*” for a regular expression. The same idea simultaneously applies to the flag nodeRegex. The attrColor flag is required to be specified. Note: this regular expression will be treated as though it were case-insensitve

Derived from mel command maya.cmds.channelBox

setAttributeEditorMode(val=True, **kwargs)

Modifies what appears in the channel box for use in the attribute editor. Default is false. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

setBackgroundColor(val=True, **kwargs)

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.

Derived from mel command maya.cmds.channelBox

setContainerAtTop(val=True, **kwargs)

This flag can be used to specify whether or not the container is drawn at the top of the channel box when a node in the container is selected.

Derived from mel command maya.cmds.channelBox

setDocTag(val=True, **kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.channelBox

setEnable(val=True, **kwargs)

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.

Derived from mel command maya.cmds.channelBox

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.channelBox

setEnableLabelSelection(val=True, **kwargs)

Enables the selection of attributes in the channelBox when used in conjunction with -attributeEditorMode. Default is false. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

setFieldWidth(val=True, **kwargs)

An optional flag which is used to modify the width assigned to fields appearing in the channelBox.

Derived from mel command maya.cmds.channelBox

setFixedAttrList(val=True, **kwargs)

Forces the channel box to only display attributes with the specified names, in the order they are specified. If an empty list is specified, then the channel box will revert to its default behaviour of listing all keyable attributes.

Derived from mel command maya.cmds.channelBox

setHeight(val=True, **kwargs)

The height 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.channelBox

setHyperbolic(val=True, **kwargs)

Determines whether or not the distance that the mouse has been dragged should be interpreted as a linear or hyperbolic function. The default is set to hyperbolic being false.

Derived from mel command maya.cmds.channelBox

setLabelWidth(val=True, **kwargs)

An optional flag which is used to modify the width assigned to labels appearing in the channelBox.

Derived from mel command maya.cmds.channelBox

setLongNames(val=True, **kwargs)

Controls whether long or short attribute names will be used in the interface. Note that this flag is ignored if the -niceNames flag is set. Default is short names. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

setMainListConnection(val=True, **kwargs)

Specifies the name of a selectionConnection object which the editor will use as its source of content. The channel box will only display the (last) item contained in the selectionConnection object. If a NULL string (“”) is specified, then the channel box will revert to its default behaviour of working on the active list.

Derived from mel command maya.cmds.channelBox

setManage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.channelBox

setMaxHeight(val=True, **kwargs)

An optional flag which is used to limit the height of the channelBox.

Derived from mel command maya.cmds.channelBox

setMaxWidth(val=True, **kwargs)

An optional flag which is used to limit the width of the channelBox.

Derived from mel command maya.cmds.channelBox

setNiceNames(val=True, **kwargs)

Controls whether the attribute names will be displayed in a more user-friendly, readable way. When this is on, the longNames flag is ignored. When this is off, attribute names will be displayed either long or short, according to the longNames flag. Default is on. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

setNodeRegex(val=True, **kwargs)

Specifies a valid regular expression to specify which node names should (potentially) have their attributes selected for foreground text coloring. If nodeRegex is unspecified then it will assume a value of “*’ for a regular expression. The same idea simultaneously applies to the flag attrRegex. The attrColor flag is required to be specified. Note: this regular expression will be treated as though it were case-insensitve Note: nodes in namespaces have regular expressions applied as though those nodes weren’t in namespaces

Derived from mel command maya.cmds.channelBox

setPrecision(val=True, **kwargs)

Controls the number of digits to the right of the decimal point that will be displayed for float-valued channels. Default is 3. Queried, returns an int.

Derived from mel command maya.cmds.channelBox

setPreventOverride(val=True, **kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.channelBox

setRotationContext(val=True, **kwargs)

This flag can be used to specify the name of the rotation context that should be used by the channel box. If no rotationContext is specified a default context will created and used.

Derived from mel command maya.cmds.channelBox

setScaleContext(val=True, **kwargs)

This flag can be used to specify the name of the scale context that should be used by the channel box. If no scaleContext is specified a default context will be created and used.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.channelBox

setShowNamespace(val=True, **kwargs)

Controls whether or not the namespace of an object is displayed if the object is not in the root namespace.

Derived from mel command maya.cmds.channelBox

setShowTransforms(val=True, **kwargs)

Controls whether this control will display transform attributes only, or all other attributes. False by default. Queried, returns a boolean.

Derived from mel command maya.cmds.channelBox

setSpeed(val=True, **kwargs)

Controls the speed at which the attributes are changed based on the distance the mouse has been dragged. Common settings for slow/medium/fast are 0.1/1.0/10.0 respectively. The default is 1.0.

Derived from mel command maya.cmds.channelBox

setTranslationContext(val=True, **kwargs)

This flag can be used to specify the name of the translation context that should be used by the channel box. If no translationContext is specified a default context will created and used.

Derived from mel command maya.cmds.channelBox

setUseManips(val=True, **kwargs)

When you click on a field or label in the channel box, the tool switches to a manipulator that can change that value if you drag in the 3d view. This flag controls the kind of manips. Allowed values are “none” (self-explanatory), “invisible” (you won’t see anything, but dragging in the window will adjust any of the selected attributes), and “standard” (the same as invisible, except for scale, rotate, and translate, which will be represented by their usual manips.)

Derived from mel command maya.cmds.channelBox

setVisible(val=True, **kwargs)

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).

Derived from mel command maya.cmds.channelBox

setVisibleChangeCommand(val=True, **kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.channelBox

setWidth(val=True, **kwargs)

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.channelBox

takeFocus(val=True, **kwargs)

causes the channel box to take over the keyboard focus, if it can.

Derived from mel command maya.cmds.channelBox

update(val=True, **kwargs)

This flag can be used to force an update of the channel box display, for example after changing a display preference.

Derived from mel command maya.cmds.channelBox