## Tcl9.0.3/Tk9.0.3 Documentation > Tk Commands > button

### 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
    button — '釦' 動作部品の生成と操作 Create and manipulate 'button' action 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
    -repeatdelay, repeatDelay, RepeatDelay
    -repeatinterval, repeatInterval, RepeatInterval
    -takefocus, takeFocus, TakeFocus
    -text, text, Text
    -textvariable, textVariable, Variable
    -underline, underline, Underline
    -wraplength, wrapLength, WrapLength
  部品固有の指定項目 WIDGET-SPECIFIC OPTIONS
    -command, command, Command
    -default, default, Default
    -height, height, Height
    -overrelief, overRelief, OverRelief
    -state, state, State
    -width, width, Width
  説明 DESCRIPTION
  部品命令 WIDGET COMMAND
    pathName cget option
    pathName configure ?option? ?value option value ...?
    pathName flash
    pathName invoke
  省略時設定の束縛 DEFAULT BINDINGS
  OS 関連の註意事項 PLATFORM NOTES
  用例 EXAMPLES
  SEE ALSO
  KEYWORDS

### NAME

button — '釦' 動作部品の生成と操作 Create and manipulate 'button' action widgets

### 構文 SYNOPSIS

button 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
-repeatdelay, repeatDelay, RepeatDelay
-repeatinterval, repeatInterval, RepeatInterval
-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 が離された時に起動される｡ Specifies a Tcl command to associate with the button. This command is typically invoked when mouse button 1 is released over the button window.

Command-Line Name: -default
Database Name: default
Database Class: Default
  省略時設定の文字列について三つの状態の内の一つを指定する: normal か active かdisabled ｡活動状態では､釦は､OS固有の省略時設定の釦用の外観で描かれる｡通常状態では､釦は､省略時設定の釦の外観を描くに足る十分な場所を残して､OS固有の非省略時設定の釦用の外観で描かれる｡通常状態と活動状態では結果として､同じ寸法の釦になる｡不能状態では､釦は､非省略時設定の釦用の外観で､省略時設定の外観用の場所を残さずに描かれる｡不能状態では結果として､活動状態よりも小さい釦になるかもしれない｡ Specifies one of three states for the default ring: normal, active, or disabled. In active state, the button is drawn with the platform specific appearance for a default button. In normal state, the button is drawn with the platform specific appearance for a non-default button, leaving enough space to draw the default button appearance. The normal and active states will result in buttons of the same size. In disabled state, the button is drawn with the non-default button appearance without leaving space for the default appearance. The disabled state may result in a smaller button than the active state.

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: -overrelief
Database Name: overRelief
Database Class: OverRelief
  マウスの遊走子が部品に重なった時に使用される釦の為の交替の立体感を指定する｡この指示項目は -relief flat -overrelief raised の構成設定により､道具帯釦の作成に使用できる｡この指示項目の値が空文字列の場合､マウスの遊走子が部品に重なった時に交替の立体感は使用されない｡空文字列が省略時設定である｡ Specifies an alternative relief for the button, 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 button. The empty string is the default value.

Command-Line Name: -state
Database Name: state
Database Class: State
  釦について三つの状態の内の一つを指定する: normal か active かdisabled ｡通常状態では､釦は -foreground と -background 指示項目を使用して展示する｡活動状態では､釦は -activeforeground と -activebackground 指示項目を使用して展示する｡無能状態では､釦は非感受性になり､省略時設定の束縛は部品の活性化を拒否し､マウス釦の押下を無視する｡この状態では disabledForeground と background 指示項目が釦が如何に展示されるかを決定する｡ Specifies one of three states for the button: normal, active, or disabled. In normal state the button is displayed using the -foreground and -background options. The active state is typically used when the pointer is over the button. In active state the button is displayed using the -activeforeground and -activebackground options. Disabled state means that the button 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 button is displayed.

Command-Line Name: -width
Database Name: width
Database Class: Width
  釦について望ましい幅を指定する｡もし釦に影像か点地図が展示されていると値は画面を単位にする(即ち､Tk_GetPixels が受付けるどれかの形式)｡ 文書の釦(影像なしか -compound none による)では文書札の為に､どれだけの場所を文字数で割当てるかを指定する｡もし､幅が負数であると､最小の幅を指定する｡もしこの指示項目が指定されないと､釦の望ましい幅は其処に展示される影像か点地図か文書の寸法から計算される｡ 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 a text button (no image or with -compound none) then the width specifies how much space in characters to allocate for the text label. If the width is negative then this specifies a minimum width. 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

button 命令は(与えられたpathName 引数によって)新しい窓を生成し､それを釦部品にする｡上に述べた追加的な指示項目は命令行や､その色､字形､文書､初期の立体感の様な釦の外観を構成設定する追加的な基礎データの中で指定される｡button 命令はそのpathName 引数を返す｡この命令が起動された時､ pathName の名前の窓が存在してはならないが､pathName の親は実在しなければならない｡ The button command creates a new window (given by the pathName argument) and makes it into a button widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the button such as its colors, font, text, and initial relief. The button 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.

釦は文書の文字列や､点地図や､図形を展示している部品である｡もし文書が展示されていると､それは単一の字形のはずであるが､画面上の複数行を占めるかもしれない(改行印が含まれるか､ -wraplength 指示項目による単語末畳み込みが生じた場合)又､文字のどれか一つが -underline 指示項目を使って下線が引かれているかもしれない｡それ自身を -state 指示項目に従って三つの異なる方法で展示できる; 外観を､突出か､沈込みか､平坦か､にさせられる; 又､閃かせることもできる｡使用者が釦を起動した時(釦の上に覆さったマウス釦 1 を押すことによって)､ -command 指示項目内で指定した Tcl 命令が起動される｡ A button is a widget that displays a textual string, bitmap or image. 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. 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; and it can be made to flash. When a user invokes the button (by pressing mouse button 1 with the cursor over the button), then the Tcl command specified in the -command option is invoked.

