NAME
  ListBox - 列挙箱部品 ListBox widget

CREATION
  ListBox pathName ?option value...?

標準の指示項目 STANDARD OPTIONS

  -background or -bg | -borderwidth or -bd
  -cursor | -highlightbackground
  -highlightcolor | -highlightthickness
  -relief | -selectbackground
  -selectforeground | -takefocus
  -xscrollcommand | -yscrollcommand

WIDGET-SPECIFIC OPTIONS

  -autofocus | -deltax | -deltay
  -dragenabled | -dragendcmd
  -dragevent | -draginitcmd
  -dragtype | -dropcmd
  -dropenabled | -dropovercmd
  -dropovermode | -droptypes
  -height | -multicolumn
  -padx | -redraw
  -selectfill | -selectmode | -width

部品命令 WIDGET COMMAND
  pathName bindImage event script
  pathName bindText event script
  pathName cget option
  pathName configure ?option? ?value option value ...?
  pathName delete ?arg...?
  pathName edit item text ?verifycmd? ?clickres? ?select?
  pathName exists item
  pathName index item
  pathName insert index item ?option value...?
  pathName item first ?last?
  pathName itemcget item option
  pathName itemconfigure item ?option? ?value option value ...?
  pathName items ?first? ?last?
  pathName move item index
  pathName reorder neworder
  pathName see item
  pathName selection cmd ?arg...?
  pathName xview ?arg...?
  pathName yview ?arg...?

説明 DESCRIPTION

列挙箱部品は品目のリストを展示する為に画布を使う｡それぞれの品目は､自身の字母を伴う札と､前景の属性と､追加的な影像か窓より構成される｡それぞれの品目は一列に描かれ､その丈はdeltay 指示項目によって定められ､従って高々この丈を有する筈である｡品目は通常生成時に与えらる文字列によって排他的に識別される(insert 命令による)｡列挙箱は multicolumn し指示項目によって､一つ或はそれ以上の欄を持ち得る｡使用者は欄を扱えない; 欄の数はそれぞれの品目を垂直に見る為の列挙箱の高さに従って決定される｡ ListBox widget uses canvas to display a list of items. Each item is composed of a label with its own font and foreground attributes, and an optional image or window. Each item is drawn in a single line, whose height is defined by the deltay option, so they must have at most this height. A item is uniquely identified by a string given at creation (by the insert command). The ListBox can have one or more columns, depending on multicolumn option. The user do not handle columns; the number of columns is determined following the height of the ListBox in order to see each item vertically.

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

-autofocus (read-only)
  もし､指示項目が真値であると､列挙箱は使用者が何時でもその中で軽叩する時に注目を得る｡注目無しでは､列挙箱のマウス環輪束縛は適切に働かない｡既定は真値｡ If this option is true, the listbox will take focus any time the user clicks in it. Without focus, the listbox's mouse wheel bindings will not work properly. The default is true.

-deltax
  それぞれの欄の間の水平充填を指定する｡ Specifies horizontal pad between each columns.

-deltay
  品目の垂直の寸法を指定する｡ Specifies vertical size of the items.

-dragenabled
  引き摺りが可能か否かを指定する論理値｡ A boolean specifying if drag is enabled.

-dragendcmd
  引き摺りが可能な時に呼出される命令を指定する｡ dragendcmd は DragSite::register の dragendcmd 指示項目の記述に適合する命令でなければならない｡ Specifies a command to be called when drag ended. dragendcmd must be a command conforming to the description of the option dragendcmd of DragSite::register.

-dragevent
  引き摺りに関連するマウス釦の番号を指定する｡1 か 2 か 3 でなければならない｡ 　 Specifies the number of the mouse button associated to the drag. Must be 1, 2 or 3.

