pymel.core.uitypes.ShelfButton

Inheritance diagram of ShelfButton

class ShelfButton

class counterpart of mel function shelfButton

This control supports up to 3 icon images and 4 different display styles. The icon image displayed is the one that best fits the current size of the control given its current style. This command creates an iconTextButtonthat is designed to be on the shelf. The button contains a command that can be drag’n’dropped.

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

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

getAlign(**kwargs)

The label alignment. Alignment values are “left”, “right”, and “center”. By default, the label is aligned “center”. Currently only available when -st/style is set to “iconAndTextCentered”.

Derived from mel command maya.cmds.shelfButton

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.shelfButton

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

getCommand(**kwargs)

Command executed when the control is pressed.

Derived from mel command maya.cmds.shelfButton

getCommandRepeatable(**kwargs)

Set if the MEL command specified in the command flag should be repeatable or not. The “g” key, by default, is the shortcut to repeat the last executed command.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.shelfButton

getDisabledImage(**kwargs)

Image used when the button is disabled. Image size must be the same as the image specified with the i/imageflag. This is a Windows only flag.

Derived from mel command maya.cmds.shelfButton

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

getDoubleClickCommand(**kwargs)

Command executed when the control is double clicked.

Derived from mel command maya.cmds.shelfButton

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

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.shelfButton

getFont(**kwargs)

The font for the text. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.

Derived from mel command maya.cmds.shelfButton

getFullPathName(**kwargs)

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

Derived from mel command maya.cmds.shelfButton

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

getHighlightImage(**kwargs)

Highlight image displayed while the cursor is over the control. Image size must be the same as the image specified with the -i/imageflag. This is a Windows only flag.

Derived from mel command maya.cmds.shelfButton

getImage(**kwargs)

If you are not providing images with different sizes then you may use this flag for the control’s image. If the “iconOnly” style is set, the icon will be scaled to the size of the control.

Derived from mel command maya.cmds.shelfButton

getImage1(**kwargs)

Derived from mel command maya.cmds.shelfButton

getImage2(**kwargs)

Derived from mel command maya.cmds.shelfButton

getImage3(**kwargs)

This control supports three icons. The icon that best fits the current size of the control will be displayed.

Derived from mel command maya.cmds.shelfButton

getImageOverlayLabel(**kwargs)

A short string, up to 5 characters, representing a label that will be displayed on top of the image.

Derived from mel command maya.cmds.shelfButton

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

getLabel(**kwargs)

The text that appears in the control.

Derived from mel command maya.cmds.shelfButton

getLabelOffset(**kwargs)

The label offset. Default is 0. Currently only available when -st/style is set to “iconAndTextCentered”.

Derived from mel command maya.cmds.shelfButton

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

getMarginHeight(**kwargs)

The number of pixels above and below the control content. The default value is 1 pixel.

Derived from mel command maya.cmds.shelfButton

getMarginWidth(**kwargs)

The number of pixels on either side of the control content. The default value is 1 pixel.

Derived from mel command maya.cmds.shelfButton

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.shelfButton

getOverlayLabelBackColor(**kwargs)

The RGBA color of the shadow behind the label defined by imageOverlayLabel. Default is 25% transparent black: 0 0 0 .25

Derived from mel command maya.cmds.shelfButton

getOverlayLabelColor(**kwargs)

The RGB color of the label defined by imageOverlayLabel. Default is a light grey: .8 .8 .8

Derived from mel command maya.cmds.shelfButton

getPopupMenuArray(**kwargs)

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

Derived from mel command maya.cmds.shelfButton

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

getSelectionImage(**kwargs)

Image displayed while the control is selected. Image size must be the same as the image specified with the -i/imageflag. This is a Windows only flag.

Derived from mel command maya.cmds.shelfButton

getSourceType(**kwargs)

Sets the language type for the command script. Can only be used in conjunction with the c/command or dcc/doubleClickCommand flags. Valid values are “mel” (enabled by default), and “python”.

Derived from mel command maya.cmds.shelfButton

getStyle(**kwargs)

The draw style of the control. Valid styles are “iconOnly”, “textOnly”, “iconAndTextHorizontal”, “iconAndTextVertical”, and “iconAndTextCentered”. (Note: “iconAndTextCentered” is only available on Windows). If the “iconOnly” style is set, the icon will be scaled to the size of the control.

Derived from mel command maya.cmds.shelfButton

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

getVisibleChangeCommand(**kwargs)

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

Derived from mel command maya.cmds.shelfButton

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

handleNodeDropCallback(val=True, **kwargs)

