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

### 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
    scrollbar — 摺動制御と表示用部品の '摺動盤' を創生し操作する Create and manipulate 'scrollbar' scrolling control and indicator widgets
  構文 SYNOPSIS
  STANDARD OPTIONS
    -activebackground, activeBackground, Foreground
    -background or -bg, background, Background
    -borderwidth or -bd, borderWidth, BorderWidth
    -cursor, cursor, Cursor
    -highlightbackground, highlightBackground, HighlightBackground
    -highlightcolor, highlightColor, HighlightColor
    -highlightthickness, highlightThickness, HighlightThickness
    -jump, jump, Jump
    -orient, orient, Orient
    -relief, relief, Relief
    -repeatdelay, repeatDelay, RepeatDelay
    -repeatinterval, repeatInterval, RepeatInterval
    -takefocus, takeFocus, TakeFocus
    -troughcolor, troughColor, Background
  部品固有の指示項目 WIDGET-SPECIFIC OPTIONS
    -activerelief, activeRelief, ActiveRelief
    -command, command, Command
    -elementborderwidth, elementBorderWidth, BorderWidth
    -width, width, Width
  説明 DESCRIPTION
  要素 ELEMENTS
    矢印1 arrow1
    摺動溝1 trough1
    摺動摘まみ slider
    摺動溝2 trough2
    矢印2 arrow2
  部品命令 WIDGET COMMAND
    pathName activate ?element?
    pathName cget option
    pathName configure ?option? ?value option value ...?
    pathName delta deltaX deltaY
    pathName fraction x y
    pathName get
    pathName identify x y
    pathName set first last
  SCROLLING COMMANDS
    prefix moveto fraction
    prefix scroll number pages
    prefix scroll number units
  BINDINGS
  用例 EXAMPLE
  SEE ALSO
  KEYWORDS

### NAME

scrollbar — 摺動制御と表示用部品の '摺動盤' を創生し操作する Create and manipulate 'scrollbar' scrolling control and indicator widgets

### 構文 SYNOPSIS

scrollbar pathName ?options?

### STANDARD OPTIONS

-activebackground, activeBackground, Foreground
-background or -bg, background, Background
-borderwidth or -bd, borderWidth, BorderWidth
-cursor, cursor, Cursor
-highlightbackground, highlightBackground, HighlightBackground
-highlightcolor, highlightColor, HighlightColor
-highlightthickness, highlightThickness, HighlightThickness
-jump, jump, Jump
-orient, orient, Orient
-relief, relief, Relief
-repeatdelay, repeatDelay, RepeatDelay
-repeatinterval, repeatInterval, RepeatInterval
-takefocus, takeFocus, TakeFocus
-troughcolor, troughColor, Background

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

Command-Line Name: -activerelief
Database Name: activeRelief
Database Class: ActiveRelief
  活動中の要素を表示する時に使う立体感を指定する｡活動中でない要素は常に突出した立体感で表示される｡ Specifies the relief to use when displaying the element that is active, if any. Elements other than the active element are always displayed with a raised relief.

Command-Line Name: -command
Database Name: command
Database Class: Command
  摺動盤に結合した部品の視野を変更するために起動する Tcl 命令の接頭辞を指定する｡使用者が摺動盤を操作することにより視野の変更を要求する時､ Tcl 命令が起動される｡実際の命令は､後述の様に､追加情報が後に着いたこの指示項目で構成される｡この指示項目は殆ど常に .t xview や .t yview の様に､部品の名前と xview (水平方向の摺動盤の場合)か yview (垂直摺動)から構成される値を有する｡全ての摺動可能な部品は xview か yview 命令を有し､下の SCROLLING COMMANDS 内で記述される様に､それは正確に､摺動盤により追記される追加的な引数を採る｡ Specifies the prefix of a Tcl command to invoke to change the view in the widget associated with the scrollbar. When a user requests a view change by manipulating the scrollbar, a Tcl command is invoked. The actual command consists of this option followed by additional information as described later. This option almost always has a value such as .t xview or .t yview, consisting of the name of a widget and either xview (if the scrollbar is for horizontal scrolling) or yview (for vertical scrolling). All scrollable widgets have xview and yview commands that take exactly the additional arguments appended by the scrollbar as described in SCROLLING COMMANDS below.