-draginitcmd
  列挙箱は drag-init 行事に関する命令梱包がある｡この命令は節が全く設計されてないと引き摺りを拒否する｡それ以外の場合: ListBox has a command wrapper for drag-init events. This command refused the drag if no item is designated. In other cases:
  draginitcmd が空の場合､次を返す: If draginitcmd is empty, it returns:
  - データの型として､指示項目dragtype の値か､空の場合は LISTBOX_ITEM ｡ the value of option dragtype or LISTBOX_ITEM if empty as the data type,
  - 操作として{move copy link} ｡ {move copy link} as the operations,
  - データとして品目識別子｡ the item identifier as the data.
  もしdraginitcmd が空文字列の場合､次の引数と共に呼出される: If draginitcmd is not empty, it is called with the following arguments:
  - 列挙箱の経路名､ the pathname of the listbox,
  - 引き摺り品目の識別子､ the identifier of the dragged item,
  - 引き摺られたデータを表現する為に創生された頂上水準｡ the toplevel created to represent dragged data.
  更に､DragSite::register 内に記述された draginitcmd 指示項目に適合する値を返す筈である｡ and must return a value conforming to draginitcmd option described in DragSite::register.

-dragtype
  引き摺られた対象の別の型を指定する｡ Specifies an alternate type of dragged object.

-dropcmd
  列挙箱は落下行事の命令梱包を有する｡この命令は自動摺動及び､品目と位置の抽出を停止する｡ ListBox has a command wrapper for drop events. This command stops auto scrolling and extract item and position.
  もし､dropcmd が空でない場合､次の引数と共に呼出される: If dropcmd is not empty, it is called with the following arguments:
  - 列挙箱の経路名､ the pathname of the listbox,
  - 引き摺り原資の経路名､ the pathname of the drag source,
  - 落下が生じる位置を記述するリスト｡次のものがありえる: a list describing where the drop occurs. It can be:
    - {widget},
    - {item item} or
    - {position index}.
  - 現在の操作､ the current operation,
  - データの型､ the data type,
  - データ｡ the data.

  既定の落下命令は列挙箱内の引き摺り-落下を許容するが､他の部品から或は其処へは許容しない｡ The default drop command allows for drag-and-drop within the listbox but not to or from other widgets.

-dropenabled
  落下が可能か指定する論理値｡ A boolean specifying if drop is enabled.

-dropovercmd
  列挙箱は drag-over 行事に関する命令梱包を有する｡この命令は､自動摺動と､ drag-over の間の位置の抽出を可能にする｡もし､dropovercmd が空でない場合､次の引数と共に呼出される: LsitBox has a command wrapper for drag-over events. This command enables auto scrolling and position extraction during the drag-over. If dropovercmd is not empty, the command is called with the following aguments:
  - 列挙箱の経路名､ the pathname of the listbox,
  - 引き摺り原資の経路名､ the pathname of the drag source,
  - 落下が生じ得る処を記述するリスト､その要素は: a list describing where the drop can occur, whose elements are:
    - もし dropovertype 指示項目が w を含む場合は､文字列 widget ､それ以外は空文字列｡ the string widget if dropovertype option contains w, else empty string.
    - もし､引き摺りアイコンが節を指し､且つ dropovertype 指示項目が i を含む場合は､目的の品目､それ以外は空文字列｡ the targeted item if drag icon points an item and dropovertype option contains i, else empty string.
    - dropovertype 指示項目が p を含む場合は引き摺りアイコンが指す二つの品目の間の参照番号､それ以外は空文字列｡ an index within two items where drag icon points to if dropovertype option contains p, else empty string.
    - 追加的に､もし落下が節の内部と二つの節の間の両方で生じことが可能な場合は､好ましい手段｡ 値は position か node である｡ optionally, the preferred method if drop can occur both inside an item and between two items. The value is position or item.
  - 現在の操作､ the current operation,
  - 現在の操作､ the data type,
  - データ｡ the data.
  本命令は二つの要素のリストを返す筈である: The command must return a list with two elements:
  - DropSite::register の dropovercmd 指示項目内の記述を構成する 落下状態､ the drop status, conforming to those described in dropovercmd option of DropSite::register,
  - 選ばれた手段: widgetか node か position のどれか一つ｡ the choosen method: widget, item or position.