Specify a script callback which is called when a node is dropped on the control. The name of the node being dropped will be passed to the function (python callable) or appended to the end (script) to form the command to be executed.

Derived from mel command maya.cmds.shelfButton

labelEditingCallback(val=True, **kwargs)

Specify a callback which is called after the user double clicks the label of the control to give it a new label. The new label string will be passed to the callback.

Derived from mel command maya.cmds.shelfButton

setAlign(val=True, **kwargs)

The label alignment. Alignment values are “left”, “right”, and “center”. By default, the label is aligned “center”. Currently only available when -st/style is set to “iconAndTextCentered”.

Derived from mel command maya.cmds.shelfButton

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.shelfButton

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

setCommand(val=True, **kwargs)

Command executed when the control is pressed.

Derived from mel command maya.cmds.shelfButton

setCommandRepeatable(val=True, **kwargs)

Set if the MEL command specified in the command flag should be repeatable or not. The “g” key, by default, is the shortcut to repeat the last executed command.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.shelfButton

setDisabledImage(val=True, **kwargs)

Image used when the button is disabled. Image size must be the same as the image specified with the i/imageflag. This is a Windows only flag.

Derived from mel command maya.cmds.shelfButton

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

setDoubleClickCommand(val=True, **kwargs)

Command executed when the control is double clicked.

Derived from mel command maya.cmds.shelfButton

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

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.shelfButton

setFont(val=True, **kwargs)

The font for the text. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.

Derived from mel command maya.cmds.shelfButton

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

setHighlightImage(val=True, **kwargs)

Highlight image displayed while the cursor is over the control. Image size must be the same as the image specified with the -i/imageflag. This is a Windows only flag.

Derived from mel command maya.cmds.shelfButton

setImage(val=True, **kwargs)

If you are not providing images with different sizes then you may use this flag for the control’s image. If the “iconOnly” style is set, the icon will be scaled to the size of the control.

Derived from mel command maya.cmds.shelfButton

setImage1(val=True, **kwargs)

Derived from mel command maya.cmds.shelfButton

setImage2(val=True, **kwargs)

Derived from mel command maya.cmds.shelfButton

setImage3(val=True, **kwargs)

This control supports three icons. The icon that best fits the current size of the control will be displayed.

Derived from mel command maya.cmds.shelfButton

setImageOverlayLabel(val=True, **kwargs)

A short string, up to 5 characters, representing a label that will be displayed on top of the image.

Derived from mel command maya.cmds.shelfButton

setLabel(val=True, **kwargs)

The text that appears in the control.

Derived from mel command maya.cmds.shelfButton

setLabelOffset(val=True, **kwargs)

The label offset. Default is 0. Currently only available when -st/style is set to “iconAndTextCentered”.

Derived from mel command maya.cmds.shelfButton

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

setMarginHeight(val=True, **kwargs)

The number of pixels above and below the control content. The default value is 1 pixel.

Derived from mel command maya.cmds.shelfButton

setMarginWidth(val=True, **kwargs)

The number of pixels on either side of the control content. The default value is 1 pixel.

Derived from mel command maya.cmds.shelfButton

setOverlayLabelBackColor(val=True, **kwargs)

The RGBA color of the shadow behind the label defined by imageOverlayLabel. Default is 25% transparent black: 0 0 0 .25

Derived from mel command maya.cmds.shelfButton

setOverlayLabelColor(val=True, **kwargs)

The RGB color of the label defined by imageOverlayLabel. Default is a light grey: .8 .8 .8

Derived from mel command maya.cmds.shelfButton

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

setSelectionImage(val=True, **kwargs)

Image displayed while the control is selected. Image size must be the same as the image specified with the -i/imageflag. This is a Windows only flag.

Derived from mel command maya.cmds.shelfButton

setSourceType(val=True, **kwargs)

Sets the language type for the command script. Can only be used in conjunction with the c/command or dcc/doubleClickCommand flags. Valid values are “mel” (enabled by default), and “python”.

Derived from mel command maya.cmds.shelfButton

setStyle(val=True, **kwargs)

The draw style of the control. Valid styles are “iconOnly”, “textOnly”, “iconAndTextHorizontal”, “iconAndTextVertical”, and “iconAndTextCentered”. (Note: “iconAndTextCentered” is only available on Windows). If the “iconOnly” style is set, the icon will be scaled to the size of the control.

Derived from mel command maya.cmds.shelfButton

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

setVisibleChangeCommand(val=True, **kwargs)

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

Derived from mel command maya.cmds.shelfButton

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

Previous topic

pymel.core.uitypes.Separator

Next topic

pymel.core.uitypes.ShelfLayout

Core

Core Modules

Other Modules

This Page