a2p
accept
access
acct
addftinfo
addr2line
adjtime
afmtodit
after
aio_cancel
aio_error
aio_read
aio_return
aio_suspend
aio_waitcomplete
aio_write
alias
aliases
alloc
anvil
append
apply
apropos
ar
array
as
asa
asn1parse
at
atq
atrm
attemptckalloc
attemptckrealloc
authlib
authtest
autopoint
awk
b64decode
b64encode
basename
batch
bc
bdes
bell
bg
bgerror
biff
big5
binary
bind
bindkey
bindtags
bindtextdomain
bio
bitmap
blowfish
bn
bootparams
bootptab
bounce
brandelf
break
breaksw
brk
bsdiff
bsdtar
bsnmpd
bspatch
bthost
btsockstat
buffer
builtin
builtins
bunzip2
button
byacc
bzcat
bzegrep
bzfgrep
bzgrep
bzip2
c2ph
c89
c99
ca
cal
calendar
canvas
cap_mkdb
case
cat
catch
catman
cc
cd
cdcontrol
chdir
checkbutton
checknr
chflags
chfn
chgrp
chio
chkey
chmod
chown
chpass
chroot
chsh
ci
ciphers
ckalloc
ckdist
ckfree
ckrealloc
cksum
cleanup
clear
clipboard
clock
clock_getres
clock_gettime
clock_settime
close
cmp
co
col
colcrt
colldef
colors
colrm
column
comm
command
compile_et
complete
compress
concat
config
connect
console
continue
core
courierlogger
couriertcpd
cp
cpan
cpio
cpp
creat
crl
crontab
crunchgen
crunchide
crypt
crypto
csh
csplit
ctags
ctm
ctm_dequeue
ctm_rmail
ctm_smail
cu
cursor
cursors
cut
cvs
date
dbiprof
dbiproxy
dc
dcgettext
dcngettext
dd
dde
default
defer
deliverquota
des
destroy
devfs
df
dgettext
dgst
dh
dhparam
dialog
diff
diff3
dig
dir
dirent
dirname
dirs
discard
disktab
dngettext
do
domainname
done
dprofpp
dsa
dsaparam
dtmfdecode
du
dup
dup2
eaccess
ec
ecdsa
echo
echotc
ecparam
ed
edit
editrc
ee
egrep
elf
elfdump
elif
else
enc
enc2xs
encoding
end
endif
endsw
engine
enigma
entry
env
envsubst
eof
eqn
err
errno
error
errstr
esac
ethers
euc
eui64
eval
event
evp
ex
exec
execve
exit
expand
export
exports
expr
extattr
extattr_delete_fd
extattr_delete_file
extattr_get_fd
extattr_get_file
extattr_set_fd
extattr_set_file
f77
false
famm
famx
fblocked
fbtab
fc
fchdir
fchflags
fchmod
fchown
fcntl
fconfigure
fcopy
fdescfs
fdformat
fdread
fdwrite
fetch
fg
fgrep
fhopen
fhstat
fhstatfs
fi
file
file2c
fileevent
filename
filetest
find
find2perl
finger
flex
flock
flush
fmt
focus
fold
font
fontedit
for
foreach
fork
format
forward
fpathconf
frame
from
fs
fstab
fstat
fstatfs
fsync
ftp
ftpchroot
ftpusers
ftruncate
futimes
g711conv
gb2312
gb18030
gbk
gcc
gcore
gcov
gdb
gencat
gendsa
genrsa
gensnmptree
getconf
getdents
getdirentries
getdtablesize
getegid
geteuid
getfacl
getfh
getfsstat
getgid
getgroups
getitimer
getlogin
getopt
getopts
getpeername
getpgid
getpgrp
getpid
getppid
getpriority
getresgid
getresuid
getrlimit
getrusage
gets
getsid
getsockname
getsockopt
gettext
gettextize
gettimeofday
gettytab
getuid
glob
global
gmake
goto
gperf
gprof
grab
grep
grid
grn
grodvi
groff
groff_font
groff_out
groff_tmac
grog
grolbp
grolj4
grops
grotty
group
groups
gunzip
gzcat
gzexe
gzip
h2ph
h2xs
hash
hashstat
hd
head
help2man
hesinfo
hexdump
history
host
hostname
hosts
hosts_access
hosts_options
hpftodit
http
hup
i386_get_ioperm
i386_get_ldt
i386_set_ioperm
i386_set_ldt
i386_vm86
iconv
id
ident
idprio
if
ifnames253
ifnames259
image
imapd
incr
indent
indxbib
info
infokey
inode
install
instmodsh
interp
intro
introduction
ioctl
ipcrm
ipcs
ipf
ipftest
ipnat
ippool
ipresend
issetugid
jail
jail_attach
jobid
jobs
join
jot
kbdcontrol
kbdmap
kcon
kdestroy
kdump
kenv
kevent
keycap
keylogin
keylogout
keymap
keysyms
kgdb
kill
killall
killpg
kinit
kldfind
kldfirstmod
kldload
kldnext
kldstat
kldsym
kldunload
klist
kpasswd
kqueue
kse
kse_create
kse_exit
kse_release
kse_switchin
kse_thr_interrupt
kse_wakeup
ktrace
label
labelframe
lam
lappend
last
lastcomm
lastlog
lchflags
lchmod
lchown
ld
ldap
ldapadd
ldapcompare
ldapdelete
ldapmodify
ldapmodrdn
ldappasswd
ldapsearch
ldapwhoami
ldd
leave
less
lesskey
lex
lgetfh
lhash
libnetcfg
library
limit
limits
lindex
link
linprocfs
linsert
lint
lio_listio
list
listbox
listen
lj4_font
lkbib
llength
lmtp
ln
load
loadfont
local
locale
locate
lock
lockf
log
logger
login
logins
logname
logout
look
lookbib
lorder
lower
lp
lpq
lpr
lprm
lptest
lrange
lreplace
ls
lsearch
lseek
lset
lsort
lstat
lsvfs
lutimes
lynx
m4
madvise
magic
mail
maildiracl
maildirkw
maildirmake
mailq
mailx
make
makeinfo
makewhatis
man
manpath
master
mc
mcedit
mcview
md2
md4
md5
mdc2
memory
menu
menubar
menubutton
merge
mesg
message
mincore
minherit
minigzip
mkdep
mkdir
mkfifo
mkimapdcert
mklocale
mknod
mkpop3dcert
mkstr
mktemp
mlock
mlockall
mmap
mmroff
modfind
modfnext
modnext
modstat
moduli
more
motd
mount
mprotect
mptable
msdos
msdosfs
msgattrib
msgcat
msgcmp
msgcomm
msgconv
msgen
msgexec
msgfilter
msgfmt
msggrep
msginit
msgmerge
msgs
msgunfmt
msguniq
mskanji
msql2mysql
msync
mt
munlock
munlockall
munmap
mv
myisamchk
myisamlog
myisampack
mysql
mysqlaccess
mysqladmin
mysqlbinlog
mysqlcheck
mysqld
mysqldump
mysqld_multi
mysqld_safe
mysqlhotcopy
mysqlimport
mysqlshow
mysql_config
mysql_fix_privilege_tables
mysql_zap
namespace
nanosleep
nawk
nc
ncal
ncplist
ncplogin
ncplogout
neqn
netconfig
netgroup
netid
netstat
networks
newaliases
newgrp
nex
nfsstat
nfssvc
ngettext
nice
nl
nm
nmount
nohup
nologin
notify
nroff
nseq
nslookup
ntp_adjtime
ntp_gettime
nvi
nview
objcopy
objdump
objformat
ocsp
od
onintr
open
openssl
opieaccess
opieinfo
opiekey
opiekeys
opiepasswd
option
options
oqmgr
pack
package
packagens
pagesize
palette
pam_auth
panedwindow
parray
passwd
paste
patch
pathchk
pathconf
pawd
pax
pbm
pcre
pcreapi
pcrebuild
pcrecallout
pcrecompat
pcrecpp
pcregrep
pcrematching
pcrepartial
pcrepattern
pcreperform
pcreposix
pcreprecompile
pcresample
pcretest
perl
perl56delta
perl58delta
perl561delta
perl570delta
perl571delta
perl572delta
perl573delta
perl581delta
perl582delta
perl583delta
perl584delta
perl585delta
perl586delta
perl587delta
perl588delta
perl5004delta
perl5005delta
perlaix
perlamiga
perlapi
perlapio
perlapollo
perlartistic
perlbeos
perlbook
perlboot
perlbot
perlbs2000
perlbug
perlcall
perlcc
perlce
perlcheat
perlclib
perlcn
perlcompile
perlcygwin
perldata
perldbmfilter
perldebguts
perldebtut
perldebug
perldelta
perldgux
perldiag
perldoc
perldos
perldsc
perlebcdic
perlembed
perlepoc
perlfaq
perlfaq1
perlfaq2
perlfaq3
perlfaq4
perlfaq5
perlfaq6
perlfaq7
perlfaq8
perlfaq9
perlfilter
perlfork
perlform
perlfreebsd
perlfunc
perlglossary
perlgpl
perlguts
perlhack
perlhist
perlhpux
perlhurd
perlintern
perlintro
perliol
perlipc
perlirix
perlivp
perljp
perlko
perllexwarn
perllinux
perllocale
perllol
perlmachten
perlmacos
perlmacosx
perlmint
perlmod
perlmodinstall
perlmodlib
perlmodstyle
perlmpeix
perlnetware
perlnewmod
perlnumber
perlobj
perlop
perlopenbsd
perlopentut
perlos2
perlos390
perlos400
perlothrtut
perlpacktut
perlplan9
perlpod
perlpodspec
perlport
perlqnx
perlre
perlref
perlreftut
perlrequick
perlreref
perlretut
perlrun
perlsec
perlsolaris
perlstyle
perlsub
perlsyn
perlthrtut
perltie
perltoc
perltodo
perltooc
perltoot
perltrap
perltru64
perltw
perlunicode
perluniintro
perlutil
perluts
perlvar
perlvmesa
perlvms
perlvos
perlwin32
perlxs
perlxstut
perror
pfbtops
pftp
pgrep
phones
photo
pic
pickup
piconv
pid
pipe
pkcs7
pkcs8
pkcs12
pkg_add
pkg_check
pkg_create
pkg_delete
pkg_info
pkg_sign
pkg_version
pkill
pl2pm
place
pod2html
pod2latex
pod2man
pod2text
pod2usage
podchecker
podselect
poll
popd
popup
posix_madvise
postalias
postcat
postconf
postdrop
postfix
postkick
postlock
postlog
postmap
postqueue
postsuper
pr
pread
preadv
printcap
printenv
printf
proc
procfs
profil
protocols
prove
proxymap
ps
psed
psroff
pstruct
ptrace
publickey
pushd
puts
pwd
pwrite
pwritev
qmgr
qmqpd
quota
quotactl
radiobutton
raise
rand
ranlib
rcp
rcs
rcsclean
rcsdiff
rcsfile
rcsfreeze
rcsintro
rcsmerge
read
readelf
readlink
readonly
readv
realpath
reboot
recv
recvfrom
recvmsg
red
ree
refer
regexp
registry
regsub
rehash
remote
rename
repeat
replace
req
reset
resolver
resource
return
rev
revoke
rfcomm_sppd
rfork
rhosts
ripemd
ripemd160
rlog
rlogin
rm
rmd160
rmdir
rpc
rpcgen
rs
rsa
rsautl
rsh
rtld
rtprio
rup
ruptime
rusers
rwall
rwho
s2p
safe
sasl
sasldblistusers2
saslpasswd2
sbrk
scache
scale
scan
sched
sched_getparam
sched_getscheduler
sched_get_priority_max
sched_get_priority_min
sched_rr_get_interval
sched_setparam
sched_setscheduler
sched_yield
scon
scp
script
scrollbar
sdiff
sed
seek
select
selection
semctl
semget
semop
send
sendbug
sendfile
sendmail
sendmsg
sendto
services
sess_id
set
setegid
setenv
seteuid
setfacl
setgid
setgroups
setitimer
setlogin
setpgid
setpgrp
setpriority
setregid
setresgid
setresuid
setreuid
setrlimit
setsid
setsockopt
settc
settimeofday
setty
setuid
setvar
sftp
sh
sha
sha1
sha256
shar
shells
shift
shmat
shmctl
shmdt
shmget
showq
shutdown
sigaction
sigaltstack
sigblock
sigmask
sigpause
sigpending
sigprocmask
sigreturn
sigsetmask
sigstack
sigsuspend
sigvec
sigwait
size
slapadd
slapcat
slapd
slapdn
slapindex
slappasswd
slaptest
sleep
slogin
slurpd
smbutil
smime
smtp
smtpd
socket
socketpair
sockstat
soelim
sort
source
spawn
speed
spinbox
spkac
splain
split
squid
squid_ldap_auth
squid_ldap_group
squid_unix_group
sscop
ssh
sshd_config
ssh_config
stab
startslip
stat
statfs
stop
string
strings
strip
stty
su
subst
sum
suspend
swapoff
swapon
switch
symlink
sync
sysarch
syscall
sysconftool
sysconftoolcheck
systat
s_client
s_server
s_time
tabs
tail
talk
tar
tbl
tclsh
tcltest
tclvars
tcopy
tcpdump
tcpslice
tcsh
tee
tell
telltc
telnet
term
termcap
terminfo
test
texindex
texinfo
text
textdomain
tfmtodit
tftp
then
threads
time
tip
tk
tkerror
tkvars
tkwait
tlsmgr
tmac
top
toplevel
touch
tput
tr
trace
trafshow
trap
troff
true
truncate
truss
tset
tsort
tty
ttys
type
tzfile
ui
ul
ulimit
umask
unalias
uname
uncomplete
uncompress
undelete
unexpand
unhash
unifdef
unifdefall
uniq
units
unknown
unlimit
unlink
unmount
unset
unsetenv
until
unvis
update
uplevel
uptime
upvar
usbhidaction
usbhidctl
users
utf8
utimes
utmp
utrace
uudecode
uuencode
uuidgen
vacation
variable
verify
version
vfork
vgrind
vgrindefs
vi
vidcontrol
vidfont
view
virtual
vis
vt220keys
vwait
w
wait
wait3
wait4
waitpid
wall
wc
wget
what
whatis
where
whereis
which
while
who
whoami
whois
window
winfo
wish
wm
write
writev
wtmp
x509
xargs
xgettext
xmlwf
xstr
xsubpp
yacc
yes
ypcat
ypchfn
ypchpass
ypchsh
ypmatch
yppasswd
ypwhich
yyfix
zcat
zcmp
zdiff
zegrep
zfgrep
zforce
zgrep
zmore
znew
_exit
__syscall
 
