summaryrefslogtreecommitdiffstats
path: root/doc/radiobutton.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-10-28 10:22:50 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-10-28 10:22:50 (GMT)
commitbffdac3cbb0bfe12357f55cdc4fb24195743fbcf (patch)
tree4a0680cb493f74dee4162dbbed922841cdf25694 /doc/radiobutton.n
parentf068b3c8aa0a0bfed87b981e99a3b096aed995d5 (diff)
downloadtk-bffdac3cbb0bfe12357f55cdc4fb24195743fbcf.zip
tk-bffdac3cbb0bfe12357f55cdc4fb24195743fbcf.tar.gz
tk-bffdac3cbb0bfe12357f55cdc4fb24195743fbcf.tar.bz2
Assorted minor documentation fixes
Diffstat (limited to 'doc/radiobutton.n')
-rw-r--r--doc/radiobutton.n24
1 files changed, 15 insertions, 9 deletions
diff --git a/doc/radiobutton.n b/doc/radiobutton.n
index 73bb98e..902d205 100644
--- a/doc/radiobutton.n
+++ b/doc/radiobutton.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: radiobutton.n,v 1.8 2004/08/16 14:01:09 dkf Exp $
+'\" RCS: @(#) $Id: radiobutton.n,v 1.9 2004/10/28 10:22:51 dkf Exp $
'\"
.so man.macros
.TH radiobutton n 4.4 Tk "Tk Built-In Commands"
@@ -53,8 +53,8 @@ for the entire widget, in place of \fBbackground\fR or \fBactiveBackground\fR,
whenever the widget is selected.
If specified as an empty string then no special color is used for
displaying when the widget is selected.
-.VS 8.4
.OP \-offrelief offRelief OffRelief
+.VS 8.4
Specifies the relief for the checkbutton when the indicator is not drawn and
the checkbutton is off. The default value is "raised". By setting this option
to "flat" and setting -indicatoron to false and -overrelief to raised,
@@ -63,10 +63,9 @@ of having a flat button that raises on mouse-over and which is
depressed when activated. This is the behavior typically exhibited by
the Align-Left, Align-Right, and Center radiobuttons on the toolbar of a
word-processor, for example.
-
.VE 8.4
-.VS 8.4
.OP \-overrelief overRelief OverRelief
+.VS 8.4
Specifies an alternative relief for the radiobutton, to be used when the
mouse cursor is over the widget. This option can be used to make
toolbar buttons, by configuring \fB\-relief flat \-overrelief
@@ -91,13 +90,17 @@ the widget and will ignore mouse button presses.
In this state the \fBdisabledForeground\fR and
\fBbackground\fR options determine how the radiobutton is displayed.
.OP \-tristateimage tristateImage TristateImage
+.VS 8.5
Specifies an image to display (in place of the \fBimage\fR option)
when the radiobutton is selected.
This option is ignored unless the \fBimage\fR option has been
specified.
+.VE 8.5
.OP \-tristatevalue tristateValue Value
+.VS 8.5
Specifies the value that causes the radiobutton to display the multi-value
selection, also known as the tri-state mode. Defaults to ``""''
+.VE 8.5
.OP \-value value Value
Specifies value to store in the button's associated variable whenever
this button is selected.
@@ -163,10 +166,12 @@ When a radiobutton is selected it sets the value of the variable to
indicate that fact; each radiobutton also monitors the value of
the variable and automatically selects and deselects itself when the
variable's value changes.
-If the variable's value matches the tristatevalue, then the radiobutton is
+.VS 8.5
+If the variable's value matches the \fBtristateValue\fR, then the radiobutton is
drawn using the tri-state mode. This mode is used to indicate mixed or
-multiple values. (This is used when the radio button represents the state
+multiple values. (This is used when the radiobutton represents the state
of multiple items.)
+.VE 8.5
By default the variable \fBselectedButton\fR
is used; its contents give the name of the button that is
selected, or the empty string if no button associated with that
@@ -177,7 +182,6 @@ 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 radiobutton is configured to select itself on button clicks.
-
.SH "WIDGET COMMAND"
.PP
The \fBradiobutton\fR command creates a new Tcl command whose
@@ -235,13 +239,12 @@ This command is ignored if the radiobutton's state is \fBdisabled\fR.
\fIpathName \fBselect\fR
Selects the radiobutton and sets the associated variable to the
value corresponding to this widget.
-
.SH BINDINGS
.PP
Tk automatically creates class bindings for radiobuttons that give them
the following default behavior:
-.VS
.IP [1]
+.VS
On Unix systems, a radiobutton activates whenever the mouse passes
over it and deactivates whenever the mouse leaves the radiobutton. On
Mac and Windows systems, when mouse button 1 is pressed over a
@@ -263,5 +266,8 @@ actions occur: the radiobutton is completely non-responsive.
The behavior of radiobuttons can be changed by defining new bindings for
individual widgets or by redefining the class bindings.
+.SH "SEE ALSO"
+checkbutton(n), labelframe(n), listbox(n), options(n), scale(n)
+
.SH KEYWORDS
radiobutton, widget