-dropovermode
  drop-over 対話機能の型を指定する｡次の組合せでなければならない､w は落下は部品上のどこでも生じ得ることを指定する､p は､落下は二つの節の間で生じ得ることを指定する､i は落下は節の内側で生じることを指定する｡ Specifies the type of drop-over interaction. Must be a combination of w, which specifies that drop can occurs everywhere on widget, p, which specifies that drop can occurs between two items, and i, which specifies that drop occurs inside items.

-droptypes
  落下され受容れられる 対象/操作 のリストを指定する｡更なる情報は DropSite::register の droptypes 指示項目を参照されたい｡ 既定は操作 copy と move を伴う LISTBOX_ITEM である｡ Specifies a list of accepted dropped object/operation. See option droptypes of DropSite::register. for more infromation.
  Default is LISTBOX_ITEM with operations copy and move.

-height
  列挙箱に関する望ましい丈をδy 画素単位で指定する｡ Specifies the desired height for the listbox in units of deltay pixels.

-multicolumn
  列挙箱は､それぞれを見る為に品目を垂直に整列するか否かを指定する｡ Specifies wether or not ListBox layouts items in order to see each one vertically.

-padx
  影像か窓と､品目の文書との間の距離を指定する｡ Specifies distance between image or window and text of the items.

-redraw
  怠惰に入った時に列挙箱が再描画されるべきか否かを指定する｡列挙箱修正中に使用者がupdate を呼出すと偽値に設定する｡ Specifies wether or not the listbox should be redrawn when entering idle. Set it to false if you call update while modifying the listbox.

-selectfill (read-only)
  もし､真値なら､列挙箱は選択された品目の周りに箱を描くのではなく､左から右に列挙箱を満たす選択矩形を描く｡これは標準 Tk 列挙箱に近い模倣である｡ If true, the listbox will draw a selection rectangle that fills the listbox from left-to-right instead of just drawing a box around the selected item. This more closely mimics the standard Tk listbox.

-selectmode
  列挙箱について望ましい選択様式を指定する｡none か single か multiple の内の一つでなければならない｡selectmode が single はその文書か影像につき一つの品目を選択する｡selectmode が multiple は文書か影像につき複数の選択を許容する｡selectmode の single と selectmode の multiple に関して更なる情報は Tk 列挙箱命令を参照されたい｡ selectmode の既定値は none である｡ Specifies the desired selection-mode for the listbox. Must be one of none, single or multiple. selectmode single allows to select 1 item by its text or image. selectmode multiple allows to select multiple items by their text or image. For more info on selectmodes single or multiple, see the Tk listbox command. Default value for selectmode is none.

-width
  列挙箱について望ましい巾を 8 画素単位で指定する｡ Specifies the desired width for the listbox in units of 8 pixels.

部品命令 WIDGET COMMAND

pathName bindImage event script
  本命令は event によって与えられ､品目の影像上で生じる行事並びを何時であれ遂行すべき命令に､結合する｡その上で行事が生じる品目識別子はその命令に追記される｡　　　　　　　　　　　　　　　　　　 This command associates a command to execute whenever the event sequence given by event occurs on the image of a item. The item idenfier on which the event occurs is appended to the command.

  script 中で生じるどの様な %W も列挙箱の経路によって置換される｡ Any occurrence of %W in script is substituted with the path of the listbox.

pathName bindText event script
  本命令は event によって与えられ､品目の札上で生じる行事並びを何時であれ遂行すべき命令に､結合する｡その上で行事が生じる品目識別子はその命令に追記される｡　　　　　　　　　　　　　　　　　　 This command associates a command to execute whenever the event sequence given by event occurs on the label of a item. The item idenfier on which the event occurs is appended to the command.

  script 中で生じるどの様な %W も列挙箱の経路によって置換される｡ Any occurrence of %W in script is substituted with the path of the listbox.

pathName cget option
  option によって与えられる構成設定指示項目の現在の値が返る｡option は生成命令に受容れられるどのような値を採り得る｡ Returns the current value of the configuration option given by option. Option may have any of the values accepted by the creation command.

