head	1.21;
access;
symbols
	core-8-5-9:1.19
	core-8-5-8:1.19
	macosx-cocoa-merge:1.21
	macosx-cocoa-premerge:1.21
	macosx-carbon-freeze:1.21
	core-8-5-7:1.19
	core-8-5-6:1.19
	core-8-6-b1:1.21
	core-8-6-a3:1.21
	core-8-5-5:1.19
	core-8-6-a2:1.20
	core-8-5-4:1.19
	core-8-5-3:1.19
	core-8-6-a1:1.19
	core-8-4-19:1.6.2.1
	core-8-5-branch:1.19.0.2
	core-8-5-2:1.19
	core-8-4-18:1.6.2.1
	core-8-5-1:1.19
	core-8-4-17:1.6.2.1
	core-8-5-0:1.19
	core-8-5-b3:1.18
	core-8-5-b2:1.15
	core-8-4-16:1.6.2.1
	core-8-5-b1:1.13
	core-stablilizer-merge:1.12
	core-stabilizer-branch:1.12.0.2
	core-stabilizer-merge:1.19
	core-8-4-15:1.6.2.1
	core-8-5-a6:1.12
	core-8-5-a5:1.11
	core-8-4-14:1.6.2.1
	core-8-5-a4:1.11
	core-8-4-13:1.6.2.1
	core-8-4-12:1.6.2.1
	core-8-4-11:1.6.2.1
	core-8-5-a3:1.10
	core-8-4-10:1.6.2.1
	core-8-4-9-branch:1.6.2.1.0.2
	core-8-5-a2:1.9
	core-8-4-9:1.6.2.1
	core-8-4-8:1.6.2.1
	core-8-4-7:1.6
	core-8-5-a1:1.7
	core-8-4-6:1.6
	core-8-4-5:1.6
	mistachkin-dev-branch:1.6.0.4
	core-8-4-4:1.6
	core-8-4-3:1.6
	core-8-4-branch:1.6.0.2
	core-8-4-2:1.6
	core-8-4-1:1.6
	core-8-3-5:1.2
	core-8-4-0:1.6
	macosx-8-4-merge-2002-08-31-trunk:1.6
	macosx-8-4-premerge-2002-08-31-branch:1.4.6.2
	macosx-8-4-premerge-2002-08-31-trunk:1.6
	macosx-8-4-merge-2002-08-30-branch:1.4.6.2
	macosx-8-4-merge-2002-08-30-trunk:1.6
	macosx-8-4-merge-2002-08-20-branch:1.4.6.1
	macosx-8-4-merge-2002-08-20-trunk:1.5
	core-8-4-b2:1.5
	core-8-4-b1:1.5
	macosx-premerge-6-9-02:1.4
	core-8-4-a4:1.4
	core-8-3-4:1.2
	macosx-8-4-branch:1.4.0.6
	macosx-8-4-branchpoint:1.4
	core-8-4-a3:1.4
	core-8-3-3:1.2
	dgp-privates-into-namespace:1.4.0.4
	tclpro-1-5-0:1.2
	core-8-4-win-speedup:1.4.0.2
	core-8-4-a2:1.4
	tclpro-1-4-1:1.2
	tclpro-1-4-0:1.2
	core-8-3-2:1.2
	ajuba-ajuba2-2-1-base:1.2
	ajuba-ajuba2-2-0:1.2
	core-8-4-a1:1.3
	core-8-3-1-branch:1.2.0.18
	core-8-3-1:1.2
	scriptics-sc-2-0-b5:1.2
	scriptics-sc-2-0-fixed:1.2
	scriptics-sc-2-0-b2:1.2
	scriptics-sc-2-0-b1:1.2
	core-8-3-0:1.2
	core-8-3-b2:1.2
	core-8-3-b1:1.2
	scriptics-sc-1-1:1.2
	scriptics-sc-1-1-b1:1.2
	core-8-2-3:1.2
	scriptics-sc-1-1-branch:1.2.0.16
	scriptics-sc-1-1-base:1.2
	scriptics-sc-1-0:1.2
	scriptics-sc-1-0-branch:1.2.0.14
	scriptics-sc-1-0-base:1.2
	core-8-2-2:1.2
	core-8-2-1:1.2
	scriptics-bc-1-0-b1:1.2
	core-8-2-1-branch:1.2.0.12
	scriptics-tclpro-1-3-0:1.2
	core-8-2-0:1.2
	core-8-2-b3-branch:1.2.0.10
	core-8-2-b3-base:1.2
	scriptics-tclpro-1-3-b4:1.2
	core-8-2-b2:1.2
	scriptics-tclpro-1-3-b3:1.2
	core-8-2-b1:1.2
	scriptics-tclpro-1-3-b2:1.2
	merge-to-mainline-5/21/99:1.2
	scriptics-tclpro-1-3-b2-branch:1.2.0.8
	core-8-1-1:1.2
	scriptics-tclpro-1-3-b1:1.2
	core-8-1-1-base:1.2
	core-8-1-0:1.2
	merge-to-mainline-4-29-99:1.2
	merge-to-mainline-4-23-99:1.2
	core-8-1-branch-old:1.1.0.4
	core-8-0-6-branch:1.2.0.6
	core-8-0-6-base:1.2
	core-8-0-5:1.2
	core-8-1-b3:1.1.4.1
	core-8-1-b2:1.1.4.1
	dev-8-1-stubs-branch:1.1.4.1.0.2
	dev-stubs-branch:1.2.0.4
	scriptics-tclpro-1-2:1.2
	scriptics-tclpro-1-2-b2:1.2
	core-8-1-merge-2/10/99:1.2
	core-8-0-5-branch:1.2.0.2
	core-8-0-5-base:1.2
	scriptics-tclpro-1-2-b1:1.2
	scriptics-tclpro-1-2-a1:1.2
	core-8-1-b1:1.1.4.1
	core-8-0-4:1.2
	core-8-1-a2:1.1
	core-8-0-2:1.1
	core-8-0-3:1.2;
