ProgressBar

class vanilla.ProgressBar(posSize, minValue=0, maxValue=100, isIndeterminate=False, sizeStyle='regular', progressStyle='bar')

A standard progress bar.

../_images/ProgressBar.png 
from vanilla import Window, ProgressBar, Button

class ProgressBarDemo:

    def __init__(self):
        self.w = Window((200, 65))
        self.w.bar = ProgressBar((10, 10, -10, 16))
        self.w.button = Button((10, 35, -10, 20), "Go!",
                            callback=self.showProgress)
        self.w.open()

    def showProgress(self, sender):
        import time
        self.w.bar.set(0)
        for i in range(10):
            self.w.bar.increment(10)
            time.sleep(.2)

ProgressBarDemo()

posSize Tuple of form (left, top, width, height) or “auto” representing the position and size of the progress bar. The height of the progress bar should match the appropriate value for the given sizeStyle.

Standard Dimensions
Regular H 16
Small H 10

minValue The minimum value of the progress bar.

maxValue The maximum value of the progress bar.

isIndeterminate Boolean representing if the progress bar is indeterminate. Determinate progress bars show how much of the task has been completed. Indeterminate progress bars simply show that the application is busy.

sizeStyle A string representing the desired size style of the pregress bar. The options are:

“regular”
“small”
addAutoPosSizeRules(rules, metrics=None)

Add auto layout rules for controls/view in this view.

rules must be a list of rule definitions. Rule definitions may take two forms:

key value
“view1” The vanilla wrapped view for the left side of the rule.
“attribute1” The attribute of the view for the left side of the rule. See below for options.
“relation” (optional) The relationship between the left side of the rule and the right side of the rule. See below for options. The default value is “==”.
“view2” The vanilla wrapped view for the right side of the rule.
“attribute2” The attribute of the view for the right side of the rule. See below for options.
“multiplier” (optional) The constant multiplied with the attribute on the right side of the rule as part of getting the modified attribute. The default value is 1.
“constant” (optional) The constant added to the multiplied attribute value on the right side of the rule to yield the final modified attribute. The default value is 0.

The attribute1 and attribute2 options are:

value AppKit equivalent
“left” NSLayoutAttributeLeft
“right” NSLayoutAttributeRight
“top” NSLayoutAttributeTop
“bottom” NSLayoutAttributeBottom
“leading” NSLayoutAttributeLeading
“trailing” NSLayoutAttributeTrailing
“width” NSLayoutAttributeWidth
“height” NSLayoutAttributeHeight
“centerX” NSLayoutAttributeCenterX
“centerY” NSLayoutAttributeCenterY
“baseline” NSLayoutAttributeBaseline
“lastBaseline” NSLayoutAttributeLastBaseline
“firstBaseline” NSLayoutAttributeFirstBaseline

Refer to the NSLayoutAttribute documentation for the information about what each of these do.

The relation options are:

value AppKit equivalent
“<=” NSLayoutRelationLessThanOrEqual
“==” NSLayoutRelationEqual
“>=” NSLayoutRelationGreaterThanOrEqual

Refer to the NSLayoutRelation documentation for the information about what each of these do.

metrics may be either None or a dict containing key value pairs representing metrics keywords used in the rules defined with strings.

enable(onOff)

Enable or disable the object. onOff should be a boolean.

get()

Get the current value of the progress bar.

Only available in determinate progress bars.

getNSProgressIndicator()

Return the NSProgressIndicator that this object wraps.

getPosSize()

The position and size of the object as a tuple of form (left, top, width, height).

increment(value=1)

Increment the progress bar by value.

Only available in determinate progress bars.

isVisible()

Return a bool indicating if the object is visible or not.

move(x, y)

Move the object by x units and y units.

resize(width, height)

Change the size of the object to width and height.

set(value)

Set the value of the progress bar to value.

Only available in determinate progress bars.

setPosSize(posSize, animate=False)

Set the position and size of the object.

posSize A tuple of form (left, top, width, height).

animate A boolean flag telling to animate the transition. Off by default.

show(onOff)

Show or hide the object.

onOff A boolean value representing if the object should be shown or not.

start()

Start the animation.

Only available in indeterminate progress bars.

stop()

Stop the animation.

Only available in indeterminate progress bars.