FreeBSD/Linux/UNIX General Commands Manual
Hypertext Man Pages
checkbutton
 
checkbutton(n)		     Tk Built-In Commands		checkbutton(n)



NAME
       checkbutton - Create and manipulate checkbutton widgets

SYNOPSIS
       checkbutton   pathName	?options?   -activebackground	-disabledfore-
       ground -padx    -activeforeground   -font     -pady    -anchor	-fore-
       ground	 -relief    -background    -highlightbackground     -takefocus
       -bitmap	 -highlightcolor     -text     -borderwidth   -highlightthick-
       ness -textvariable    -compound -image	 -underline    -cursor	 -jus-
       tify  -wraplength

WIDGET-SPECIFIC OPTIONS
       Specifies a Tcl command to associate with the button.  This command  is
       typically  invoked when mouse button 1 is released over the button win-
       dow.  The button's global variable (-variable option) will  be  updated
       before the command is invoked.  Specifies a desired height for the but-
       ton.  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 Tk_Get-
       Pixels); for text it is in lines of text.  If this option isn't	speci-
       fied,  the  button's  desired  height  is computed from the size of the
       image or bitmap or text being displayed in it.	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.  Specifies the
       relief for the checkbutton when the indicator  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  -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.  Specifies value to store
       in the button's associated variable whenever this button is deselected.
       Defaults to ``0''.  Specifies value to store in the button's associated
       variable  whenever this button is selected.  Defaults to ``1''.	Speci-
       fies an alternative relief for the checkbutton, to  be  used  when  the
       mouse cursor is over the widget.  This option can be used to make tool-
       bar buttons, by configuring -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 checkbutton.  The  empty	string
       is  the	default  value.   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 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 display-
       ing when the widget is selected.  Specifies an  image  to  display  (in
       place  of  the  image  option)  when the checkbutton is selected.  This
       option is ignored unless the image option has been  specified.	Speci-
       fies  one of three states for the checkbutton:  normal, active, or dis-
       abled.  In normal state the checkbutton is displayed  using  the  fore-
       ground and background options.  The active state is typically used when
       the pointer is over the checkbutton.  In active state  the  checkbutton
       is  displayed  using the activeForeground and activeBackground 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 disabledForeground  and  back-
       ground  options	determine how the checkbutton is displayed.  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).  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  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.


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 aspects of the checkbutton such  as  its  colors,
       font,  text,  and  initial 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 under-
       lined using the underline option.  A checkbutton has all of the	behav-
       ior  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 command whenever 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  appear-
       ance,  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 asso-
       ciated 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 it is displayed at all).  By default a checkbutton is  con-
       figured	to  select and deselect itself on alternate button clicks.  In
       addition, each checkbutton monitors its associated variable  and  auto-
       matically selects and deselects itself when the variables value changes
       to and from the button's ``on'' value.

WIDGET COMMAND
       The checkbutton command creates a new Tcl command whose name  is  path-
       Name.   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 command.
       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 values accepted 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 avail-
	      able 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  named
	      option (this list will be identical to the corresponding sublist
	      of the value returned if no option is  specified).   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 any
	      of the values accepted by the checkbutton command.

       pathName deselect
	      Deselects the checkbutton and sets the  associated  variable  to
	      its ``off'' value.

       pathName flash
	      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 disabled.

       pathName invoke
	      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  checkbut-
	      ton, if there is one.  The return value is the return value from
	      the Tcl command, or an empty string if there is no command asso-
	      ciated  with  the  checkbutton.	This command is ignored if the
	      checkbutton's state is disabled.

       pathName select
	      Selects the checkbutton and sets the associated variable 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.

BINDINGS
       Tk 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 button.

       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(n), options(n), radiobutton(n)


KEYWORDS
       checkbutton, widget



Tk				      4.4			checkbutton(n)
=20984
+2303
(91)