locks; strict;
comment	@# @;


1.21
date	2008.09.23.13.36.37;	author dkf;	state Exp;
branches;
next	1.20;

1.20
date	2008.06.30.22.57.02;	author dkf;	state Exp;
branches;
next	1.19;

1.19
date	2007.12.13.15.23.43;	author dgp;	state Exp;
branches;
next	1.18;

1.18
date	2007.11.01.10.59.42;	author dkf;	state Exp;
branches;
next	1.17;

1.17
date	2007.10.29.21.19.42;	author dkf;	state Exp;
branches;
next	1.16;

1.16
date	2007.10.29.16.04.13;	author dkf;	state Exp;
branches;
next	1.15;

1.15
date	2007.10.26.20.13.23;	author dgp;	state Exp;
branches;
next	1.14;

1.14
date	2007.10.24.14.32.57;	author dkf;	state Exp;
branches;
next	1.13;

1.13
date	2007.08.28.15.16.11;	author dkf;	state Exp;
branches;
next	1.12;

1.12
date	2006.12.13.23.04.32;	author hobbs;	state Exp;
branches
	1.12.2.1;
next	1.11;

1.11
date	2005.12.01.03.54.06;	author hobbs;	state Exp;
branches;
next	1.10;

1.10
date	2005.04.06.21.11.54;	author dkf;	state Exp;
branches;
next	1.9;

1.9
date	2004.10.28.10.22.51;	author dkf;	state Exp;
branches;
next	1.8;

1.8
date	2004.08.16.14.01.10;	author dkf;	state Exp;
branches;
next	1.7;

1.7
date	2004.02.18.00.40.23;	author hobbs;	state Exp;
branches;
next	1.6;

1.6
date	2002.08.28.01.08.06;	author drh;	state Exp;
branches
	1.6.2.1;
next	1.5;

1.5
date	2002.06.17.10.54.29;	author drh;	state Exp;
branches;
next	1.4;

1.4
date	2000.08.25.06.58.32;	author ericm;	state Exp;
branches
	1.4.6.1;
next	1.3;

