pymel.core.windows.shelfButton¶

shelfButton(*args, **kwargs)¶

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.

Flags:

Long Name / Short Name		Argument Types	Properties
actionIsSubstitute / ais		bool
align / al		unicode
	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.
annotation / ann		unicode
	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.
command / c		script
	Command executed when the control is pressed.
commandRepeatable / rpt		bool
	Set if the MEL command specified in the command flag should be repeatable or not. The gkey, by default, is the shortcut to repeat the last executed command.
defineTemplate / dt		unicode
	Puts the command in a mode where any other flags and arguments 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.
disabledImage / di		unicode
	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.
docTag / dtg		unicode
	Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -dt render/multiLister/createNode/material)
doubleClickCommand / dcc		script
	Command executed when the control is double clicked.
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 CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + 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
	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’
enable / en		bool
	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		bool
	Enables the background color of the control.
enableCommandRepeat / ecr		bool
	This flag only affects menu items to which a command can be attached. Specify true and the command may be repeated by executing the command repeatLast. This flag is true by default for all items except for option box items.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
flat / fla		bool
	Sets whether the control will be a flat button (0 false, 1 true).
flipX / fx		bool
	Is the image flipped horizontally?
flipY / fy		bool
	Is the image flipped vertically?
font / fn		unicode
	The font for the text. Valid values are boldLabelFont, smallBoldLabelFont, tinyBoldLabelFont, plainLabelFont, smallPlainLabelFont, obliqueLabelFont, smallObliqueLabelFont, fixedWidthFontand smallFixedWidthFont.
fullPathName / fpn		bool
	Return the full path name of the widget, which includes all the parents.
handleNodeDropCallback / hnd		script
	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.
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.
highlightImage / hi		unicode
	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.
image / i		unicode
	If you are not providing images with different sizes then you may use this flag for the control’s image. If the iconOnlystyle is set, the icon will be scaled to the size of the control.
image1 / i1		unicode
	First of three possible icons. The icon that best fits the current size of the control will be displayed.
image2 / i2		unicode
	Second of three possible icons. The icon that best fits the current size of the control will be displayed.
image3 / i3		unicode
	Third of three possible icons. The icon that best fits the current size of the control will be displayed.
imageOverlayLabel / iol		unicode
	A short string, up to 6 characters, representing a label that will be displayed on top of the image.
isObscured / io		bool
	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
	The text that appears in the control.
labelEditingCallback / lec		script
	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.
labelOffset / lo		int
	The label offset. Default is 0. Currently only available when -st/style is set to iconAndTextCentered.
ltVersion / lt		unicode
	This flag is used to specify the Maya LT version that this control feature was introduced, if the version flag is not specified, or if the version flag is specified but its argument is different. This value is only used by Maya LT, and otherwise ignored. The argument should be given as a string of the version number (e.g. 2013, 2014). Currently only accepts major version numbers (e.g. 2013 Ext 1, or 2013.5 should be given as 2014).
manage / m		bool
	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.
marginHeight / mh		int
	The number of pixels above and below the control content. The default value is 1 pixel.
marginWidth / mw		int
	The number of pixels on either side of the control content. The default value is 1 pixel.
menuItem / mi		unicode, unicode
	Creates menu items for this button by passing in arguments for the menu item label and command for each item. These should be passed as strings: labelcommandfor each use of this flag in the command.
menuItemPython / mip		int
	This flag is used to specify that a menu item is in Python. The integer value is the index of the menuItem that is modified by this flag. This is 0 based, so it corresponds to the (index+1)th occurrence of the /-mi/-menuItemflag.
noBackground / nbg		bool
	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.
noDefaultPopup / ndp		bool
	Disable the default popup menus.
numberOfPopupMenus / npm		bool
	Return the number of popup menus attached to this control.
overlayLabelBackColor / olb		float, float, float, float
	The RGBA color of the shadow behind the label defined by imageOverlayLabel. Default is 50% transparent black: 0 0 0 .5
overlayLabelColor / olc		float, float, float
	The RGB color of the label defined by imageOverlayLabel. Default is a light grey: .8 .8 .8
parent / p		unicode
	The parent layout for this control.
popupMenuArray / pma		bool
	Return the names of all the popup menus attached to this control.
preventOverride / po		bool
	If true, this flag prevents overriding the control’s attribute via the control’s right mouse button menu.
rotation / rot		float
	The rotation value of the image in radians.
scaleIcon / sic		bool
	For textOnlyand iconOnlystyle, this flag has no effect. For other styles, if the flag is specified, the icon will be scaled to the size of the control.
selectionImage / si		unicode
	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.
sourceType / stp		unicode
	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.
statusBarMessage / sbm		unicode
	Extra string to display in the status bar when the mouse is over the control.
style / st		unicode
	The draw style of the control. Valid styles are iconOnly, textOnly, iconAndTextHorizontal, iconAndTextVertical, and iconAndTextCentered. (Note: iconAndTextCenteredis only available on Windows). If the iconOnlystyle is set, the icon will be scaled to the size of the control.
useAlpha / ua		bool
	Is the image using alpha channel?
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one.
version / ver		unicode
	Specify the version that this control feature was introduced. The argument should be given as a string of the version number (e.g. 2013, 2014). Currently only accepts major version numbers (e.g. 2013 Ext 1, or 2013.5 should be given as 2014).
visible / vis		bool
	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 have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.shelfButton

Example:

import pymel.core as pm

#    Create a window with a shelf in it.  You can add more items to
#    this shelf by creating more 'shelfButton' objects or by dragging
#    other shelf items to the window.  Similary, you can delete the
#    shelf items with the 'deleteUI' command or by dragging the items
#    to the trash can located on the main Maya window shelf.
#
window = pm.window( title = 'shelfButton Example')
tabs = pm.tabLayout()
shelf = pm.shelfLayout()

#    Create some shelf buttons...
#
#    1.  A button that prints a message to the Command Line.
#
pm.shelfButton( annotation='Print "Hello".', image1='commandButton.png', command='print "Hello\\n"' )
# Result: ui.ShelfButton('window1|tabLayout5|shelfLayout2|shelfButton22') #

#    2.  A button that will create a sphere.
#
pm.shelfButton( annotation='Create a sphere.', image1='sphere.png', command='pm.sphere()' )
# Result: ui.ShelfButton('window1|tabLayout5|shelfLayout2|shelfButton23') #

#    3.  A button that will open the Attribute Editor window.
#
pm.shelfButton(annotation='Show the Attribute Editor.', image1='menuIconWindow.png', command='import maya.mel; maya.mel.eval("openAEWindow")' )
# Result: ui.ShelfButton('window1|tabLayout5|shelfLayout2|shelfButton24') #

#    4.  A button with a label that will create a cone
#
pm.shelfButton(annotation='Create a cone.', image1='cone.png', command='pm.cone()', imageOverlayLabel='4th')
# Result: ui.ShelfButton('window1|tabLayout5|shelfLayout2|shelfButton25') #

#    5.  A button with a label and color that will call undo
#
pm.shelfButton(annotation="Undo last operation.",
    image1="undo.png", command="undo", imageOverlayLabel="undo",
    overlayLabelColor=(1, .25, .25))

#    6.  A button with a label, color and background that will call redo
#
pm.shelfButton(annotation="Redo last operation.",
    image1="redo.png", command="redo", imageOverlayLabel="redo",
    overlayLabelColor=(1, 1, .25), overlayLabelBackColor=(.15, .9, .1, .4))

pm.tabLayout( tabs, edit=True, tabLabel=(shelf, 'Example Shelf') )

pm.showWindow( window )