ttk.Progressbar

SYNOPSIS

instance = ttk.Progressbar(master [,**options])

DESCRIPTION

A ttk.Progressbar widget shows the status of a long-running operation. They can operate in two modes: determinate mode shows the amount completed relative to the total amount of work to be done, and indeterminate mode provides an animated display to let the user know that something is happening.

If the value of orient is "horizontal" a text string can be displayed inside the progressbar. This string can be configured using the anchor, font, foreground, justify, text and wraplength options. If the value of orient is "vertical" then these options are ignored.

STANDARD OPTIONS

anchor
class
cursor
font
foreground
justify
style
takefocus
text
wraplength

WIDGET-SPECIFIC OPTIONS

length
Specifies the length of the long axis of the progress bar (width if horizontal, height if vertical). The value may have any of the forms acceptable to Screen Units.

maximum
A floating point number specifying the maximum value. Defaults to 100.

mode
One of "determinate" or "indeterminate".

orient
One of "horizontal" or "vertical". Specifies the orientation of the progress bar.

variable
The instance of a Python Variable class which is linked to the value. If specified, the value of the progress bar is automatically set to the value of the Variable's instance whenever the latter is modified.

WIDGET COMMAND

instance.cget(option)
Returns the current value of the specified option given as string; see ttk.Widget().

instance.start([intarval])
Begin autoincrement mode: schedules a recurring timer event that calls step() every interval milliseconds. If omitted, interval defaults to 50 milliseconds (20 steps/second).

instance.step([amount])
Increments the value by amount. amount defaults to 1.0 if omitted.

instance.stop()
Stop autoincrement mode: cancels any recurring timer event initiated by instance.start().