summaryrefslogtreecommitdiffstats
path: root/doc/ttk_progressbar.n
diff options
context:
space:
mode:
authorfvogel <fvogelnew1@free.fr>2017-03-21 20:56:14 (GMT)
committerfvogel <fvogelnew1@free.fr>2017-03-21 20:56:14 (GMT)
commit38465faf27a2dd1b680aab3787b30139a6f24094 (patch)
treef657c7ea708b042d55d0bedc1731eac46f0134e0 /doc/ttk_progressbar.n
parent8356b50cc915367d0bf4cf242de5374d5055c28d (diff)
parent856e2b93a549f8c2a1195ba81c097d95ba381121 (diff)
downloadtk-38465faf27a2dd1b680aab3787b30139a6f24094.zip
tk-38465faf27a2dd1b680aab3787b30139a6f24094.tar.gz
tk-38465faf27a2dd1b680aab3787b30139a6f24094.tar.bz2
Merged tip-442 following positive vote by the TCT.
Diffstat (limited to 'doc/ttk_progressbar.n')
-rw-r--r--doc/ttk_progressbar.n38
1 files changed, 23 insertions, 15 deletions
diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n
index 1945f70..74d9698 100644
--- a/doc/ttk_progressbar.n
+++ b/doc/ttk_progressbar.n
@@ -19,22 +19,37 @@ 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.
+.PP
+If the value of \fB-orient\fR is \fBhorizontal\fR a text string can be
+displayed inside the progressbar. This string can be configured using
+the \fB-anchor\fR, \fB-font\fR, \fB-foreground\fR, \fB-justify\fR,
+\fB-text\fR and \fB-wraplength\fR options. If the value of \fB-orient\fR
+is \fBvertical\fR then these options are ignored.
.SO ttk_widget
-\-class \-cursor \-takefocus
-\-style
+\-anchor \-class \-cursor
+\-font \-foreground \-justify \-style
+\-takefocus \-text \-wraplength
.SE
.SH "WIDGET-SPECIFIC OPTIONS"
-.OP \-orient orient Orient
-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\fR or \fBindeterminate\fR.
+(width if horizontal, height if vertical). The value may have any of the forms
+acceptable to \fBTk_GetPixels\fR.
.OP \-maximum maximum Maximum
A floating point number specifying the maximum \fB\-value\fR.
Defaults to 100.
+.OP \-mode mode Mode
+One of \fBdeterminate\fR or \fBindeterminate\fR.
+.OP \-orient orient Orient
+One of \fBhorizontal\fR or \fBvertical\fR.
+Specifies the orientation of the progress bar.
+.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.
.OP \-value value Value
The current value of the progress bar.
In \fIdeterminate\fR mode, this represents the amount of work completed.
@@ -47,13 +62,6 @@ The name of a global 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.
.SH "WIDGET COMMAND"
.PP
.TP