## Tcl8.6.17/Tk8.6.17 Documentation > Tk Commands > checkbutton

### Tcl/Tk Applications | Tcl Commands | Tk Commands | [incr Tcl] Package Commands | SQLite3 Package Commands | TDBC Package Commands | tdbc::mysql Package Commands | tdbc::odbc Package Commands | tdbc::postgres Package Commands | tdbc::sqlite3 Package Commands | Thread Package Commands | Tcl C API | Tk C API | [incr Tcl] Package C API | TDBC Package C API

  NAME
    checkbutton — '点検釦' の論理値選択部品の生成と操作 Create and manipulate 'checkbutton' boolean selection widgets
  構文 SYNOPSIS
  STANDARD OPTIONS
    -activebackground, activeBackground, Foreground
    -activeforeground, activeForeground, Background
    -anchor, anchor, Anchor
    -background or -bg, background, Background
    -bitmap, bitmap, Bitmap
    -borderwidth or -bd, borderWidth, BorderWidth
    -compound, compound, Compound
    -cursor, cursor, Cursor
    -disabledforeground, disabledForeground, DisabledForeground
    -font, font, Font
    -foreground or -fg, foreground, Foreground
    -highlightbackground, highlightBackground, HighlightBackground
    -highlightcolor, highlightColor, HighlightColor
    -highlightthickness, highlightThickness, HighlightThickness
    -image, image, Image
    -justify, justify, Justify
    -padx, padX, Pad
    -pady, padY, Pad
    -relief, relief, Relief
    -takefocus, takeFocus, TakeFocus
    -text, text, Text
    -textvariable, textVariable, Variable
    -underline, underline, Underline
    -wraplength, wrapLength, WrapLength
  部品固有の指示項目　WIDGET-SPECIFIC OPTIONS
    -command, command, Command
    -height, height, Height
    -indicatoron, indicatorOn, IndicatorOn
    -offrelief, offRelief, OffRelief
    -offvalue, offValue, Value
    -onvalue, onValue, Value
    -overrelief, overRelief, OverRelief
    -selectcolor, selectColor, Background
    -selectimage, selectImage, SelectImage
    -state, state, State
    -tristateimage, tristateImage, TristateImage
    -tristatevalue, tristateValue, Value
    -variable, variable, Variable
    -width, width, Width
  説明 DESCRIPTION
  部品命令 WIDGET COMMAND
    pathName cget option
    pathName configure ?option? ?value option value ...?
    pathName deselect
    pathName flash
    pathName invoke
    pathName select
    pathName toggle
  束縛 BINDINGS
  用例 EXAMPLE
  SEE ALSO
  KEYWORDS

### NAME

checkbutton — '点検釦' の論理値選択部品の生成と操作 Create and manipulate 'checkbutton' boolean selection widgets

### 構文 SYNOPSIS

checkbutton pathName ?options?

### STANDARD OPTIONS

-activebackground, activeBackground, Foreground
-activeforeground, activeForeground, Background
-anchor, anchor, Anchor
-background or -bg, background, Background
-bitmap, bitmap, Bitmap
-borderwidth or -bd, borderWidth, BorderWidth
-compound, compound, Compound
-cursor, cursor, Cursor
-disabledforeground, disabledForeground, DisabledForeground
-font, font, Font
-foreground or -fg, foreground, Foreground
-highlightbackground, highlightBackground, HighlightBackground
-highlightcolor, highlightColor, HighlightColor
-highlightthickness, highlightThickness, HighlightThickness
-image, image, Image
-justify, justify, Justify
-padx, padX, Pad
-pady, padY, Pad
-relief, relief, Relief
-takefocus, takeFocus, TakeFocus
-text, text, Text
-textvariable, textVariable, Variable
-underline, underline, Underline
-wraplength, wrapLength, WrapLength

### 部品固有の指示項目　WIDGET-SPECIFIC OPTIONS

