diff options
Diffstat (limited to 'doc/ttk_checkbutton.n')
| -rw-r--r-- | doc/ttk_checkbutton.n | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n index e74b7b2..d38d731 100644 --- a/doc/ttk_checkbutton.n +++ b/doc/ttk_checkbutton.n @@ -1,16 +1,23 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.3 2006/12/13 23:04:32 hobbs Exp $ +'\" .so man.macros .TH ttk_checkbutton n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::checkbutton \- On/off widget +ttk_checkbutton \- On/off widget .SH SYNOPSIS \fBttk::checkbutton\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBcheckbutton\fR widget is used to show or change a setting. +A \fBttk::checkbutton\fR widget is used to show or change a setting. It has two states, selected and deselected. The state of the checkbuton may be linked to a Tcl variable. .SO @@ -18,6 +25,7 @@ The state of the checkbuton may be linked to a Tcl variable. \-state \-style \-takefocus \-text \-textvariable \-underline \-width .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A Tcl script to execute whenever the widget is invoked. @@ -30,6 +38,7 @@ when the widget is selected. Defaults to \fB1\fR. .OP \-variable variable Variable The name of a global variable whose value is linked to the widget. Defaults to the widget pathname if not specified. + .SH "WIDGET COMMAND" In addition to the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR @@ -46,6 +55,7 @@ Returns the result of the \fI-command\fR. .\" Missing: select, deselect, toggle .\" Are these useful? They don't invoke the -command .\" Missing: flash. This is definitely not useful. + .SH "WIDGET STATES" The widget does not respond to user input if the \fBdisabled\fR state is set. The widget sets the \fBselected\fR state whenever @@ -55,7 +65,9 @@ The widget sets the \fBalternate\fR state whenever the linked \fB-variable\fR is unset. (The \fBalternate\fR state may be used to indicate a ``tri-state'' or ``indeterminate'' selection.) + .SH "SEE ALSO" -widget(n), keynav(n), radiobutton(n) +ttk_widget(n), ttk_radiobutton(n), checkbutton(n) + .SH "KEYWORDS" widget, button, toggle, check, option |