pathName configure ?option? ?value option value ...?
  部品の構成設定指示項目を問合せ又は修正する｡もしどの option も指定されないと､pathNameに関する利用できる全ての指示項目を記述するリストを返す｡もし option が value無しに指定されると､本命令は option と名付けられたものを記述するリストを返す(このリストはoptionが何も指定されない場合に返される値の対応する仔リストに等しくなる)｡もし､一つ或はそれ以上の option-value 対が指定されると､本命令は与えられた部品指示項目が与えらえた値を有するよう修正する; この場合､本命令は空文字列を返す｡option は生成命令によって受容れられるどのような値も採り得る｡読出し専用指示項目は修正されない｡ 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. 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 creation command. Read-only options are not be modified.

pathName delete ?arg...?
  arg 内の全ての品目を削除する｡arg は節のリスト或は節のリストのリストでもよい｡全ての樹枝を削除するには､ $pathName delete [$pathName items] を実行されたい｡ Deletes all items in arg. arg can be a list of items or a list of list of items. To delete all items, do $pathName delete [$pathName items].

pathName edit item text ?verifycmd? ?clickres? ?select?
  使用者に品目の札を適切に校正する方法を提供する｡本命令は初期の文書を引数として採り､校正される節の札を修正しないが､校正が解消されると空文字列を返し､校正が受容れられれば印刷された文書を返す｡校正時に､使用者はEscを押して解消でき､Reurnを押して受付ける｡clickres はもし使用者が校正可能な領域外で軽叩した時に何をするかを指定する｡もし clickres が 0 (既定)の場合､校正は解消される｡もし clickres が 1 の場合､校正は受容れられる｡他の全ての場合､校正は継続される｡もし校正が受容れられ､且つ modifycmd が空文字列でない場合､それは引数として新しい文書と共に呼ばれ､新しい文書を受容れるには 1 ､拒否するには 0 を返し､校正を続ける｡select は初期文書が選択されるべきか否かを指定する｡既定値は 1｡　　 Provides a way for the user to edit in place the label of an item.
  The command takes the initial text as argument and does not modify the label of the edited node, but returns an empty string if edition is canceled, or the typed text if edition is accepted.
  When editing, the user can cancel by pressing Escape, or accept by pressing Return.
  clickres specifies what to do if the user click outside the editable area. If clickres is 0 (the default), the edition is canceled. If clickres is 1, the edition is accepted. In all other case, the edition continues.
  If edition is accepted and modifycmd is not empty, then it is called with the new text as argument and must return 1 to accept the new text, 0 to refuse it and continue edition.
  select specifies wether or not the initial text should be selected. Default is 1.

pathName exists item
  列挙箱の中に item があれば 1 を､無ければ0を返す｡ Returns 1 if item exists in the listbox, else 0.

pathName index item
  リスト中の item の位置を返す｡ Returns the position of item in the list.

pathName insert index item ?option value...?

  item によって識別される新しい品目をリスト中の index の位置に挿入する｡ Inserts a new item identified by item in the list at position index.

  品目の名前の範囲の如何なる実際値 #auto も､品目の挿入順序の番号によって置換されることになる｡ Any instance of #auto within the item name will be replaced by the number of the item in the order of insertion.

  -data
    品目に結合する使用者のデータ｡ User data associated to the item.
  -fill
    品目の札の前景の色を指定する｡ Specifies the foreground color of the label of the item.
  -font
    品目の札に関する字母を指定する｡ Specifies a font for the label of the item.
  -image
    品目の札の左に展示する影像を指定する｡window 指示項目は image を上書きする｡ Specifies an image to display at the left of the label of the item. window option override image.
  -indent
    品目の左の余分な空白の量を画素単位で指定する｡ Specifies the amount of extra space in pixels at the left of the item.
  -text
    品目の札を指定する｡ Specifies the label of the item.
  -window
    品目の札の左に展示する経路名を指定する｡window 指示項目は image を上書きする｡ Specifies a pathname to display at the left of the label of the item. window option override image.