Command-Line Name: -command
Database Name: command
Database Class: Command
  釦に結合させる Tcl 命令を指定する｡この命令は典型的には釦窓に重ねたマウス釦 1 を離すと起動される｡その釦の大域変数(-variable 指示項目)は命令が起動される前に更新される｡ 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 (-variable option) will be updated before the command is invoked.

Command-Line Name: -height
Database Name: height
Database Class: Height
  釦の為の望ましい縦寸法を指定する｡もし釦の中に影像か点地図が展示されている場合､値は画面単位である(即ち､ Tk_GetPixels に受入れられるどの形式でもよい); 文書では文書の行数を単位にする｡この指示項目が指定されないと､釦の望ましい縦寸法は其処に展示されている影像か点地図か文書の寸法から計算される｡ 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 Tk_GetPixels); 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.

Command-Line Name: -indicatoron
Database Name: indicatorOn
Database Class: IndicatorOn
  指示器を描くか否かを指定する｡適切な論理値でなければならない｡偽値の場合には､ -relief 指示項目は無視され､部品が選択されている時に部品の立体感は常に窪み､それ以外は突出になる｡ 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.

Command-Line Name: -offrelief
Database Name: offRelief
Database Class: OffRelief
  検査釦について指示器が描かれず且つ検査釦が断の時の立体感を指定する｡省略時設定は “raised(突出)” である｡この指示項目を “平坦” に設定し且つ -indicatoron を偽値に､ -overrelief を “raised(突出)” に設定することにより､マウスを重ねることにより突出し､活性な時には抑制されるという効果を有する平坦な釦が得られる｡これは､譬えば､ワープロの便利機能帯上の太文字､斜体文字､下線文字の検査釦に典型的に現れる振舞いである｡ 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.

Command-Line Name: -offvalue
Database Name: offValue
Database Class: Value
  何時であれ､この釦が非選択であるときに､この釦に結合している変数内に保存する値を指定する｡省略時設定は “0” である｡ 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
  何時であれ､この釦が選択されているときに､この釦に結合している変数内に保存する値を指定する｡省略時設定は “1” ｡ 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
  マウスの遊走子が部品に重なった時に使う為の､代理用の立体感を指定する｡この指示項目は､ -relief flat-overreliefraised を構成設定することにより､便利機能帯作成に使用することができる｡もしこの指示項目の値が空文字列であると､マウスの遊走子が検査釦に重なった時に代理の立体感は使われない｡空文字列が省略時設定である｡ 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 -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.

Command-Line Name: -selectcolor
Database Name: selectColor
Database Class: Background
  釦が選択された時の背景色を指定する｡もし indicatorOn が真値であると､その色は選択状態を考慮することなく指示器の為の背景色として使用される｡もし indicatorOn が偽値であると､この色は､部品が選択された時は何時であっても background や activeBackground の代りに部品全体の背景として使用される｡もし､空文字列として指定されると部品が選択された時に特別な色は使用されない｡ Specifies a background color to use when the button is selected. If indicatorOn is true then the 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 displaying when the widget is selected.

Command-Line Name: -selectimage
Database Name: selectImage
Database Class: SelectImage
  検査釦が選択された時に展示する影像を( -image 指示項目に代わって)指定する｡この指示項目は -image 指示項目が指定されない限り無視される｡ 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.

Command-Line Name: -state
Database Name: state
Database Class: State
  検査釦に関する三つの内の一つの状態を指定する: normal か active か disabled ｡通常状態では､検査釦は -foreground and -background 指示項目を使用して展示される｡活性状態は典型的には指示子が検査釦に重なった時に使用する｡活性状態では､検査釦は -activeforeground と -activebackground 指示項目を使用して展示される｡不能状態とは検査釦が無反応であることを意味する: 省略時設定の束縛では､部品を活性化することを拒否し､マウス釦の押下を無視する｡この状態では -disabledforeground と -background 指示項目が検査釦を如何に展示するかを決定する｡ Specifies one of three states for the checkbutton: normal, active, or disabled. In normal state the checkbutton is displayed using the -foreground 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 -background options determine how the checkbutton is displayed.

