pymel.core.uitypes.Button

digraph inheritance9a3741d07e {
rankdir=TB;
ranksep=0.15;
nodesep=0.15;
size="8.0, 12.0";
  "Button" [fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,URL="#pymel.core.uitypes.Button",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8];
  "PyUI" -> "Button" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "PyUI" [fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,URL="pymel.core.uitypes.PyUI.html#pymel.core.uitypes.PyUI",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8];
}

class Button

class counterpart of mel function button

Create a button control capable of displaying a textual label and executing a command when selected by the user.

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

Derived from mel command maya.cmds.button

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

Derived from mel command maya.cmds.button

getActOnPress(**kwargs)

If true then the command specified by the command flag will be executed when a mouse button is pressed. If false then that command will be executed after the mouse button is released. The default value is false.

Derived from mel command maya.cmds.button

getActionIsSubstitute(**kwargs)

This flag is obsolete and should no longer be used. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.button

getAlign(**kwargs)

This flag is obsolete and should no longer be used. The button label will always be center-aligned.

Derived from mel command maya.cmds.button

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.button

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

getCommand(**kwargs)

Command executed when the control is pressed.

Derived from mel command maya.cmds.button

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

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

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.button

getFullPathName(**kwargs)

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

Derived from mel command maya.cmds.button

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

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

getLabel(**kwargs)

The label text. The default label is the name of the control.

Derived from mel command maya.cmds.button

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

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.button

getPopupMenuArray(**kwargs)

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

Derived from mel command maya.cmds.button

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

getRecomputeSize(**kwargs)

If true then the control will recompute it’s size to just fit the size of the label. If false then the control size will remain fixed as you change the size of the label. The default value of this flag is true.

Derived from mel command maya.cmds.button

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

getVisibleChangeCommand(**kwargs)

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

Derived from mel command maya.cmds.button

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

setActOnPress(val=True, **kwargs)

If true then the command specified by the command flag will be executed when a mouse button is pressed. If false then that command will be executed after the mouse button is released. The default value is false.

Derived from mel command maya.cmds.button

setActionIsSubstitute(val=True, **kwargs)

This flag is obsolete and should no longer be used. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.button

setAlign(val=True, **kwargs)

This flag is obsolete and should no longer be used. The button label will always be center-aligned.

Derived from mel command maya.cmds.button

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.button

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

setCommand(val=True, **kwargs)

Command executed when the control is pressed.

Derived from mel command maya.cmds.button

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

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

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.button

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

setLabel(val=True, **kwargs)

The label text. The default label is the name of the control.

Derived from mel command maya.cmds.button

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

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

setRecomputeSize(val=True, **kwargs)

If true then the control will recompute it’s size to just fit the size of the label. If false then the control size will remain fixed as you change the size of the label. The default value of this flag is true.

Derived from mel command maya.cmds.button

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

setVisibleChangeCommand(val=True, **kwargs)

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

Derived from mel command maya.cmds.button

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

Previous topic

pymel.core.uitypes.BlendShapePanel

Next topic

pymel.core.uitypes.Canvas

Core

Core Modules

Other Modules

This Page