Command-Line Name: -elementborderwidth
Database Name: elementBorderWidth
Database Class: BorderWidth
  摺動盤の内部の要素(二つの矢印と摺動摘まみ)の周りに描かれる境界の幅を指定する｡値は Tk_GetPixels に受入可能な､どの形式を有してもよい｡もしこの値が零より小さいと､ -borderWidth 指示項目の値がこの箇所に使用される｡ Specifies the width of borders drawn around the internal elements of the scrollbar (the two arrows and the slider). The value may have any of the forms acceptable to Tk_GetPixels. If this value is the empty string (the default), the value of the -borderwidth option is used in its place.

Command-Line Name: -width
Database Name: width
Database Class: Width
  摺動盤の窓の好ましい狭い寸法を指定する､立体的な縁はもしあっても含まない｡垂直の摺動盤に就いては､これは幅､水平摺動盤に就いては､これは丈である｡値は Tk_GetPixels に受入可能などの形式でも有してよい｡ Specifies the desired narrow dimension of the scrollbar window, not including 3-D border, if any. For vertical scrollbars this will be the width and for horizontal scrollbars this will be the height. The value may have any of the forms acceptable to Tk_GetPixels.

### 説明 DESCRIPTION

scrollbar 命令は(pathName 引数によって与えられる)新しい窓を生成し､それを摺動盤部品にする｡上に述べられた追加的な指示項目は命令行或は､その色や方向や立体感の様な摺動盤の外観を構成設定する追加的な基礎データの中で指定される｡scrollbar 命令はその pathName 引数を返す｡この命令が起動された時､ pathName の名前の窓が存在してはならないが､pathName の親は実在しなければならない｡ The scrollbar command creates a new window (given by the pathName argument) and makes it into a scrollbar widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the scrollbar such as its colors, orientation, and relief. The scrollbar 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 scrollbar is a widget that displays two arrows, one at each end of the scrollbar, and a slider in the middle portion of the scrollbar. It provides information about what is visible in an associated window that displays a document of some sort (such as a file being edited or a drawing). The position and size of the slider indicate which portion of the document is visible in the associated window. For example, if the slider in a vertical scrollbar covers the top third of the area between the two arrows, it means that the associated window displays the top third of its document.

マウスの軽叩や曳摺りによって､摺動盤は､結合した窓内の視野を調整する為に使用できる｡詳細は下の BINDINGS 章を参照されたい｡ Scrollbars can be used to adjust the view in the associated window by clicking or dragging with the mouse. See the BINDINGS section below for details.

### 要素 ELEMENTS

摺動盤は５つの要素を表示する､それは摺動盤の為の部品命令内で参照される: A scrollbar displays five elements, which are referred to in the widget commands for the scrollbar:

矢印1 arrow1
  摺動盤の上端又は左端の矢印｡ The top or left arrow in the scrollbar.

摺動溝1 trough1
  摺動摘まみと矢印1 との間の領域｡ The region between the slider and arrow1.

摺動摘まみ slider
  結合している部品内の可視部を指し示す矩形｡ The rectangle that indicates what is visible in the associated widget.

摺動溝2 trough2
  摺動摘まみと 矢印2 との間の領域｡ The region between the slider and arrow2.

矢印2 arrow2
  摺動盤の下端又は左端の矢印｡ The bottom or right arrow in the scrollbar.

### 部品命令 WIDGET COMMAND

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

pathName activate ?element?
  element によって指し示される要素を活性として徴を附す､それにより -activeBackground と activeRelief 指示項目によって指し示されたように表示されることを惹き起す｡この命令によって認識される要素の値は 矢印1 か 摺動摘まみ か 矢印2 だけである｡もしこれ以外のどの値が指定された場合も､摺動盤のどの要素も活性化されない｡もし element が指定されない場合､この命令は現在活性な要素の名前を返すか､どの要素も活性ではない場合､空文字列を返す｡ Marks the element indicated by element as active, which causes it to be displayed as specified by the -activebackground and -activerelief options. The only element values understood by this command are arrow1, slider, or arrow2. If any other value is specified then no element of the scrollbar will be active. If element is not specified, the command returns the name of the element that is currently active, or an empty string if no element is active.

pathName cget option
  option で与えられる構成設定指示項目の現在の値を返す｡ option は scrollbar 命令によって受入られるどのような値を有していてもよい｡ Returns the current value of the configuration option given by option. Option may have any of the values accepted by the scrollbar command.

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