Command-Line Name: -tristateimage
Database Name: tristateImage
Database Class: TristateImage
  検査釦が三項状態の様式の時に展示する影像を( -image 指示項目に代わって)指定する｡この指示項目は -image 指示項目が指定されない限り無視される｡ Specifies an image to display (in place of the -image option) when the checkbutton is in tri-state mode. This option is ignored unless the -image option has been specified.

Command-Line Name: -tristatevalue
Database Name: tristateValue
Database Class: Value
  検査釦が､多数-値選択､又は､三項状態の状態として知られる状態を展示することを引起す値を指定する｡省略時設定は “” ｡ Specifies the value that causes the checkbutton to display the multi-value selection, also known as the tri-state mode. Defaults to “”.

Command-Line Name: -variable
Database Name: variable
Database Class: Variable
  この釦が､選択されたか否かを指し示す大域変数の名前を指定する｡省略時設定はその親の内部の釦の名前(即ち､釦窓の経路の最後の要素)｡ Specifies the name of a 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
  釦に対して望ましい幅を指定する｡もし影像か点地図が釦の中に展示されている場合､値は画面単位である(即ち､ Tk_GetPixels に受入れられるどの形式でもよい); 文書では文書の文字数を単位にする｡もしこの指示項目が指定されないと､釦の望ましい幅は其処に展示されている影像か点地図か文書の寸法から計算される｡ 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 is not specified, the button's desired width is computed from the size of the image or bitmap or text being displayed in it.

### 説明 DESCRIPTION

この checkbutton 命令は新しい窓を生成し( pathName 引数を与えられて)､それを検査釦部品にする｡上に記述した追加的な指示項目は､命令行上で､あるいは指示項目基本データとして検査釦の概観､譬えば､色､文字形状､文書､初期立体感を､構成設定する為に指定されるかもしれない｡この checkbutton 命令はその pathName 引数を返す｡この命令が起動される時､ pathName の名前の窓が存在してはならないが､ pathName の親が実在していなければならない｡　　　 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.

検査釦は部品であって､文書文字列､点地図や影像､indicator と呼ばれる四角を展示する｡もし文字列が表示されていると､全て同じ文字形を使わねばならない､しかし画面上の多行を占めてもよく(改行が含まれている場合か､ -wraplength 指示項目による折返しが発生した場合)､ -underline 指示項目を使用して一つの文字に下線を引く選択もできる｡検査釦は次のことを含む､単純な釦の全ての振舞いを有す: 自身を､ -state 指示項目に従って､三つの違う方法で展示できる; 外見を突出､窪み､平坦にでき; 閃めきさせられる; 又､いつであれ､検査釦の上でマウス釦1 を軽叩するとTcl 命令が起動する｡ 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 the -underline 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 command whenever mouse button 1 is clicked over the checkbutton.

更に検査釦は選択されることができる｡もし検査釦が選択されると､表示器が通常､選択の外観で描かれ､そして､検査釦に結合した Tcl 変数が特定の値(通常は 1)に設定される｡表示器は検査印を内側に伴って描かれる｡もし検査釦が選択されていないと､表示器は非選択の外観で現れ､そして結合した変数は異なる値に設定される(典型的には 0)｡表示器は検査印を内側に伴わずに描かれる｡特別の場合には､そこでは変数は(もし指定されると)三重状態値に合致する､表示器は三肢状態の外観で描かれ又三肢状態の様式は混合又は多重の値を指し示す｡(これは多重の品目を表現する検査箱を表現する時に使われる｡) 表示器はOSに依存した方法で描かれる｡ Unix と Windows の下では箱の中の背景は “灰色化” である｡ Mac では､表示器は破線印の内側に描かれる｡省略時設定では､検査釦に結合した変数の名前は name として検査釦の生成に使われたものと同じである｡変数の名前､その中に保存された “接” と “断” と “三肢状態” の値は命令行の指示項目を使用して､ 又は指示項目基本データとして修正することもできる｡構成設定指示項目は表示器が展示される方法の修正に使用できる(又は､全て展示するか否か)｡省略時設定では､検査釦は代わりの釦の軽叩により自身を選択するか非選択するかについては構成設定される｡更に､それぞれの検査釦は変数の値の変化と､釦の “接” と, “断” と “三肢状態” の値からから変化する時にその結合した変数と自動的に､自身が選択問非選択であるかを監視する｡ 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). 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 “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 name used to create the checkbutton. 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. 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 “on”, “off” and “tristate” values.

