Home › Tk Themed Widget Tk

ttk::checkbutton

On/off widget

literal type exactly as shown argument replace with your value ?optional? may be omitted

Synopsis#

ttk::checkbutton pathName ?options?

Description#

A ttk::checkbutton widget is used to show or change a setting. It has two states, selected and deselected. The state of the checkbutton may be linked to a Tcl variable.

Standard Options#

See the ttk_widget manual entry for details on the standard options.

Widget-specific options#

-command#

Database name	command
Database class	Command

A Tcl script to execute whenever the widget is invoked.

-offvalue#

Database name	offValue
Database class	OffValue

The value to store in the associated -variable when the widget is deselected. Defaults to 0.

-onvalue#

Database name	onValue
Database class	OnValue

The value to store in the associated -variable when the widget is selected. Defaults to 1.

-variable#

Database name	variable
Database class	Variable

The name of a global variable whose value is linked to the widget. Defaults to the widget pathname if not specified.

Widget command#

In addition to the standard cget, configure, identify element, instate, state and style commands (see ttk::widget), checkbutton widgets support the following additional commands:

pathname invoke

Toggles between the selected and deselected states and evaluates the associated -command. If the widget is currently selected, sets the -variable to the -offvalue and deselects the widget; otherwise, sets the -variable to the -onvalue Returns the result of the -command.

Widget states#

The widget does not respond to user input if the disabled state is set. The widget sets the selected state whenever the linked -variable is set to the widget's -onvalue, and clears it otherwise. The widget sets the alternate state whenever the linked -variable is unset. (The alternate state may be used to indicate a “tri-state” or “indeterminate” selection.)

Standard styles#

Ttk::checkbutton widgets support the Toolbutton style in all standard themes, which is useful for creating widgets for toolbars.

Styling options#

The class name for a ttk::checkbutton is TCheckbutton.

Dynamic states: active, alternate, disabled, pressed, selected, readonly.

TCheckbutton styling options configurable with ttk::style are:

-background color
-compound compound
-foreground color
-indicatorbackground color
-indicatorcolor color
-indicatormargin padding
-indicatorrelief relief
-padding padding

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

Keywords#

widget · button · toggle · check · option

Copyright#

• Copyright © 2004 Joe English