pathName delta deltaX deltaY
  与えられた摺動摘まみの位置の変更に相当する摺動盤内の設定の変更の割合を指し示す実数を返す｡譬えば､もし摺動盤が水平の場合､結果は摺動摘まみを右に deltaX 画素移動する為に､摺動盤の設定が如何に多く必要かを指し示す(この場合 deltaY は無視される)｡もし摺動盤が垂直の場合､結果は摺動摘まみを下に deltaY 画素移動する為に､摺動盤の設定が如何に多く必要かを指し示す｡引数と結果は零か負数でもよい｡ Returns a real number indicating the fractional change in the scrollbar setting that corresponds to a given change in slider position. For example, if the scrollbar is horizontal, the result indicates how much the scrollbar setting must change to move the slider deltaX pixels to the right (deltaY is ignored in this case). If the scrollbar is vertical, the result indicates how much the scrollbar setting must change to move the slider deltaY pixels down. The arguments and the result may be zero or negative.

pathName fraction x y
  摺動盤の摺動溝内の x と y で与えられた位置を指し示す 0 と 1 の間の実数を返す｡値 0 は摺動溝の頂又は左に相当し､値 1 は底又は右に相当する､ 0.5 は中央に相当し､以下同様である｡ x と y は摺動盤部品に相対的な画素座標である｡もし x と y が摺動溝の外の位置を参照すると摺動溝内の最も近い位置が使われる｡ Returns a real number between 0 and 1 indicating where the point given by x and y lies in the trough area of the scrollbar. The value 0 corresponds to the top or left of the trough, the value 1 corresponds to the bottom or right, 0.5 corresponds to the middle, and so on. X and y must be pixel coordinates relative to the scrollbar widget. If x and y refer to a point outside the trough, the closest point in the trough is used.

pathName get
  摺動盤の設定をリストの形式にして返す､その要素は最も最近の set 部品命令の引数である｡ Returns the scrollbar settings in the form of a list whose elements are the arguments to the most recent set widget command.

pathName identify x y
  x と y で与えられた位置にある要素の名前を返す( 矢印1 の如く)か､もしその点が摺動盤のどの要素もない場合空文字列を返す｡ x と y は摺動盤部品に相対的な画素座標でなければならない｡ Returns the name of the element under the point given by x and y (such as arrow1), or an empty string if the point does not lie in any element of the scrollbar. X and y must be pixel coordinates relative to the scrollbar widget.

pathName set first last
  この命令は摺動盤に結合した部品によって起動され､部品内の現在の視野を摺動盤に伝える｡この命令は二つの引数をとり､それぞれは 0 と 1 の間の実小数である｡小数は文章の範囲を記述し､それは結合した部品内の可視部である｡譬えば､ first が 0.2 で last が 0.4 であると､文書の窓内に可視の最初の部位は文書の全体の 20% の処であり､可視の最後の部位は全体の 40% のところである｡ This command is invoked by the scrollbar's associated widget to tell the scrollbar about the current view in the widget. The command takes two arguments, each of which is a real fraction between 0 and 1. The fractions describe the range of the document that is visible in the associated widget. For example, if first is 0.2 and last is 0.4, it means that the first part of the document visible in the window is 20% of the way through the document, and the last visible part is 40% of the way through.

### SCROLLING COMMANDS

譬えば摺動摘まみの曳摺りにより使用者が摺動盤に対話的に指示する時､摺動盤は結合した部品に視野の変更が必要である事を知らせる｡摺動盤は摺動盤の -command 指示項目により生成した Tcl 命令の評価により通知する｡その命令は次のどれかの形式をとる｡それぞれの場合 prefix は -command 指示項目の中身であり､通常 “.t”yview の様な形式を有する｡ When the user interacts with the scrollbar, for example by dragging the slider, the scrollbar notifies the associated widget that it must change its view. The scrollbar makes the notification by evaluating a Tcl command generated from the scrollbar's -command option. The command may take any of the following forms. In each case, prefix is the contents of the -command option, which usually has a form like “.t yview”.

