summaryrefslogtreecommitdiffstats
path: root/doc/checkbutton.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2024-01-21 00:00:49 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2024-01-21 00:00:49 (GMT)
commit81ac88e72f468bd35eb1eb30d6947b6feb0af48d (patch)
tree6459c6811aa54d681c9a14888949e59a5a1e735d /doc/checkbutton.n
parent668c3b43a9c64988d3d62ba2b75798dae2d0ed46 (diff)
downloadtk-81ac88e72f468bd35eb1eb30d6947b6feb0af48d.zip
tk-81ac88e72f468bd35eb1eb30d6947b6feb0af48d.tar.gz
tk-81ac88e72f468bd35eb1eb30d6947b6feb0af48d.tar.bz2
Many small tweaks to docs
The main one is I've added a comment in to make primary subcommands ("methods") more obvious when editing.
Diffstat (limited to 'doc/checkbutton.n')
-rw-r--r--doc/checkbutton.n16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/checkbutton.n b/doc/checkbutton.n
index 411045f..0f27d49 100644
--- a/doc/checkbutton.n
+++ b/doc/checkbutton.n
@@ -197,14 +197,18 @@ operations on the widget. It has the following general form:
\fIOption\fR and the \fIarg\fRs
determine the exact behavior of the command. The following
commands are possible for checkbutton widgets:
+.\" METHOD: cget
.TP
-\fIpathName \fBcget\fR \fIoption\fR
+\fIpathName \fBcget\fI option\fR
+.
Returns the current value of the configuration option given
by \fIoption\fR.
\fIOption\fR may have any of the values accepted by the \fBcheckbutton\fR
command.
+.\" METHOD: configure
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
+.
Query or modify the configuration options of the widget.
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
@@ -217,33 +221,43 @@ modifies the given widget option(s) to have the given value(s); in
this case the command returns an empty string.
\fIOption\fR may have any of the values accepted by the \fBcheckbutton\fR
command.
+.\" METHOD: deselect
.TP
\fIpathName \fBdeselect\fR
+.
Deselects the checkbutton and sets the associated variable to its
.QW off
value.
+.\" METHOD: flash
.TP
\fIpathName \fBflash\fR
+.
Flashes the checkbutton. This is accomplished by redisplaying the checkbutton
several times, alternating between active and normal colors. At
the end of the flash the checkbutton is left in the same normal/active
state as when the command was invoked.
This command is ignored if the checkbutton's state is \fBdisabled\fR.
+.\" METHOD: invoke
.TP
\fIpathName \fBinvoke\fR
+.
Does just what would have happened if the user invoked the checkbutton
with the mouse: toggle the selection state of the button and invoke
the Tcl command associated with the checkbutton, if there is one.
The return value is the return value from the Tcl command, or an
empty string if there is no command associated with the checkbutton.
This command is ignored if the checkbutton's state is \fBdisabled\fR.
+.\" METHOD: select
.TP
\fIpathName \fBselect\fR
+.
Selects the checkbutton and sets the associated variable to its
.QW on
value.
+.\" METHOD: toggle
.TP
\fIpathName \fBtoggle\fR
+.
Toggles the selection state of the button, redisplaying it and
modifying its associated variable to reflect the new state.
.SH BINDINGS