1.3
date	2000.05.25.16.57.23;	author ericm;	state Exp;
branches;
next	1.2;

1.2
date	98.09.14.18.22.55;	author stanton;	state Exp;
branches;
next	1.1;

1.1
date	98.04.01.09.39.50;	author rjohnson;	state Exp;
branches
	1.1.4.1;
next	;

1.1.4.1
date	98.09.30.02.16.13;	author stanton;	state Exp;
branches;
next	;

1.4.6.1
date	2002.08.20.20.27.00;	author das;	state Exp;
branches;
next	1.4.6.2;

1.4.6.2
date	2002.08.30.15.36.13;	author das;	state Exp;
branches;
next	;

1.6.2.1
date	2004.10.28.10.19.29;	author dkf;	state Exp;
branches;
next	;

1.12.2.1
date	2007.09.04.17.44.20;	author dgp;	state Exp;
branches;
next	1.12.2.2;

1.12.2.2
date	2007.11.01.16.37.14;	author dgp;	state Exp;
branches;
next	;


desc
@@


1.21
log
@Fix [Bug 2118116]
@
text
@'\"
'\" Copyright (c) 1990-1994 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\"
'\" 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.20 2008/06/30 22:57:02 dkf Exp $
'\" 
.so man.macros
.TH checkbutton n 4.4 Tk "Tk Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
checkbutton \- Create and manipulate checkbutton widgets
.SH SYNOPSIS
\fBcheckbutton\fI pathName \fR?\fIoptions\fR?
.SO
\-activebackground	\-disabledforeground	\-padx
\-activeforeground	\-font	\-pady
\-anchor	\-foreground	\-relief
\-background	\-highlightbackground	\-takefocus
\-bitmap	\-highlightcolor	\-text
\-borderwidth	\-highlightthickness	\-textvariable
\-compound	\-image	\-underline
\-cursor	\-justify	\-wraplength
.SE
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-command command Command
Specifies a Tcl command to associate with the button.  This command
is typically invoked when mouse button 1 is released over the button
window.  The button's global variable (\fB\-variable\fR option) will
be updated before the command is invoked.
.OP \-height height Height
Specifies a desired height for the button.
If an image or bitmap is being displayed in the button then the value is in
screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
for text it is in lines of text.
If this option is not specified, the button's desired height is computed
from the size of the image or bitmap or text being displayed in it.
.OP \-indicatoron indicatorOn IndicatorOn
Specifies whether or not the indicator should be drawn.  Must be a
proper boolean value.  If false, the \fBrelief\fR option is
ignored and the widget's relief is always sunken if the widget is
selected and raised otherwise.
.OP \-offrelief offRelief OffRelief
Specifies the relief for the checkbutton when the indicator is not drawn and
the checkbutton is off.  The default value is
.QW raised .
By setting this option to
.QW flat
and setting \fB\-indicatoron\fR to false and \fB\-overrelief\fR to
.QW raised ,
the effect is achieved
of having a flat button that raises on mouse-over and which is
depressed when activated.  This is the behavior typically exhibited by
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
.QW 0 .
.OP \-onvalue onValue Value
Specifies value to store in the button's associated variable whenever
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
toolbar buttons, by configuring \fB\-relief flat \-overrelief
raised\fR.  If the value of this option is the empty string, then no
alternative relief is used when the mouse cursor is over the checkbutton.
The empty string is the default value.
.OP \-selectcolor selectColor Background
Specifies a background color to use when the button is selected.
If \fBindicatorOn\fR is true then the color is used as the background for
the indicator regardless of the select state.
If \fBindicatorOn\fR is false, this color is used as the background
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.
.OP \-selectimage selectImage SelectImage
Specifies an image to display (in place of the \fBimage\fR option)
when the checkbutton is selected.
This option is ignored unless the \fBimage\fR option has been
specified.
.OP \-state state State
Specifies one of three states for the checkbutton:  \fBnormal\fR, \fBactive\fR,
or \fBdisabled\fR.  In normal state the checkbutton is displayed using the
\fBforeground\fR and \fBbackground\fR options.  The active state is
typically used when the pointer is over the checkbutton.  In active state
the checkbutton is displayed using the \fBactiveForeground\fR and
\fBactiveBackground\fR options.  Disabled state means that the checkbutton
should be insensitive:  the default bindings will refuse to activate
the widget and will ignore mouse button presses.
In this state the \fBdisabledForeground\fR and
\fBbackground\fR options determine how the checkbutton is displayed.
.OP \-tristateimage tristateImage TristateImage
Specifies an image to display (in place of the \fBimage\fR option)
when the checkbutton is in tri-state mode.
This option is ignored unless the \fBimage\fR option has been
specified.
.OP \-tristatevalue tristateValue Value
Specifies the value that causes the checkbutton to display the multi-value
selection, also known as the tri-state mode.  Defaults to
.QW "" .
.OP \-variable variable Variable
Specifies name of global variable to set to indicate whether
or not this button is selected.  Defaults to the name of the
button within its parent (i.e. the last element of the button
window's path name).
.OP \-width width Width
Specifies a desired width for the button.
If an image or bitmap is being displayed in the button then the value is in
screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
for text it is in characters.
If this option is not specified, the button's desired width is computed
from the size of the image or bitmap or text being displayed in it.
.BE
.SH DESCRIPTION
.PP
The \fBcheckbutton\fR command creates a new window (given by the
\fIpathName\fR argument) and makes it into a checkbutton widget.
Additional
options, described above, may be specified on the command line
or in the option database
to configure aspects of the checkbutton such as its colors, font,
text, and initial relief.  The \fBcheckbutton\fR command returns its
\fIpathName\fR argument.  At the time this command is invoked,
there must not exist a window named \fIpathName\fR, but
\fIpathName\fR's parent must exist.
.PP
A checkbutton is a widget
that displays a textual string, bitmap or image
and a square called an \fIindicator\fR.
If text is displayed, it must all be in a single font, but it
can occupy multiple lines on the screen (if it contains newlines
or if wrapping occurs because of the \fBwrapLength\fR option) and
one of the characters may optionally be underlined using the
\fBunderline\fR option.
A checkbutton has
all of the behavior of a simple button, including the
following: it can display itself in either of three different
ways, according to the \fBstate\fR option;
it can be made to appear
raised, sunken, or flat; it can be made to flash; and it invokes
a Tcl command whenever mouse button 1 is clicked over the
checkbutton.
.PP
In addition, checkbuttons can be \fIselected\fR.
If a checkbutton is selected then the indicator is normally
drawn with a selected appearance, and
a Tcl variable associated with the checkbutton is set to a particular
value (normally 1).
The indicator is drawn with a check mark inside.
If the checkbutton is not selected, then the indicator is drawn with a
deselected appearance, and the associated variable is
set to a different value (typically 0).
The indicator is drawn without a check mark inside.  In the special case
where the variable (if specified) has a value that matches the tristatevalue,
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
.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
.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
.QW on ,
.QW off
and
.QW tristate
values.
.SH "WIDGET COMMAND"
.PP
The \fBcheckbutton\fR command creates a new Tcl command whose
name is \fIpathName\fR.  This
command may be used to invoke various
operations on the widget.  It has the following general form:
.CS
\fIpathName option \fR?\fIarg arg ...\fR?
.CE
\fIOption\fR and the \fIarg\fRs
determine the exact behavior of the command.  The following
commands are possible for checkbutton widgets:
.TP
\fIpathName \fBcget\fR \fIoption\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.
.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
information on the format of this list).  If \fIoption\fR is specified
with no \fIvalue\fR, then the command returns a list describing the
one named option (this list will be identical to the corresponding
sublist of the value returned if no \fIoption\fR is specified).  If
one or more \fIoption\-value\fR pairs are specified, then the command
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.
.TP
\fIpathName \fBdeselect\fR
Deselects the checkbutton and sets the associated variable to its
.QW off
value.
.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.
.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.
.TP
\fIpathName \fBselect\fR
Selects the checkbutton and sets the associated variable to its
.QW on
value.
.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
.PP
Tk automatically creates class bindings for checkbuttons that give them
the following default behavior:
.IP [1]
On Unix systems, a checkbutton activates whenever the mouse passes
over it and deactivates whenever the mouse leaves the checkbutton.  On
Mac and Windows systems, when mouse button 1 is pressed over a
checkbutton, the button activates whenever the mouse pointer is inside
the button, and deactivates whenever the mouse pointer leaves the
button.
.IP [2]
When mouse button 1 is pressed over a checkbutton, it is invoked (its
selection state toggles and the command associated with the button is
invoked, if there is one).
.IP [3]
When a checkbutton has the input focus, the space key causes the checkbutton
to be invoked.  Under Windows, there are additional key bindings; plus
(+) and equal (=) select the button, and minus (\-) deselects the button.
.PP
If the checkbutton's state is \fBdisabled\fR then none of the above
actions occur:  the checkbutton is completely non-responsive.
.PP
The behavior of checkbuttons can be changed by defining new bindings for
individual widgets or by redefining the class bindings.
.SH EXAMPLE
.PP
This example shows a group of uncoupled checkbuttons.
.PP
.CS
    labelframe .lbl \-text "Steps:"
    \fBcheckbutton\fR .c1 \-text Lights  \-variable lights
    \fBcheckbutton\fR .c2 \-text Cameras \-variable cameras
    \fBcheckbutton\fR .c3 \-text Action! \-variable action
    pack .c1 .c2 .c3 \-in .lbl
    pack .lbl