### 部品命令 WIDGET COMMAND

button 命令は pathName と言う名前の新しい Tcl 命令を生成する｡この命令は部品上の種々の指示項目を起動する為に使うことができる｡それは次の一般式を有する: The button 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 ...?

option と arg は命令の正確な振舞いを定める｡次の命令が釦部品について可能である: Option and the args determine the exact behavior of the command. The following commands are possible for button widgets:

pathName cget option
  option で与えられる構成設定できる指示項目の値を返す｡ option はbutton 命令により受入れられるどの様な形式でもよい｡ Returns the current value of the configuration option given by option. Option may have any of the values accepted by the button command.

pathName configure ?option? ?value option value ...?
  部品の構成設定できる指示項目の値を問合せ又は修正する｡もし option が指定されないと､ pathName について利用できる全ての指示項目を記述したリストを返す(このリストの書式の情報については Tk_ConfigureInfo を参照されたい)｡もし value なしで option が指定されると､その名前の指示項目を記述したリストが返る(このリストは､ option を指定しない時に返るリストの部分リストになっている)｡もし､一つ或はそれ以上の option-value 対が指定されると､命令は､与えられた指示項目を与えられた値に修正する; この場合､命令は空文字列を返す｡ option はbutton 命令が受入れるどの値を有していてもよい｡ 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 button command.

pathName flash
  釦を閃かせる｡これは釦を構成設定された活性背景と背景の色の間を交替して数回再展示することで達成される｡釦が閃めいた終わりに命令が起動した時と同じ活性/通常状態にされる｡この命令は釦の状態が非感受性の状態の場合は無視される｡ Flash the button. This is accomplished by redisplaying the button several times, alternating between the configured activebackground and background colors. At the end of the flash the button is left in the same normal/active state as when the command was invoked. This command is ignored if the button's state is disabled.

pathName invoke
  釦に結合しているTcl 命令が起動する｡返り値は Tcl 命令から返る値か､釦に結合している命令がない場合は空文字列になる｡この命令は釦の状態が非感受性の状態の場合は無視される｡ Invoke the Tcl command associated with the button, 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 button. This command is ignored if the button's state is disabled.

### 省略時設定の束縛 DEFAULT BINDINGS

釦についてTk は級束縛を自動的に生成する､それが省略時の振舞いを与える: Tk automatically creates class bindings for buttons that give them default behavior:

1. マウスがその上を過る時は何時でも釦は活性になり､マウスが釦から離れると何時でも非活性になる｡Windowsでは､釦の上でマウス釦 1 が押された時にのみこの束縛が活性になる｡ A button activates whenever the mouse passes over it and deactivates whenever the mouse leaves the button. Under Windows, this binding is only active when mouse button 1 has been pressed over the button.

2. 釦の立体感は､マウス釦 1 が釦の上で押されると何時でも沈み込みに変化する､そして､立体感は後に釦 1 が離される時に元の値に再保存される｡ A button's relief is changed to sunken whenever mouse button 1 is pressed over the button, and the relief is restored to its original value when button 1 is later released.

3. もしマウス釦 1 が釦の上で押され､後に釦の上で離されると､その釦が起動される｡しかし､釦 1 が離された時にその釦上ではなかった場合は､起動は生じない｡ If mouse button 1 is pressed over a button and later released over the button, the button is invoked. However, if the mouse is not over the button when button 1 is released, then no invocation occurs.

4. 釦が入力の注目を有している時は､スペース鍵が釦の起動を起こす｡ When a button has the input focus, the space key causes the button to be invoked.

もし､釦の状態が無能の状態の場合は上記のどれも起らない: 釦は完全に非感受性である If the button's state is disabled then none of the above actions occur: the button is completely non-responsive.

釦の振舞いは個別の部品や級の束縛の再定義の為に新しい束縛を定義することにより変更可能である｡ The behavior of buttons can be changed by defining new bindings for individual widgets or by redefining the class bindings.

### OS 関連の註意事項 PLATFORM NOTES

Aqua/macOS 上では部品の描画の目的について､幾つかの構成設定指示項目は無視される､理由はOSの始動基準により別の衝突が起るためである｡ configure と cget 副命令は依然値を操作できるが､部品の外観の変化を惹き起こすことはない｡著しく効果を受ける指示項目には -background と -relief を含む｡ On Aqua/macOS, some configuration options are ignored for the purpose of drawing of the widget because they would otherwise conflict with platform guidelines. The configure and cget subcommands can still manipulate the values, but do not cause any variation to the look of the widget. The options affected notably include -background and -relief.

### 用例 EXAMPLES

これは古典的な Tk “こんにちは” の実演である: This is the classic Tk “Hello, World!” demonstration:

    button .b -text "Hello, World!" -command exit
    pack .b

この例は釦の加速機能を如何に処理するかを説明する: This example demonstrates how to handle button accelerators:

    button .b1 -text Hello -underline 0
    button .b2 -text World -underline 0
    bind . <Key-h> {.b1 flash; .b1 invoke}
    bind . <Key-w> {.b2 flash; .b2 invoke}
    pack .b1 .b2

### SEE ALSO

ttk::button

### KEYWORDS

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