1ttk::progressbar(n)            Tk Themed Widget            ttk::progressbar(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       ttk::progressbar - Provide progress feedback
9

SYNOPSIS

11       ttk::progressbar pathName ?options?
12______________________________________________________________________________
13

DESCRIPTION

15       A ttk::progressbar widget shows the status of a long-running operation.
16       They can operate in two modes: determinate mode shows the  amount  com‐
17       pleted  relative to the total amount of work to be done, and indetermi‐
18       nate mode provides an animated display to let the user know that  some‐
19       thing is happening.
20

STANDARD OPTIONS

22       -class                -cursor              -takefocus
23       -style
24
25       See the ttk_widget manual entry for details on the standard options.
26

WIDGET-SPECIFIC OPTIONS

28       Command-Line Name:-length
29       Database Name:  length
30       Database Class: Length
31
32              Specifies the length of the long axis of the progress bar (width
33              if horizontal, height if vertical).
34
35       Command-Line Name:-maximum
36       Database Name:  maximum
37       Database Class: Maximum
38
39              A floating point number specifying the maximum -value.  Defaults
40              to 100.
41
42       Command-Line Name:-mode
43       Database Name:  mode
44       Database Class: Mode
45
46              One of determinate or indeterminate.
47
48       Command-Line Name:-orient
49       Database Name:  orient
50       Database Class: Orient
51
52              One of horizontal or vertical.  Specifies the orientation of the
53              progress bar.
54
55       Command-Line Name:-phase
56       Database Name:  phase
57       Database Class: Phase
58
59              Read-only option.  The widget periodically increments the  value
60              of  this  option  whenever  the -value is greater than 0 and, in
61              determinate mode, less than -maximum.  This option may  be  used
62              by the current theme to provide additional animation effects.
63
64       Command-Line Name:-value
65       Database Name:  value
66       Database Class: Value
67
68              The  current  value  of  the progress bar.  In determinate mode,
69              this represents the amount of work completed.  In  indeterminate
70              mode,  it  is interpreted modulo -maximum; that is, the progress
71              bar completes one “cycle” when the -value increases by -maximum.
72              If  -variable  is set to an existing variable, specifying -value
73              has no effect (the variable value takes precedence).
74
75       Command-Line Name:-variable
76       Database Name:  variable
77       Database Class: Variable
78
79              The name of a global Tcl variable which is linked to the -value.
80              If specified to an existing variable, the -value of the progress
81              bar is automatically set to the value of the  variable  whenever
82              the latter is modified.
83

WIDGET COMMAND

85       pathName cget option
86              Returns the current value of the specified option; see ttk::wid‐
87              get(n).
88
89       pathName configure ?option? ?value option value ...?
90              Modify or query widget options; see ttk::widget(n).
91
92       pathName identify x y
93              Returns the name of the element at position x, y.  See ttk::wid‐
94              get(n).
95
96       pathName instate statespec ?script?
97              Test the widget state; see ttk::widget(n).
98
99       pathName start ?interval?
100              Begin autoincrement mode: schedules a recurring timer event that
101              calls step every interval milliseconds.   If  omitted,  interval
102              defaults to 50 milliseconds (20 steps/second).
103
104       pathName state ?stateSpec?
105              Modify or query the widget state; see ttk::widget(n).
106
107       pathName step ?amount?
108              Increments  the  -value  by  amount.   amount defaults to 1.0 if
109              omitted.
110
111       pathName stop
112              Stop autoincrement mode: cancels any recurring timer event  ini‐
113              tiated by pathName start.
114

STYLING OPTIONS

116       The class name for a ttk::progressbar is TProgressbar.
117
118       TProgressbar styling options configurable with ttk::style are:
119
120       -background color
121       -bordercolor color
122       -darkcolor color
123       -lightcolor color
124       -maxphase
125              For the aqua theme.
126       -period
127              For the aqua theme.
128       -troughcolor color
129
130       Some options are only available for specific themes.
131
132       See  the ttk::style manual page for information on how to configure ttk
133       styles.
134

SEE ALSO

136       ttk::widget(n)
137
138
139
140Tk                                    8.5                  ttk::progressbar(n)
Impressum