.CE
.SH "SEE ALSO"
button(n), options(n), radiobutton(n), ttk::checkbutton(n)
.SH KEYWORDS
checkbutton, widget
'\" Local Variables:
'\" mode: nroff
'\" End:
@


1.20
log
@Minor doc updates (removing out of date changebars, improving typedef formatting,
 etc.)
@
text
@a0 1
'\" -*- nroff -*-
d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.19 2007/12/13 15:23:43 dgp Exp $
d292 3
@


1.19
log
@merge stable branch onto HEAD
@
text
@d1 1
d9 1
a9 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.12.2.2 2007/11/01 16:37:14 dgp Exp $
a100 1
.VS 8.5
a104 1
.VE 8.5
d106 1
a106 2
.VS 8.5
Specifies the value that causes the checkbutton to display the multi-value 
a108 1
.VE 8.5
a156 1
.VS 8.5
d161 4
a164 4
The indicator is drawn without a check mark inside.  In the special case 
where the variable (if specified) has a value that matches the tristatevalue, 
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 
d166 1
a166 1
The indicator is drawn in a platform dependent manner.  Under Unix and 
a190 1
.VE 8.5
d278 1
@


1.18
log
@Make documentation use the name that scripts use as much as possible.
[Bug 1640073]
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.17 2007/10/29 21:19:42 dkf Exp $
@


