ProgressBar

NAME: ProgressBar - a progress indicator widget
SYNOPSIS: ProgressBar pathName ?option value...?
DESCRIPTION
STANDARD OPTIONS: -background or -bg; -borderwidth or -bd; -foreground or -fg; -orient; -relief; -troughcolor
WIDGET-SPECIFIC OPTIONS: -height; -maximum; -type; -variable; -width
WIDGET COMMAND: pathName cget option; pathName configure ?option? ?value option value ...?

NAME

ProgressBar - a progress indicator widget

SYNOPSIS

ProgressBar pathName ?option value...?

DESCRIPTION

The ProgressBar widget displays the progress of a lengthy operation. It is used by MainFrame, StatusBar, and ProgressDlg.

WIDGET-SPECIFIC OPTIONS

-height: Specifies the desired height for the progress indicator.
-maximum: Specifies the maximum value of the variable. This value must be greater than zero.
-type: Specifies the type of the ProgressBar. Must be one of normal, incremental, infinite or nonincremental_infinite.

If -type is normal, the progress indicator is drawn proportional to the variable value and -maximum option each time the variable is set.

If -type is incremental, the value of the progress indicator is maintained internally, and incremented each time the variable is set by its value. The progress indicator is drawn proportional to the internal value and the -maximum option.

If -type is infinite, the value of the progress indicator is maintained internally, and incremented each time the variable is set by its value. The progress indicator moves from left to right if the internal value (modulo -maximum) is less than -maximum/2, and from right to left if the internal value is greater than -maximum/2.

If -type is nonincremental_infinite, the value of the progress indicator taken from the variable value, The progress indicator moves from left to right if variable value (modulo -maximum) is less than -maximum/2, and from right to left if internal value is greater than -maximum/2.

See the -variable option for special cases (zero and negative) of its value.

Default value for -type is normal.
-variable: Specifies the name of the variable attached to the progress indicator. The progress indicator is updated when the value of the variable changes. If the value of the variable is negative, the progress indicator is not displayed (it is drawn flat with -background color - useful for ProgressDlg to make it invisible). If its value 0, the progress indicator is reinitialized.
-width: Specifies the desired width for the progress indicator.

WIDGET COMMAND

pathName cget option: Returns the current value of the configuration option given by option. Argument option may have any of the values accepted by the creation command ProgressBar.
pathName configure ?option? ?value option value ...?: Query or modify the configuration options of the widget. If no option is specified, returns a list describing all of the available options for pathName. If option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). If one or more option-value pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. Argument option may have any of the values accepted by the creation command ProgressBar. Read-only options cannot be modified.