summaryrefslogtreecommitdiffstats
path: root/doc/ttk_checkbutton.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2007-10-29 16:04:11 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2007-10-29 16:04:11 (GMT)
commit447c5cc18c467353963659dc23a69436b253293c (patch)
treef1b13d0b63bdcb785dc2718534eb209b9796d50b /doc/ttk_checkbutton.n
parent5f3a1bfa8de8e91197ca501ca72204d29cd4ba4d (diff)
downloadtk-447c5cc18c467353963659dc23a69436b253293c.zip
tk-447c5cc18c467353963659dc23a69436b253293c.tar.gz
tk-447c5cc18c467353963659dc23a69436b253293c.tar.bz2
Lots more GOOBE stuff. Now works with 'make html'!
Diffstat (limited to 'doc/ttk_checkbutton.n')
-rw-r--r--doc/ttk_checkbutton.n33
1 files changed, 15 insertions, 18 deletions
diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n
index eb5fd6c..eee7d1e 100644
--- a/doc/ttk_checkbutton.n
+++ b/doc/ttk_checkbutton.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.7 2007/10/26 20:13:23 dgp Exp $
+'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.8 2007/10/29 16:04:14 dkf Exp $
'\"
.so man.macros
.TH ttk_checkbutton n 8.5 Tk "Tk Themed Widget"
@@ -15,7 +15,6 @@ ttk_checkbutton \- On/off widget
.SH SYNOPSIS
\fBttk::checkbutton\fR \fIpathName \fR?\fIoptions\fR?
.BE
-
.SH DESCRIPTION
A \fBttk::checkbutton\fR widget is used to show or change a setting.
It has two states, selected and deselected.
@@ -25,20 +24,18 @@ The state of the checkbutton may be linked to a Tcl variable.
\-state \-style \-takefocus \-text
\-textvariable \-underline \-width
.SE
-
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-command command Command
A Tcl script to execute whenever the widget is invoked.
.OP \-offvalue offValue OffValue
-The value to store in the associated \fI-variable\fR
+The value to store in the associated \fB\-variable\fR
when the widget is deselected. Defaults to \fB0\fR.
.OP \-onvalue onValue OnValue
-The value to store in the associated \fI-variable\fR
+The value to store in the associated \fB\-variable\fR
when the widget is selected. Defaults to \fB1\fR.
.OP \-variable variable Variable
The name of a global variable whose value is linked to the widget.
Defaults to the widget pathname if not specified.
-
.SH "WIDGET COMMAND"
In addition to the standard
\fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR
@@ -47,27 +44,27 @@ widget commands:
.TP
\fIpathname\fR invoke
Toggles between the selected and deselected states
-and evaluates the associated \fI-command\fR.
-If the widget is currently selected, sets the \fI-variable\fR
-to the \fI-offvalue\fR and deselects the widget;
-otherwise, sets the \fI-variable\fR to the \fI-onvalue\fR
-Returns the result of the \fI-command\fR.
+and evaluates the associated \fB\-command\fR.
+If the widget is currently selected, sets the \fB\-variable\fR
+to the \fB\-offvalue\fR and deselects the widget;
+otherwise, sets the \fB\-variable\fR to the \fB\-onvalue\fR
+Returns the result of the \fB\-command\fR.
.\" Missing: select, deselect, toggle
.\" Are these useful? They don't invoke the -command
.\" Missing: flash. This is definitely not useful.
-
.SH "WIDGET STATES"
The widget does not respond to user input if the \fBdisabled\fR state is set.
The widget sets the \fBselected\fR state whenever
-the linked \fB-variable\fR is set to the widget's \fB-onvalue\fR,
+the linked \fB\-variable\fR is set to the widget's \fB\-onvalue\fR,
and clears it otherwise.
The widget sets the \fBalternate\fR state whenever the
-linked \fB-variable\fR is unset.
-(The \fBalternate\fR state may be used to indicate a ``tri-state''
-or ``indeterminate'' selection.)
-
+linked \fB\-variable\fR is unset.
+(The \fBalternate\fR state may be used to indicate a
+.QW tri-state
+or
+.QW indeterminate
+selection.)
.SH "SEE ALSO"
ttk_widget(n), ttk_radiobutton(n), checkbutton(n)
-
.SH "KEYWORDS"
widget, button, toggle, check, option