1.17
log
@Minor improvements
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.16 2007/10/29 16:04:13 dkf Exp $
d294 1
a294 1
button(n), options(n), radiobutton(n), ttk_checkbutton(n)
@


1.16
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.15 2007/10/26 20:13:23 dgp Exp $
d52 3
a54 2
and setting \fB\-indicatoron\fR to false and \fB\-overrelief\fR to raised, 
the effect is achieved 
@


1.15
log
@        * doc/*.1:              Revert doc changes that broke
        * doc/*.3:              `make html` so we can get the release
        * doc/*.n:              out the door.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.13 2007/08/28 15:16:11 dkf Exp $
d39 1
a39 1
If this option isn't specified, the button's desired height is computed
d48 5
a52 2
the checkbutton is off.  The default value is "raised".  By setting this option
to "flat" and setting -indicatoron to false and -overrelief to raised,
d60 2
a61 1
this button is deselected.  Defaults to ``0''.
d64 2
a65 1
this button is selected.  Defaults to ``1''.
d108 2
a109 1
selection, also known as the tri-state mode.  Defaults to ``""''
d121 1
a121 1
If this option isn't specified, the button's desired width is computed
a123 1

d170 3
a172 2
Windows, the background interior of the box is ``grayed''.  Under Mac, 
the indicator is drawn with a dash mark inside.
d175 7
a181 3
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.
d188 6
a193 1
changes to and from the button's ``on'', ``off'' and ``tristate'' values.
d229 2
a230 1
Deselects the checkbutton and sets the associated variable to its ``off''
d249 2
a250 1
Selects the checkbutton and sets the associated variable to its ``on''
d274 1
a274 1
(+) and equal (=) select the button, and minus (-) deselects the button.
a280 1

d285 5
a289 5
    labelframe .lbl -text "Steps:"
    \fBcheckbutton\fR .c1 -text Lights  -variable lights
    \fBcheckbutton\fR .c2 -text Cameras -variable cameras
    \fBcheckbutton\fR .c3 -text Action! -variable action
    pack .c1 .c2 .c3 -in .lbl
a291 1

@


1.14
log
@Lots of improvements to look and feel of manual pages
@
text
@d57 1
a57 2
this button is deselected.  Defaults to
.QW 0 .
d60 1
a60 2
this button is selected.  Defaults to
.QW 1 .
d103 1
a103 1
selection, also known as the tri-state mode.  Defaults to the empty string.
d165 2
a166 3
Windows, the background interior of the box is
.QW grayed .
Under Mac, the indicator is drawn with a dash mark inside.
d169 3
a171 7
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.
d178 1
a178 6
changes to and from the button's
.QW on ,
.QW off
and
.QW tristate
values.
d214 1
a214 2
Deselects the checkbutton and sets the associated variable to its
.QW off
d233 1
a233 2
Selects the checkbutton and sets the associated variable to its
.QW on
@


1.13
log
@Assorted documentation improvements.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.12 2006/12/13 23:04:32 hobbs Exp $
d57 2
a58 1
this button is deselected.  Defaults to ``0''.
d61 2
a62 1
this button is selected.  Defaults to ``1''.
d105 1
a105 1
selection, also known as the tri-state mode.  Defaults to ``""''
d167 3
a169 2
Windows, the background interior of the box is ``grayed''.  Under Mac, 
the indicator is drawn with a dash mark inside.
d172 7
a178 3
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.
d185 6
a190 1
changes to and from the button's ``on'', ``off'' and ``tristate'' values.
d226 2
a227 1
Deselects the checkbutton and sets the associated variable to its ``off''
d246 2
a247 1
Selects the checkbutton and sets the associated variable to its ``on''
@


1.12
log
@	* 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".
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.11 2005/12/01 03:54:06 hobbs Exp $
d265 12
a278 1

@


1.12.2.1
log
@merge updates from HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.12 2006/12/13 23:04:32 hobbs Exp $
a264 12
.SH EXAMPLE
This example shows a group of uncoupled checkbuttons.
.PP
.CS
    labelframe .lbl -text "Steps:"
    \fBcheckbutton\fR .c1 -text Lights  -variable lights
    \fBcheckbutton\fR .c2 -text Cameras -variable cameras
    \fBcheckbutton\fR .c3 -text Action! -variable action
    pack .c1 .c2 .c3 -in .lbl
    pack .lbl
.CE

d267 1
@


1.12.2.2
log
@merge updates from HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.12.2.1 2007/09/04 17:44:20 dgp Exp $
d39 1
a39 1
If this option is not specified, the button's desired height is computed
d48 3
a50 7
the checkbutton is off.  The default value is
.QW raised .
By setting this option to
.QW flat
and setting \fB\-indicatoron\fR to false and \fB\-overrelief\fR to
.QW raised ,
the effect is achieved
d57 1
a57 2
this button is deselected.  Defaults to
.QW 0 .
d60 1
a60 2
this button is selected.  Defaults to
.QW 1 .
d103 1
a103 2
selection, also known as the tri-state mode.  Defaults to
.QW "" .
d115 1
a115 1
If this option is not specified, the button's desired width is computed
d118 1
d165 2
a166 3
Windows, the background interior of the box is
.QW grayed .
Under Mac, the indicator is drawn with a dash mark inside.
d169 3
a171 7
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.
d178 1
a178 6
changes to and from the button's
.QW on ,
.QW off
and
.QW tristate
values.
d214 1
a214 2
Deselects the checkbutton and sets the associated variable to its
.QW off
d233 1
a233 2
Selects the checkbutton and sets the associated variable to its
.QW on
d257 1
a257 1
(+) and equal (=) select the button, and minus (\-) deselects the button.
d264 1
d269 5
a273 5
    labelframe .lbl \-text "Steps:"
    \fBcheckbutton\fR .c1 \-text Lights  \-variable lights
    \fBcheckbutton\fR .c2 \-text Cameras \-variable cameras
    \fBcheckbutton\fR .c3 \-text Action! \-variable action
    pack .c1 .c2 .c3 \-in .lbl
d276 1
d278 1
a278 1
button(n), options(n), radiobutton(n), ttk::checkbutton(n)
@


1.11
log
@	* doc/checkbutton.n: fix -selectcolor docs [Bug 1083838]
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.10 2005/04/06 21:11:54 dkf Exp $
d266 1
a266 1
button(n), options(n), radiobutton(n)
@


1.10
log
@Purge old and inaccurate .VS/.VE macros.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.9 2004/10/28 10:22:51 dkf Exp $
d70 2
a71 3
If \fBindicatorOn\fR is true then the color applies to the indicator.
Under Windows, this color is used as the background for the indicator
regardless of the select state.
@


1.9
log
@Assorted minor documentation fixes
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.8 2004/08/16 14:01:10 dkf Exp $
a45 1
.VS 8.4
a54 1
.VE 8.4
a60 1
.VS 8.4
a67 1
.VE 8.4
a243 1
.VS
a250 1
.VE
a254 1
.VS
a258 1
.VE
@


1.8
log
@Standardize the -compound option to everywhere it ought to be. [Bug 712588]
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.7 2004/02/18 00:40:23 hobbs Exp $
d99 1
d104 1
d106 1
d109 1
a155 1
.VS
d159 1
a171 1
.VE
d184 1
a184 1

a243 1

d274 3
@


1.7
log
@	* doc/checkbutton.n: TIP#110 implementation
	* doc/radiobutton.n: Tristate Checkbutton and Radiobuttons
	* generic/tkButton.c:
	* generic/tkButton.h:
	* library/demos/check.tcl:
	* library/demos/radio.tcl:
	* macosx/tkMacOSXButton.c:
	* macosx/tkMacOSXDefault.h:
	* tests/button.test:
	* unix/tkUnixButton.c:
	* unix/tkUnixDefault.h:
	* win/tkWinButton.c:
	* win/tkWinDefault.h:
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.6 2002/08/28 01:08:06 drh Exp $
d19 7
a25 6
\-activebackground	\-font	\-pady
\-activeforeground	\-foreground	\-relief
\-anchor	\-highlightbackground	\-takefocus
\-background	\-highlightcolor	\-text
\-bitmap	\-highlightthickness	\-textvariable
\-borderwidth	\-image	\-underline
a26 1
\-disabledforeground	\-padx
@


1.6
log
@Fix for bug #582457: make radio and checkbuttons work like Windows when
-relief is sunken, -offrelief is flat, and -overrelief is raised.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.5 2002/06/17 10:54:29 drh Exp $
d98 8
d156 1
a156 2
Under Unix, the indicator is drawn with a sunken relief and a special
color.  Under Windows, the indicator is drawn with a check mark inside.
d160 8
a167 2
Under Unix, the indicator is drawn with a raised relief and no special
color.  Under Windows, the indicator is drawn without a check mark inside.
d171 2
a172 2
The variable name, and the ``on'' and ``off'' values stored in it,
may be modified with options on the command line or in the option
d180 1
a180 1
changes to and from the button's ``on'' value.
@


1.6.2.1
log
@Backport of documentation fixes
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.6 2002/08/28 01:08:06 drh Exp $
d19 6
a24 7
\-activebackground	\-disabledforeground	\-padx
\-activeforeground	\-font	\-pady
\-anchor	\-foreground	\-relief
\-background	\-highlightbackground	\-takefocus
\-bitmap	\-highlightcolor	\-text
\-borderwidth	\-highlightthickness	\-textvariable
\-compound	\-image	\-underline
d26 1
d168 1
d228 1
a258 3
.SH "SEE ALSO"
button(n), options(n), radiobutton(n)

@


1.5
log
@Initial implementation of TIP #82: added the -offrelief option to
checkbutton and radiobutton to allow those widgets to have a
MS-Office look and feel.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.4 2000/08/25 06:58:32 ericm Exp $
d49 7
a55 1
the checkbutton is off.  The default value is "raised".
@


1.4
log
@* doc/toplevel.n:
* doc/spinbox.n:
* doc/scrollbar.n:
* doc/scale.n:
* doc/menubutton.n:
* doc/menu.n:
* doc/listbox.n:
* doc/entry.n:
* doc/frame.n:
* doc/message.n:
* doc/checkbutton.n:
* doc/radiobutton.n:
* doc/button.n:
* doc/label.n:
* doc/canvas.n:
* doc/text.n: Fixed Standard Options section to make best use of
new tab settings in man.macros.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.3 2000/05/25 16:57:23 ericm Exp $
d46 5
@


1.4.6.1
log
@merged with trunk at tag macosx-8-4-merge-2002-08-20-trunk
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id$
a45 5
.VS 8.4
.OP \-offrelief offRelief OffRelief
Specifies the relief for the checkbutton when the indicator is not drawn and
the checkbutton is off.  The default value is "raised".
.VE 8.4
@


1.4.6.2
log
@merged with trunk at tag macosx-8-4-merge-2002-08-30-trunk
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.4.6.1 2002/08/20 20:27:00 das Exp $
d49 1
a49 7
the checkbutton is off.  The default value is "raised".  By setting this option
to "flat" and setting -indicatoron to false and -overrelief to raised,
the effect is achieved 
of having a flat button that raises on mouse-over and which is
depressed when activated.  This is the behavior typically exhibited by
the Bold, Italic, and Underline checkbuttons on the toolbar of a 
word-processor, for example.
@


1.3
log
@* doc/radiobutton.n: Added documentation for -overrelief option.

* doc/checkbutton.n: Added documentation for -overrelief option.

* doc/label.n: Added documentation for -state option.

* generic/tkButton.c: Added -overrelief option for checkbuttons,
and radiobuttons.

* library/button.tcl (tkButtonDown, macintosh version): Added
protection against querying the -repeatdelay option from a widget
that doesn't support it (ie, checkbuttons, radiobuttons, etc).
Other platforms use a different binding script for checkbuttons
and radiobuttons, so they don't have this issue.
(tkCheckRadioEnter, windows version):  Added code to handle
-overrelief for check/radiobuttons on windows.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.2 1998/09/14 18:22:55 stanton Exp $
d19 8
a26 8
\-activebackground      \-activeforeground      \-anchor
\-background            \-bitmap                \-borderwidth
\-cursor                \-disabledforeground    \-font
\-foreground            \-highlightbackground   \-highlightcolor
\-highlightthickness    \-image                 \-justify
\-padx                  \-pady                  \-relief
\-takefocus             \-text                  \-textvariable
\-underline             \-wraplength
@


1.2
log
@Replaced SCCS strings, fixed binary files
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id$
d19 8
a26 6
\-activebackground	\-cursor	\-highlightthickness	\-takefocus
\-activeforeground	\-disabledforeground	\-image	\-text
\-anchor	\-font	\-justify	\-textvariable
\-background	\-foreground	\-padx	\-underline
\-bitmap	\-highlightbackground	\-pady	\-wraplength
\-borderwidth	\-highlightcolor	\-relief
d52 9
@


1.1
log
@Initial revision
@
text
@d8 1
a8 1
'\" SCCS: @@(#) checkbutton.n 1.40 96/11/20 12:51:21
@


1.1.4.1
log
@Merged 8.0.3 changes into 8.1
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: checkbutton.n,v 1.2 1998/09/14 18:22:55 stanton Exp $
@