### 部品命令 WIDGET COMMAND

この checkbutton 命令は名前が pathName の新しい Tcl 命令を生成する｡この命令は部品についての種々の操作の起動に使用できる｡それは､次の一般形式を有する: The 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 と args は命令の正確な振舞いを定める｡次の命令が検査釦部品について可能である: Option and the args determine the exact behavior of the command. The following commands are possible for checkbutton widgets:

pathName cget option
  option によって与えられた構成設定指示項目の現在の値を返す｡ option は checkbutton 命令に受入れられるどの様な値でも取り得る｡ 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 ...?
  部品の構成設定指示項目の値を問合せ又は修正する｡もし value なしで option が指定されると､本命令は option の名前のものを記述したリストを返す(このリストは option の指定なしで返った値の該当箇所の小リストに等しい)｡ value なしで option を指定すると､その名前の指示項目を記述したリストが返る(このリストは､ option を指定しない時に返るリストの部分リストになっている)｡もし､一つ或はそれ以上のoption-value 対が指定されると､命令は､与えられた指示項目を与えられた値に修正する; この場合､命令は空文字列を返す｡ option は checkbutton 命令が受入れるどの値を有していてもよい｡ 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 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
  使用者がマウス釦によって検査釦を起動した場合に生じるであろうことを行う: 釦の選択状態を巡回的に切替え､検査釦に結合した Tcl 命令がもし１つならば起動する｡返り値はTcl 命令からの返り値か､検査釦に結合した命令がない場合には､空文字列である｡この命令は検査釦の状態が無能であると無視される｡ 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 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 は級束縛を自動的に生成する､それが省略時の振舞いを与える: Tk automatically creates class bindings for checkbuttons that give them the following default behavior:

1. Unix 系上では検査釦は何時であれ､マウスがその上をよぎると活性になり､何時であれ､マウスが離れると非選択になる｡Mac と Windows 系上では､検査釦の上でマウス釦 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. 検査釦に重ねてマウス釦 1 が押されると､それが起動される(その選択状態は巡回的に変化し､釦に結合した命令があれば起動される)｡ 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. 検査釦が入力の注目を有していると､スペース鍵が検査釦を起動させる｡ Windows の下では､他にも鍵の束縛があり; plus (+) と equal (=) は釦を選択にし､minus (-) は釦を非選択にする｡ 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.

もし検査釦の状態が disabled であると､上の活動は起らない: 検査釦は完全に非感受性である｡ 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.

### 用例 EXAMPLE

この例は､一群の結合していない検査釦を例示する｡ This example shows a group of uncoupled checkbuttons.

    labelframe .lbl -text "Steps:"
    checkbutton .c1 -text Lights  -variable lights
    checkbutton .c2 -text Cameras -variable cameras
    checkbutton .c3 -text Action! -variable action
    pack .c1 .c2 .c3 -in .lbl
    pack .lbl

### SEE ALSO

button, options, radiobutton, ttk::checkbutton

### KEYWORDS

checkbutton, widget
Copyright © 1990-1994 The Regents of the University of California.
Copyright © 1994-1996 Sun Microsystems, Inc.