pathName item first ?last?
  この利用は推奨されない｡代りに items を使用されたい｡ もし､last が省略されるとリスト内の first の参照位置にある品目を返すが､ first が実在しない要素を参照していると空文字列を返す｡もし last が指定されると､本命令は first と last とその間の全ての要素を含むリストを返す｡ first と last は両方とも標準形式の参照番号を採り得る｡ Its use is deprecated. Use items instead.
  If last is omitted, returns the item at index first in the list, or an empty string if first refers to a non-existent element. If last is specified, the command returns a list whose elements are all of the items between first and last, inclusive. Both first and last may have any of the standard forms for indices.

pathName itemcget item option
  品目に関する構成設定指示項目の値を返す｡option はその品目生成命令によって受容れられるどのような値も採り得る｡ Returns the current value of a configuration option for the item. Option may have any of the values accepted by the item creation command.

pathName itemconfigure item ?option? ?value option value ...?
  本命令は configure 命令に似ている､configure は部品全体に適用するが､これは個別の品目に関する指示項目に適用することが異なる｡option は品目生成命令によって受容れられるどの様な値も採り得る｡もし指示項目が指定されると､指示項目は命令内の表示に従って修正され､且つ本命令は空文字列を返す｡もし指示項目が指定されないと､品目に関する現在の指示項目を記述するリストを返す｡読出し専用指示項目は修正されない｡ This command is similar to the configure command, except that it applies to the options for an individual item, whereas configure applies to the options for the widget as a whole. Options may have any of the values accepted by the item creation widget command. If options are specified, options are modified as indicated in the command and the command returns an empty string. If no options are specified, returns a list describing the current options for the item. Read-only options are not be modified.

pathName items ?first? ?last?
  もし first と last が省略されると､全ての品目のリストを返す｡もし first が指定され且つ last が省略されると､参照位置firstの品目が返されるが､ first が非-実在要素を参照している場合は空文字列を返す｡もし first と last が指定されると､本命令は first と last とその間の全ての品目が要素になっているリストを返す｡ first と last は両方とも標準形式の参照番号を採り得る｡ If first and last are omitted, returns the list of all items. If first is specified and last omitted, returns the item at index first, or an empty string if first refers to a non-existent element. If first and last are specified, the command returns a list whose elements are all of the items between first and last, inclusive. Both first and last may have any of the standard forms for indices.

pathName move item index
  リスト内の index の位置の item を動かす｡ Moves item at position index in the list.

pathName reorder neworder
  neworder によって与えられる列挙箱内の品目の順序を修正する｡ neworder に現れない品目は動かされない｡ Modifies the order of items in the listbox given by neworder. Items that do not appear in neworder are no moved.

pathName see item
  item が可視になるよう摺動領域を整える｡ Arrange the scrolling area to make item visible.

pathName selection cmd ?arg...?
  選択された品目のリストを次の cmd に従って修正する: Modifies the list of selected items following cmd:
  clear
    選択の品目全てを除去する｡ remove all items of the selection.
  set
    arg 内の全ての品目に選択を設定する｡ set the selection to all items in arg
  add
    選択内に全ての arg 品目を追加する｡ add all items of arg in the selection
  remove
    選択の arg の全ての品目を除去する｡ remove all items of arg of the selection
  get
    return the current selected items

pathName xview ?arg...?
  pathName の水平摺動を可能にする標準命令｡ Standard command to enable horizontal scrolling of pathName.

pathName yview ?arg...?
  pathName の垂直摺動を可能にする標準命令｡ Standard command to enable vertical scrolling of pathName.

束縛 BINDINGS

<<ListboxSelect>> 仮想行事は列挙箱変更の選択時は何時でも生成される｡ A <<ListboxSelect>> virtual event is generated any time the selection in the listbox changes.

列挙箱はは注目を有している時は､全ての標準マウス環輪束縛を有する｡ The listbox has all the standard mouse wheel bindings when it has focus.