summaryrefslogtreecommitdiffstats
path: root/doc/ttk_progressbar.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2006-12-13 23:04:32 (GMT)
committerhobbs <hobbs>2006-12-13 23:04:32 (GMT)
commit983fb168919502aae8279e5596bfaa149d17ff8f (patch)
tree128697b7c80828f4a3d31417bb432bc8eec88b00 /doc/ttk_progressbar.n
parent73eb12c82342f64f6867682e31d4f7b36283c4a1 (diff)
downloadtk-983fb168919502aae8279e5596bfaa149d17ff8f.zip
tk-983fb168919502aae8279e5596bfaa149d17ff8f.tar.gz
tk-983fb168919502aae8279e5596bfaa149d17ff8f.tar.bz2
* unix/Makefile.in (install-doc): intentionally skip ttk_dialog.n
installation (not for public consumption) * doc/scrollbar.n, doc/button.n, doc/checkbutton.n: * doc/entry.n, doc/frame.n, doc/label.n, doc/labelframe.n: * doc/menu.n, doc/menubutton.n, doc/panedwindow.n: * doc/radiobutton.n, doc/scrollbar.n, doc/ttk_*: revamp ttk docs to use consist nroff format (not 100% consistent with classic widget docs). Add more man page cross-linking "SEE ALSO".
Diffstat (limited to 'doc/ttk_progressbar.n')
-rw-r--r--doc/ttk_progressbar.n36
1 files changed, 23 insertions, 13 deletions
diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n
index 2f5eedb..f94c12e 100644
--- a/doc/ttk_progressbar.n
+++ b/doc/ttk_progressbar.n
@@ -1,16 +1,31 @@
'\"
'\" Copyright (c) 2005 Joe English
'\"
+'\" 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 $
+'\"
.so man.macros
.TH ttk_progressbar n 8.5 Tk "Tk Themed Widget"
.BS
+.\" Use _ instead of :: as the name becomes a filename on install
.SH NAME
-ttk::progressbar \- Provide progress feedback
+ttk_progressbar \- Provide progress feedback
.SH SYNOPSIS
\fBttk::progressbar\fR \fIpathName \fR?\fIoptions\fR?
+.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
+\fIindeterminate\fR mode provides an animated display to let the user know
+that something is happening.
.SO
\-class \-cursor \-takefocus \-style
.SE
+
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-orient orient Orient
One of \fBhorizontal\fR or \fBvertical\fR.
@@ -41,23 +56,17 @@ 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\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\fR; see \fIwidget(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 \fIwidget(n)\fR.
+Modify or query widget options; see \fIttk_widget(n)\fR.
.TP
\fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR?
-Test the widget state; see \fIwidget(n)\fR.
+Test the widget state; see \fIttk_widget(n)\fR.
.TP
\fIpathName \fBstart\fR ?\fIinterval\fR?
Begin autoincrement mode:
@@ -66,7 +75,7 @@ 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)\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.
@@ -75,5 +84,6 @@ Increments the \fB-value\fR by \fIamount\fR.
\fIpathName \fBstop\fR
Stop autoincrement mode:
cancels any recurring timer event initiated by \fIpathName \fBstart\fR.
+
.SH "SEE ALSO"
-widget(n)
+ttk_widget(n)