prefix moveto fraction
  fraction は 0 と 1 の間の 実数である｡部品は部品の初めの位置から fraction で与えられた位置に表される様に視野を調整する｡もし fraction が 0 である場合､それは文章の初めを参照する｡ 1.0 は文章の末尾を参照し､ 0.333 は文章全体の三分の一の点を参照し､その他の数値でも同様な具合である｡ Fraction is a real number between 0 and 1. The widget should adjust its view so that the point given by fraction appears at the beginning of the widget. If fraction is 0 it refers to the beginning of the document. 1.0 refers to the end of the document, 0.333 refers to a point one-third of the way through the document, and so on.

prefix scroll number pages
  部品は number の頁だけ視野を調整する｡頁の意味の定義は部品による; 典型的には窓に嵌るより僅かに小さく設定されているので､旧視野と新視野は僅かに重複する｡ number は1 か -1 で､ 1 では､次の頁が可視になり､ -1 では､前の頁が可視になる｡ 端数の数は､0から遠い方向に丸められる､従って､ 0.001 頁の摺動は､1頁の摺動と同じ効果を有す｡ The widget should adjust its view by number pages. It is up to the widget to define the meaning of a page; typically it is slightly less than what fits in the window, so that there is a slight overlap between the old and new views. Number is either 1, which means the next page should become visible, or -1, which means that the previous page should become visible. Fractional numbers are rounded away from 0, so scrolling 0.001 pages has the same effect as scrolling 1 page.

prefix scroll number units
  部品はその視野をnumber単位で調整すべきである｡ 単位は､その部品に関して意味付けするどの様な方法であれ､ 文書部品内の文字や行の様に定義される｡ number は､1又は-1であって､ 前者は､一単位が窓の頂や左に摺動し切ることを意味し､ 後者は､ その意味は､一単位が窓の底や右に摺動し切ることを意味する｡ 端数の数は､0から遠い方向に丸められる､従って､ 0.001 単位の摺動は､1単位の摺動と同じ効果を有す｡ The widget should adjust its view by number units. The units are defined in whatever way makes sense for the widget, such as characters or lines in a text widget. Number is either 1, which means one unit should scroll off the top or left of the window, or -1, which means that one unit should scroll off the bottom or right of the window. Fractional numbers are rounded away from 0, so scrolling 0.001 units has the same effect as scrolling 1 unit.

### BINDINGS

Tk は自動的に摺動盤の為に級束縛を作成する､それは次の省略時設定の挙動を与える｡もし垂直と水平の摺動盤の間で挙動が異なる場合､水平の挙動は括弧の中に記述する｡ Tk automatically creates class bindings for scrollbars that give them the following default behavior. If the behavior is different for vertical and horizontal scrollbars, the horizontal behavior is described in parentheses.

1. 矢印1 の上での釦 1 の押下は､結合されている窓内の視野を上(左)に１単位移動させ､文章を１単位下(右)に移動させる｡もし釦が押されたまま保持されると､自動的に動作が繰返される｡ Pressing button 1 over arrow1 causes the view in the associated widget to shift up (left) by one unit so that the document appears to move down (right) one unit. If the button is held down, the action auto-repeats.

2. 摺動溝1 の上での釦 1 の押下は､結合されている窓内の視野を上(左)に１画面幅移動させ､文章を１画面幅下(右)に移動させる｡もし釦が押されたまま保持されると､自動的に動作が繰返される｡ Pressing button 1 over trough1 causes the view in the associated widget to shift up (left) by one screenful so that the document appears to move down (right) one screenful. If the button is held down, the action auto-repeats.

3. 摺動摘まみ上で釦 1 を押下して曳摺ると視野は摺動摘まみとともに曳摺りを生じる｡もし jump 指示項目が真値の場合は､視野は摺動摘まみと供には曳摺られない; マウス釦を離した時にのみ変化する｡ Pressing button 1 over the slider and dragging causes the view to drag with the slider. If the jump option is true, then the view does not drag along with the slider; it changes only when the mouse button is released.

4. 摺動溝2 の上での釦 1 の押下は､結合されている部品の視野を下(右)に１画面幅移動させ､文章を１画面幅上(左)に移動させる｡もし釦が押されたまま保持されると､自動的に動作が繰返される｡ Pressing button 1 over trough2 causes the view in the associated widget to shift down (right) by one screenful so that the document appears to move up (left) one screenful. If the button is held down, the action auto-repeats.

