pymel.core.windows.progressBar

progressBar(*args, **kwargs)

Creates a progress bar control that graphically fills in as its progress value increases.

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.
beginProgress (bp)		bool
	Only valid for the main progress barShows the main progress bar (normally in the Help Line). This is normally issued through MEL when a length computation is about to occur.
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
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 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’”)
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 “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’”)
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.
endProgress (ep)		bool
	Only valid for the main progress barHides the progress bar. No other flags can be used at the same time. This is normally issued through MEL in response to the -ic/isCancelled flag being set or if the progress value reaches its maximum.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
exists (ex)		bool
	Returns true|false depending upon whether the specified object exists. Other flags are ignored.
fullPathName (fpn)		unicode
	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.
isCancelled (ic)		bool
	Returns true if the user has tried to cancel the operation. Returns false otherwise.
isInterruptable (ii)		bool
	Only valid for the main progress barReturns true if the isCancelled flag should respond to attempts to cancel the operation. Setting this to true will add a note in the help line display message to the user indicating that they can cancel the operation.
isMainProgressBar (imp)		bool
	Determines whether this progressBar is used to show the progress of all basic operations such as Open/Save file.The main progressBar behaves very differently, in that it only shows itself when there is an ongoing basic operation.Defaults to false, and only one progress bar will be recognized as the “main” one.
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.
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.
maxValue (max)		int
	The maximum or “ending” value of the progress indicator. If the progress value is greater than the -max/maxValue, the progress value will be set to the maximum. Default value is 100.
minValue (min)		int
	The minimum or “starting” value of the progress indicator. If the progress value is less than the -min/minValue, the progress value will be set to the minimum. Default value is 0.
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.
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.
progress (pr)		int
	The amount of progress currently shown on the control. The value will always be between min and max. Default is equal to the minimum when the control is created.
status (st)		unicode
	Only valid for the main progress barSets the contents of the helpLine control when the progressBar is showing. Use this instead of setting the helpLine directly because this will force a graphical refresh before returning.
step (s)		int
	Increments the -pr/progress value by the amount specified.
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)		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.

Derived from mel command maya.cmds.progressBar

Example:

import pymel.core as pm

# Create a custom progressBar in a windows ...

window = pm.window()
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout70') #

progressControl = pm.progressBar(maxValue=10, width=300)
pm.button( label='Make Progress!', command='pm.progressBar(progressControl, edit=True, step=1)' )
# Result: ui.Button('window1|columnLayout70|button67') #

pm.showWindow( window )

# Or, to use the progress bar in the main window ...

import maya.mel
gMainProgressBar = maya.mel.eval('$tmp = $gMainProgressBar')

pm.progressBar( gMainProgressBar,
                                edit=True,
                                beginProgress=True,
                                isInterruptable=True,
                                status='Example Calculation ...',
                                maxValue=5000 )

for i in range(5000) :
        if pm.progressBar(gMainProgressBar, query=True, isCancelled=True ) :
                break

        pm.progressBar(gMainProgressBar, edit=True, step=1)

pm.progressBar(gMainProgressBar, edit=True, endProgress=True)