Tk Built-In Commands checkbutton(1T)
_________________________________________________________________
NAME
checkbutton - Create and manipulate checkbutton widgets
SYNOPSIS
checkbutton pathName ?options?
STANDARD OPTIONS-activebackground -disabledforeground -padx
-activeforeground -font -pady
-anchor -foreground -relief
-background -highlightbackground -takefocus
-bitmap -highlightcolor -text
-borderwidth -highlightthickness -textvariable
-compound -image -underline
-cursor -justify -wraplength
See the options manual entry for details on the standard options.WIDGET-SPECIFIC OPTIONS
Command-Line Name:-command
Database Name: command Database Class: Command Specifies a Tcl command to associate with the button. This command is typically invoked when mouse button 1is released over the button window. The button's glo-
bal variable (-variable option) will be updated before
the command is invoked.Command-Line Name:-height
Database Name: height Database Class: Height Specifies a desired height for the button. If an image or bitmap is being displayed in the button then thevalue is in screen units (i.e. any of the forms accept-
able to Tk_GetPixels); for text it is in lines of text.
If this option isn't specified, the button's desired height is computed from the size of the image or bitmap or text being displayed in it.Command-Line Name:-indicatoron
Database Name: indicatorOn Database Class: IndicatorOn Specifies whether or not the indicator should be drawn. Must be a proper boolean value. If false, the relief option is ignored and the widget's relief is always sunken if the widget is selected and raised otherwise. | Tk Last change: 4.4 1Tk Built-In Commands checkbutton(1T)
Command-Line Name:-offrelief |
Database Name: offRelief | Database Class: OffRelief | ||Specifies the relief for the checkbutton when the indi- |
cator 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 -overre- |
lief 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 exhi- |
bited by the Bold, Italic, and Underline checkbuttons |
on the toolbar of a word-processor, for example.
Command-Line Name:-offvalue
Database Name: offValue Database Class: Value Specifies value to store in the button's associated variable whenever this button is deselected. Defaults to ``0''.Command-Line Name:-onvalue
Database Name: onValue Database Class: Value Specifies value to store in the button's associated variable whenever this button is selected. Defaults to ``1''. |Command-Line Name:-overrelief |
Database Name: overRelief | Database Class: 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 confi- |
guring -relief flat -overrelief raised. If the value |
of this option is the empty string, then no alternative |relief is used when the mouse cursor is over the check- |
button. The empty string is the default value.Command-Line Name:-selectcolor
Database Name: selectColor Database Class: Background Specifies a background color to use when the button is selected. If indicatorOn is true then the color applies to the indicator. Under Windows, this color is used as the background for the indicator regardless of Tk Last change: 4.4 2Tk Built-In Commands checkbutton(1T)
the select state. If indicatorOn is false, this color is used as the background for the entire widget, in place of background or activeBackground, whenever the widget is selected. If specified as an empty string then no special color is used for displaying when the widget is selected.Command-Line Name:-selectimage
Database Name: selectImage Database Class: SelectImage Specifies an image to display (in place of the imageoption) when the checkbutton is selected. This option
is ignored unless the image option has been specified.Command-Line Name:-state
Database Name: state Database Class: StateSpecifies one of three states for the checkbutton:
normal, active, or disabled. In normal state thecheckbutton is displayed using the foreground and back-
ground options. The active state is typically usedwhen the pointer is over the checkbutton. In active
state the checkbutton is displayed using the
activeForeground and activeBackground options. Dis-
abled state means that the checkbutton should be insen-
sitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. In this state the disabledForeground and backgroundoptions determine how the checkbutton is displayed.
Command-Line Name:-variable
Database Name: variable Database Class: 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).Command-Line Name:-width
Database Name: width Database Class: Width Specifies a desired width for the button. If an image or bitmap is being displayed in the button then thevalue is in screen units (i.e. any of the forms accept-
able to Tk_GetPixels); for text it is in characters.
If this option isn't specified, the button's desired width is computed from the size of the image or bitmap or text being displayed in it. Tk Last change: 4.4 3Tk Built-In Commands checkbutton(1T)
_________________________________________________________________
DESCRIPTION
The checkbutton command creates a new window (given by the
pathName 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 aspectsof the checkbutton such as its colors, font, text, and ini-
tial relief. The checkbutton command returns its pathName
argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.A checkbutton is a widget that displays a textual string,
bitmap or image and a square called an indicator. 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 wrapLength option) and one of the characters may optionally be underlined using theunderline 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 state option; it can be made to appear raised, sunken, or flat; it can be made to flash; and it invokes a Tcl commandwhenever mouse button 1 is clicked over the checkbutton.
In addition, checkbuttons can be selected. 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). |
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. 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). 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. By default,the name of the variable associated with a checkbutton is
the same as the name used to create the checkbutton. 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 database. Configuration options may also be used to modify the way the indicator is displayed (or whether itis displayed at all). By default a checkbutton is config-
ured to select and deselect itself on alternate buttonclicks. In addition, each checkbutton monitors its associ-
ated variable and automatically selects and deselects itself when the variables value changes to and from the button's ``on'' value. Tk Last change: 4.4 4Tk Built-In Commands checkbutton(1T)
WIDGET COMMANDThe checkbutton command creates a new Tcl command whose name
is pathName. This command may be used to invoke various operations on the widget. It has the following general form: pathName option ?arg arg ...?Option and the args determine the exact behavior of the com-
mand. The following commands are possible for checkbutton
widgets: pathName cget option Returns the current value of the configuration option given by option. Option may have any of the valuesaccepted by the checkbutton command.
pathName configure ?option? ?value option value ...? Query or modify the configuration options of the widget. If no option is specified, returns a list describing all of the available options for pathName(see Tk_ConfigureInfo for information on the format of
this list). If option is specified with no value, then the command returns a list describing the one namedoption (this list will be identical to the correspond-
ing sublist of the value returned if no option isspecified). If one or more option-value 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. Option may have anyof the values accepted by the checkbutton command.
pathName deselectDeselects the checkbutton and sets the associated vari-
able to its ``off'' value. pathName flashFlashes the checkbutton. This is accomplished by
redisplaying the checkbutton several times, alternating
between active and normal colors. At the end of theflash the checkbutton is left in the same normal/active
state as when the command was invoked. This command isignored if the checkbutton's state is disabled.
pathName invoke Does just what would have happened if the user invokedthe checkbutton with the mouse: toggle the selection
state of the button and invoke the Tcl command associ-
ated 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 thecheckbutton. This command is ignored if the
checkbutton's state is disabled.
Tk Last change: 4.4 5Tk Built-In Commands checkbutton(1T)
pathName selectSelects the checkbutton and sets the associated vari-
able to its ``on'' value. pathName toggle Toggles the selection state of the button, redisplaying it and modifying its associated variable to reflect the new state. BINDINGSTk automatically creates class bindings for checkbuttons
that give them the following default behavior: | [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.[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). | [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 but- |
ton.If the checkbutton's state is disabled then none of the
above actions occur: the checkbutton is completely non-
responsive.The behavior of checkbuttons can be changed by defining new
bindings for individual widgets or by redefining the class bindings.SEE ALSO
button(1T), options(1T), radiobutton(1T) KEYWORDScheckbutton, widget
ATTRIBUTES
See attributes(5) for descriptions of the following Tk Last change: 4.4 6Tk Built-In Commands checkbutton(1T)
attributes:_______________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE|
|____________________|__________________|_
| Availability | runtime/tk-8 |
|____________________|__________________|_
| Interface Stability| Uncommitted ||____________________|_________________|
NOTES Source for Tk is available on http://opensolaris.org. Tk Last change: 4.4 7