pymel.core.windows.layerButton

layerButton(*args, **kwargs)

Creates a layer bar button widget. This widget contains both the name of the layer to which it refers and a color swatch indicating it’s color assignment. It is used primarily in the construction of the layerBar and layer Editor window, being the widget used for each layer in the respective lists.

Flags:

Long name (short name)		Argument Types	Properties
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.
changeCommand (cc)		callable
color (cl)		float, float, float
	Layer color, specified with normalized real numbers in R, G, B space.
command (c)		callable
	Set the command to call on a single click.
current (cr)		bool
	Set this button to display as the current layer. The current layer is the one which the user has the option of adding all newly created objects into. NB: Setting the layer button to this state has no effect on the actual current layer.
defineTemplate (dt)		unicode
	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
	Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
doubleClickCommand (dcc)		callable
	Set the command to call on a double click.
dragCallback (dgc)		callable
	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)		callable
	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.
exists (ex)		bool
	Returns true|false depending upon whether the specified object exists. Other flags are ignored.
fullPathName (fpn)		bool
	Return the full path name of the widget, which includes all the parents
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.
identification (id)		int
	This is the integer identification number associated with the layer.
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
	Label text for the button.
labelWidth (lw)		bool
	Query the width of the label part so as to determine if button clicks are in the label part or the colour swatch part.
layerState (ls)		unicode
	Describes the state of the layer. This may be one of normal, template, or reference.
layerVisible (lv)		bool
	Indicates whether the layer is visible or invisible.
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.
name (n)		unicode
	Name of the layer.
numberOfPopupMenus (npm)		bool
	Return the number of popup menus attached to this control.
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 disallows overriding the control’s attribute via the control’s right mouse button menu.
renameCommand (rc)		unicode
	Set the command to call when the layer gets renamed. The string ‘#1’ will be substituted with the control’s name and ‘#2’ will be replaced with the layer’s new name.
select (s)		bool
	Set this button to display as a selected layer.
transparent (t)		bool
	Indicate whether the layer color is visible or transparent.
typeCommand (tc)		callable
	Command that is called when the type indicator of the layer button is pressed. Flag can have multiple arguments, passed either as a tuple or a list.
useTemplate (ut)		unicode
	Force the command to use a command template other than the current one.
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)		callable
	Command that gets executed when visible state of the control changes.
visibleCommand (vc)		callable
	Command that is called when the visibility indicator of the layer button is pressed.
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.

Derived from mel command maya.cmds.layerButton

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout55') #
# Create a button for the default layer, colour it red and select it
b = pm.layerButton(name='defaultLayer', cl=(1.0, 0.0, 0.0), s=True)
pm.showWindow()

# Find out how wide the layer buttons are when created
width = pm.layerButton(b ,q=True, labelWidth=True )