diff options
Diffstat (limited to 'doc/ttk_progressbar.n')
| -rw-r--r-- | doc/ttk_progressbar.n | 74 |
1 files changed, 38 insertions, 36 deletions
diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n index f94c12e..ae353c4 100644 --- a/doc/ttk_progressbar.n +++ b/doc/ttk_progressbar.n @@ -3,9 +3,9 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ -'\" +'\" +'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.4 2007/10/22 14:33:13 dkf Exp $ +'\" .so man.macros .TH ttk_progressbar n 8.5 Tk "Tk Themed Widget" .BS @@ -17,9 +17,9 @@ ttk_progressbar \- Provide progress feedback .BE .SH DESCRIPTION -A \fBttk::progressbar\fR widget shows the status of a long-running -operation. They can operate in two modes: \fIdeterminate\fR mode shows the -amount completed relative to the total amount of work to be done, and +A \fBttk::progressbar\fR widget shows the status of a long-running operation. +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. .SO @@ -28,62 +28,64 @@ that something is happening. .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient -One of \fBhorizontal\fR or \fBvertical\fR. -Specifies the orientation of the progress bar. +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). +Specifies the length of the long axis of the progress bar (width if +horizontal, height if vertical). .OP \-mode mode Mode One of \fBdeterminate\fR or \fBindeterminate\fR. .OP \-maximum maximum Maximum -A floating point number specifying the maximum \fB-value\fR. -Defaults to 100. +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\fR; -that is, the progress bar completes one "cycle" when -the \fB-value\fR increases by \fB-maximum\fR. +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\fR; that is, the progress bar completes one +"cycle" when 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\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. +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\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. +Read-only option. The widget periodically increments the value of this option +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. .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR. +. +Returns the current value of the specified \fIoption\fR; see +\fIttk_widget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +. Modify or query widget options; see \fIttk_widget(n)\fR. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? +. Test the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBstart\fR ?\fIinterval\fR? -Begin autoincrement mode: -schedules a recurring timer event that calls \fBstep\fR -every \fIinterval\fR milliseconds. -If omitted, \fIinterval\fR defaults to 50 milliseconds (20 steps/second). +. +Begin autoincrement mode: 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 \fIttk_widget(n)\fR. .TP \fIpathName \fBstep\fR ?\fIamount\fR? -Increments the \fB-value\fR by \fIamount\fR. -\fIamount\fR defaults to 1.0 if omitted. +. +Increments the \fB\-value\fR by \fIamount\fR. \fIamount\fR defaults to 1.0 if +omitted. .TP \fIpathName \fBstop\fR -Stop autoincrement mode: -cancels any recurring timer event initiated by \fIpathName \fBstart\fR. +. +Stop autoincrement mode: cancels any recurring timer event initiated by +\fIpathName \fBstart\fR. .SH "SEE ALSO" ttk_widget(n) |