listbox

2022/06/15 10:29 Macro::TTL コマンドリファレンス

【Tera Term マクロ言語】コマンドリファレンス

listbox 機能

[その他のコマンド]

リストボックスを開き、ユーザーに項目を選択させます。

コマンドライン

listbox <message> <title> <string array> [<selected>]

機能説明

リストボックスを開き、ユーザーがリストから選択肢を指定することができます。

listbox は <string array> の配列要素をすべて選択項目として表示します。

<message>

リストボックスに表示されるメッセージ。

<title>

リストボックスのタイトル。

<string array>

リストボックスの選択項目。

以下のように、表示しようとする選択項目数より大きい要素数で <string array> を定義すると、最後に空文字列が表示されます。

strdim msg 4
msg[0] = 'バナナ' 
msg[1] = 'りんご' 
msg[2] = 'みかん'
listbox '好きな食べ物を選んでください' 'あなたへの問い' msg

; 選択肢が4つ表示される
バナナ
りんご
みかん
[空文字列]

[<selected>]

(バージョン 4.89 以降)
初期選択項目(0オリジンインデックス)。

<selected> を指定する事で、初期状態で選択されている項目を指定する事ができます。
省略した場合は 0 (先頭) が指定されたものとして扱われます。

パラメータの説明

指定するパラメータは以下の通りです。

パラメータ	型	パラメータ説明
<message>	文字列	リストボックスに表示されるメッセージを指定します。
<title>	文字列	リストボックスのタイトルを指定します。
<string array>	文字列型配列	選択肢をもつ配列を指定します。
<selected>	整数	デフォルトの選択項目を指定します。

対象バージョン

バージョン 4.78 以降で利用可能です。
バージョン 4.89 より強化された機能があります。

戻り値

戻り値として以下の変数が定義されます。

変数名	値	意味
result	-1	選択がキャンセルされた
	0	配列の 0 番が選択された
	1	配列の 1 番が選択された
	n	配列の n 番が選択された

種別：その他	Ver	機能の簡易説明
yesnobox		ダイアログボックスを開き、ユーザーに「はい」/「いいえ」を選択させる。
4.54以降	特殊文字の解釈を制御するオプションの追加。
4.60以降	キャンセル時にマクロ停止を確認する機能の追加。

使用方法

使用例

・3つの選択肢から一つを指定をする場合

strdim msg 3
msg[0] = 'バナナ' 
msg[1] = 'りんご' 
msg[2] = 'みかん'
listbox '好きな食べ物を選んでください' 'あなたへの問い' msg
; result
;   -1: Cancel
;    0: バナナ
;    1: りんご
;    2: みかん
if result = -1 then
  messagebox '終了します' result
  exit
else
  sprintf2 answer '%s を選択しました' msg[result]
  messagebox answer result
endif

・7つの選択肢から一つを指定をする場合

strdim msg 7
msg[0] = '晴れ' 
msg[1] = '曇り' 
msg[2] = '雨'
msg[3] = '風'
msg[4] = '雪'
msg[5] = '霧'
msg[6] = '分かりません'
; デフォルトで7番目の項目が選択される
listbox '今日の天気はどうですか?' 'あなたへの問い' msg 6
sprintf2 var "%d" result
messagebox var "result"

サンプル

サンプルマクロはありません。

備考

特にありません。

Tera Term のススメ