diff options
Diffstat (limited to 'doc/ttk_progressbar.n')
| -rw-r--r-- | doc/ttk_progressbar.n | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n index 15ac048..2f5eedb 100644 --- a/doc/ttk_progressbar.n +++ b/doc/ttk_progressbar.n @@ -13,60 +13,60 @@ ttk::progressbar \- Provide progress feedback .SE .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient -One of \fBhorizontal\fP or \fBvertical\fP. +One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the progress bar. .OP \-length length Length Specifies the length of the long axis of the progress bar (width if horizontal, height if vertical). .OP \-mode mode Mode -One of \fBdeterminate\fP or \fBindeterminate\fP. +One of \fBdeterminate\fR or \fBindeterminate\fR. .OP \-maximum maximum Maximum A floating point number specifying the maximum \fB-value\fR. Defaults to 100. .OP \-value value Value The current value of the progress bar. In \fIdeterminate\fR mode, this represents the amount of work completed. -In \fIindeterminate\fR mode, it is interpreted modulo \fB-maximum\fP; +In \fIindeterminate\fR mode, it is interpreted modulo \fB-maximum\fR; that is, the progress bar completes one "cycle" when -the \fB-value\fP increases by \fB-maximum\fP. +the \fB-value\fR increases by \fB-maximum\fR. .OP \-variable variable Variable -The name of a Tcl variable which is linked to the \fB-value\fP. -If specified, the \fB-value\fP of the progress bar is +The name of a Tcl variable which is linked to the \fB-value\fR. +If specified, the \fB-value\fR of the progress bar is automatically set to the value of the variable whenever the latter is modified. .OP \-phase phase Phase Read-only option. The widget periodically increments the value of this option -whenever the \fB-value\fP is greater than 0 and, +whenever the \fB-value\fR is greater than 0 and, in \fIdeterminate\fR mode, less than \fB-maximum\fR. This option may be used by the current theme to provide additional animation effects. .BE .SH "DESCRIPTION" A progress bar widget shows the status of a long-running operation. -They can operate in two modes: \fIdeterminate\fP mode shows the +They can operate in two modes: \fIdeterminate\fR mode shows the amount completed relative to the total amount of work to be done, and \fIindeterminate\fR mode provides an animated display to let the user know that something is happening. .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fP; see \fIwidget(n)\fP. +Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -Modify or query widget options; see \fIwidget(n)\fP. +Modify or query widget options; see \fIwidget(n)\fR. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? -Test the widget state; see \fIwidget(n)\fP. +Test the widget state; see \fIwidget(n)\fR. .TP \fIpathName \fBstart\fR ?\fIinterval\fR? Begin autoincrement mode: -schedules a recurring timer event that calls \fBstep\fP -every \fIinterval\fP milliseconds. -If omitted, \fIinterval\fP defaults to 50 milliseconds (20 steps/second). +schedules a recurring timer event that calls \fBstep\fR +every \fIinterval\fR milliseconds. +If omitted, \fIinterval\fR defaults to 50 milliseconds (20 steps/second). .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -Modify or query the widget state; see \fIwidget(n)\fP. +Modify or query the widget state; see \fIwidget(n)\fR. .TP \fIpathName \fBstep\fR ?\fIamount\fR? Increments the \fB-value\fR by \fIamount\fR. |