5. 矢印2 の上での釦 1 の押下は､結合されている部品の視野を下(右)に１単位幅移動させ､文章を１単位上(左)に移動させる｡もし釦が押されたまま保持されると､自動的に動作が繰返される｡ Pressing button 1 over arrow2 causes the view in the associated widget to shift down (right) by one unit so that the document appears to move up (left) one unit. If the button is held down, the action auto-repeats.

6. 摺動溝又は摺動摘まみ上で釦 2 押下すると､視野をマウスの位置に対応して設定する; 釦 2 を押下して曳摺ると視野はマウスとともに曳摺りを生じる｡もし釦 2 がどちらかの矢印の上で押されると釦 1 の押下と同じ挙動を惹起す｡ If button 2 is pressed over the trough or the slider, it sets the view to correspond to the mouse position; dragging the mouse with button 2 down causes the view to drag with the mouse. If button 2 is pressed over one of the arrows, it causes the same behavior as pressing button 1.

7. もし Ctrl 鍵の押下と供に釦 1 が押されると､もしマウス釦が 矢印1 か 摺動溝1 の上であった場合､視野は文書の丁度上(左)に変化する; もしマウス釦が 矢印2 か 摺動溝2 の上であった場合､視野は文書の丁度下(右)に変化する; マウスがそれ以外のどこかにあると釦の押下は何も効果を有さない｡ If button 1 is pressed with the Control key down, then if the mouse is over arrow1 or trough1 the view changes to the very top (left) of the document; if the mouse is over arrow2 or trough2 the view changes to the very bottom (right) of the document; if the mouse is anywhere else then the button press has no effect.

8. 垂直摺動盤内で上向き鍵と下向き鍵は､それぞれ 矢印1 と 矢印2 の上のマウスの軽叩と同じ振舞いを有する｡水平摺動盤内ではこれらの鍵は効果を持たない｡ In vertical scrollbars the Up and Down keys have the same behavior as mouse clicks over arrow1 and arrow2, respectively. In horizontal scrollbars these keys have no effect.

9. 垂直摺動盤内で Ctrl -上向き鍵と Ctrl -下向き鍵は､それぞれ 摺動溝1 と 摺動溝2 の上のマウスの軽叩と同じ振舞いを有する｡水平摺動盤内ではこれらの鍵は効果を持たない｡ In vertical scrollbars Control-Up and Control-Down have the same behavior as mouse clicks over trough1 and trough2, respectively. In horizontal scrollbars these keys have no effect.

10. 水平摺動盤内で上向き鍵と下向き鍵は､それぞれ 矢印1 と 矢印2 の上のマウスの軽叩と同じ振舞いを有する｡垂直摺動盤内ではこれらの鍵は効果を持たない｡ In horizontal scrollbars the Up and Down keys have the same behavior as mouse clicks over arrow1 and arrow2, respectively. In vertical scrollbars these keys have no effect.

11. 水平摺動盤内で Ctrl -上向き鍵と Ctrl -下向き鍵は､それぞれ 摺動溝1 と 摺動溝2 の上のマウスの軽叩と同じ振舞いを有する｡垂直摺動盤内ではこれらの鍵は効果がない｡ In horizontal scrollbars Control-Up and Control-Down have the same behavior as mouse clicks over trough1 and trough2, respectively. In vertical scrollbars these keys have no effect.

12. 水平摺動盤内で Prior 鍵と Next 鍵は､それぞれ 摺動溝1 と 摺動溝2 の上のマウスの軽叩と同じ振舞いを有する｡ The Prior and Next keys have the same behavior as mouse clicks over trough1 and trough2, respectively.

13. Home 鍵は､文章の視野が頂(左端)になる様調整する｡ The Home key adjusts the view to the top (left edge) of the document.

14. End 鍵は､文章の視野が底(右端)になる様調整する｡ The End key adjusts the view to the bottom (right edge) of the document.

### 用例 EXAMPLE

摺動可能な text 部品の窓を作る Create a window with a scrollable text widget:

    toplevel .tl
    text .tl.t -yscrollcommand {.tl.s set}
    scrollbar .tl.s -command {.tl.t yview}
    grid .tl.t .tl.s -sticky nsew
    grid columnconfigure .tl 0 -weight 1
    grid rowconfigure .tl 0 -weight 1

### SEE ALSO

ttk::scrollbar

### KEYWORDS

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