summaryrefslogtreecommitdiffstats
path: root/doc/checkbutton.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2007-10-24 14:32:55 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2007-10-24 14:32:55 (GMT)
commita9b41e61dd1f2274961a88385d433a9bac66d44a (patch)
tree09cfb7c149cd2c0c95d126aa8764f569b3e42063 /doc/checkbutton.n
parent5d96c35c08ea64525de7b4ab99171bfcc0252142 (diff)
downloadtk-a9b41e61dd1f2274961a88385d433a9bac66d44a.zip
tk-a9b41e61dd1f2274961a88385d433a9bac66d44a.tar.gz
tk-a9b41e61dd1f2274961a88385d433a9bac66d44a.tar.bz2
Lots of improvements to look and feel of manual pages
Diffstat (limited to 'doc/checkbutton.n')
-rw-r--r--doc/checkbutton.n38
1 files changed, 26 insertions, 12 deletions
diff --git a/doc/checkbutton.n b/doc/checkbutton.n
index 1383513..d7c3f8f 100644
--- a/doc/checkbutton.n
+++ b/doc/checkbutton.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: checkbutton.n,v 1.13 2007/08/28 15:16:11 dkf Exp $
+'\" RCS: @(#) $Id: checkbutton.n,v 1.14 2007/10/24 14:32:57 dkf Exp $
'\"
.so man.macros
.TH checkbutton n 4.4 Tk "Tk Built-In Commands"
@@ -54,10 +54,12 @@ the Bold, Italic, and Underline checkbuttons on the toolbar of a
word-processor, for example.
.OP \-offvalue offValue Value
Specifies value to store in the button's associated variable whenever
-this button is deselected. Defaults to ``0''.
+this button is deselected. Defaults to
+.QW 0 .
.OP \-onvalue onValue Value
Specifies value to store in the button's associated variable whenever
-this button is selected. Defaults to ``1''.
+this button is selected. Defaults to
+.QW 1 .
.OP \-overrelief overRelief OverRelief
Specifies an alternative relief for the checkbutton, to be used when the
mouse cursor is over the widget. This option can be used to make
@@ -100,7 +102,7 @@ specified.
.OP \-tristatevalue tristateValue Value
.VS 8.5
Specifies the value that causes the checkbutton to display the multi-value
-selection, also known as the tri-state mode. Defaults to ``""''
+selection, also known as the tri-state mode. Defaults to the empty string.
.VE 8.5
.OP \-variable variable Variable
Specifies name of global variable to set to indicate whether
@@ -162,20 +164,30 @@ the indicator is drawn with a tri-state appearance and is in the tri-state
mode indicating mixed or multiple values. (This is used when the check
box represents the state of multiple items.)
The indicator is drawn in a platform dependent manner. Under Unix and
-Windows, the background interior of the box is ``grayed''. Under Mac,
-the indicator is drawn with a dash mark inside.
+Windows, the background interior of the box is
+.QW grayed .
+Under Mac, the indicator is drawn with a dash mark inside.
By default, the name of the variable associated with a checkbutton is the
same as the \fIname\fR used to create the checkbutton.
-The variable name, and the ``on'', ``off'' and ``tristate'' values stored in
-it, may be modified with options on the command line or in the option
-database.
+The variable name, and the
+.QW on ,
+.QW off
+and
+.QW tristate
+values stored in it, may be modified with options on the command line
+or in the option database.
Configuration options may also be used to modify the way the
indicator is displayed (or whether it is displayed at all).
By default a checkbutton is configured to select and deselect
itself on alternate button clicks.
In addition, each checkbutton monitors its associated variable and
automatically selects and deselects itself when the variables value
-changes to and from the button's ``on'', ``off'' and ``tristate'' values.
+changes to and from the button's
+.QW on ,
+.QW off
+and
+.QW tristate
+values.
.VE 8.5
.SH "WIDGET COMMAND"
.PP
@@ -211,7 +223,8 @@ this case the command returns an empty string.
command.
.TP
\fIpathName \fBdeselect\fR
-Deselects the checkbutton and sets the associated variable to its ``off''
+Deselects the checkbutton and sets the associated variable to its
+.QW off
value.
.TP
\fIpathName \fBflash\fR
@@ -230,7 +243,8 @@ empty string if there is no command associated with the checkbutton.
This command is ignored if the checkbutton's state is \fBdisabled\fR.
.TP
\fIpathName \fBselect\fR
-Selects the checkbutton and sets the associated variable to its ``on''
+Selects the checkbutton and sets the associated variable to its
+.QW on
value.
.TP
\fIpathName \fBtoggle\fR