textScrollList

ジャンプ先: 概要. 戻り値. フラグ. MEL 例.

概要

textScrollList [-allItems] [-allowAutomaticSelection boolean] [-allowMultiSelection boolean] [-annotation string] [-append string] [-appendPosition int string] [-backgroundColor float float float] [-defineTemplate string] [-deleteKeyCommand script] [-deselectAll] [-deselectIndexedItem int] [-deselectItem string] [-docTag string] [-doubleClickCommand script] [-dragCallback script] [-dropCallback script] [-enable boolean] [-enableBackground boolean] [-exists] [-font string] [-fullPathName string] [-height int] [-isObscured] [-lineFont int string] [-manage boolean] [-noBackground boolean] [-numberOfItems] [-numberOfPopupMenus] [-numberOfRows int] [-numberOfSelectedItems] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-removeAll] [-removeIndexedItem int] [-removeItem string] [-selectCommand script] [-selectIndexedItem int] [-selectItem string] [-selectUniqueTagItem string] [-showIndexedItem int] [-uniqueTag string] [-useTemplate string] [-visible boolean] [-visibleChangeCommand script] [-width int] [string]

textScrollList は、取り消し可能、照会可能、および編集可能です。

注: -dgc/dragCallback フラグは、Windows 上でのみ機能します。

戻り値

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
-exists(-ex)
指定したオブジェクトが存在するかどうかによって、true または false を返します。他のフラグは無視されます。
-defineTemplate(-dt)	string
他の任意のフラグと引数を解析し、かつ引数で指定したコマンド テンプレートに追加するモードに、コマンドのモードを変更します。templateName が現在のテンプレートとして設定されていれば、その後コマンドが実行されるたびに、この引数が既定の引数として使用されます。
-useTemplate(-ut)	string
コマンドに、現在以外のコマンド テンプレートの使用を強制します。
-parent(-p)	string
コントロールの親のレイアウトです。
-enable(-en)	boolean
コントロールの有効、無効です。既定では true に設定されていて、コントロールは有効になっています。false を指定するとコントロールはグレー表示になって無効になります。
-width(-w)	int
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
-height(-h)	int
コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
-visible(-vis)	boolean
コントロールの可視の状態です。既定では、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。
-visibleChangeCommand(-vcc)	script
コントロールの可視の状態が変更されたときに実行されるコマンドです。
-isObscured(-io)
コントロールが実際に表示されるかどうかを返します。コントロールは、次の場合に隠れた状態になります。非表示の場合、別のコントロールで(完全に、または部分的に)ブロックされた場合、コントロールまたは親のレイアウトを制御できない場合、あるいはコントロールのウィンドウが非表示またはアイコン化されている場合。
-manage(-m)	boolean
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。既定では、コントロールは管理できるように作成されます。
-numberOfPopupMenus(-npm)
このコントロールにアタッチされるポップアップ メニューの数を返します。
-popupMenuArray(-pma)
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
-preventOverride(-po)	boolean
true の場合、コントロールのコントロールは親のレイアウトの条件によって無効にされ右マウス ボタン メニューを使用したコントロール アトリビュートのオーバーライドは無効です。
-annotation(-ann)	string
コントロールに文字列値で注釈を付けます。
-backgroundColor(-bgc)	float float float
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。 backgroundColor を設定する場合、enableBackground を false に指定していない限り、バックグラウンドは自動的に有効になります。
-noBackground(-nbg)	boolean
コントロールのバックグラウンドをクリア/リセットします。バックグラウンドは、true を渡すと一切描画されず、false を渡すと描画されます。このフラグの状態は、このコントロールの子に継承されます。
-enableBackground(-ebg)	boolean
コントロールのバックグラウンド カラーを有効にします。
-docTag(-dtg)	string
コントロールにドキュメンテーション フラグを追加します。ドキュメンテーション フラグは、階層のようなディレクトリ構造になっています。例: -dt render/multiLister/createNode/material
-dragCallback(-dgc)	script
中マウス ボタンを押すとコールされるコールバックを追加します。MEL バージョンのコールバックの書式は次のとおりです。 global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) proc はドロップ先に転送される文字配列を返します。規則により、配列の先頭文字列はユーザ設定可能なメッセージ タイプを表しています。アプリケーションで定義されたドラッグ元のコントロールは、このコールバックを無視する可能性があります。$mods で、キー モディファイアである CTL と SHIFT をテストできます。有効な値は、0 == モディファイアなし、1 == SHIFT、2 == CTL、3 == CTL + SHIFT です。 Python でも同様ですが、コールバックの指定方法が 2 つあります。お勧めの方法は、引数として Python 関数オブジェクトを渡すことです。この場合、Python コールバックの書式は次のようになります。 def callbackName( dragControl, x, y, modifiers ): この引数の値は、上記の MEL バージョンの引数と同じです。 Python でコールバックを指定するもう 1 つの方法では、実行する文字列を指定します。この場合、Python の標準的なフォーマット演算子を介して文字列に値が代入されます。このフォーマットの値は、キー「dragControl」、「x」、「y」、「modifiers」と共に辞書で渡されます。dragControl の値は文字列で、その他の値は整数です(コールバック文字列の例: 「print '%(dragControl)s %(x)d %(y)d %(modifiers)d'」)。
-dropCallback(-dpc)	script
ドラッグ＆ドロップ操作をドロップ位置で解放したときにコールされるコールバックを追加します。MEL バージョンのコールバックの書式は次のとおりです。 global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) proc は、ドラッグ元から転送される文字配列を受け取ります。msgs 配列の先頭文字列はユーザ定義のメッセージ タイプを表します。アプリケーションで定義されたドロップ先のコントロールでは、このコールバックが無視されることがあります。$type の値は、1 == 移動、2 == コピー、3 == リンクのいずれかです。 Python でも同様ですが、コールバックの指定方法が 2 つあります。お勧めの方法は、引数として Python 関数オブジェクトを渡すことです。この場合、Python コールバックの書式は次のようになります。 def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): この引数の値は、上記の MEL バージョンの引数と同じです。 Python でコールバックを指定するもう 1 つの方法では、実行する文字列を指定します。この場合、Python の標準的なフォーマット演算子を介して文字列に値が代入されます。このフォーマットの値は、キー「dragControl」、「dropControl」、「messages」、「x」、「y」、「type」と共に辞書で渡されます。dragControl の値は文字列で、その他の値は整数です(コールバック文字列の例: 「print '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'」)。
-fullPathName(-fpn)	string
すべての親を含むウィジェットのフル パス名を返します。
-append(-a)	string
リストの最後に項目を追加します。
-appendPosition(-ap)	int string
指定した場所に項目をアペンドします。場所は 1 ベースのインデックスです。
-allItems(-ai)
すべての項目。
-allowAutomaticSelection(-aas)	boolean
自動セレクション モードを指定します。automaticSelection が ON の場合、マウスが通過した項目(ドラッグするときに項目が選択されます)が選択されます。-sc/selectCommand someCommand が設定されている場合、someCommand は選択項目それぞれでコールされます。-aas/allowAutomaticSelection がオフの場合、マウス ボタンを離した状態で選択されているのは選択項目のみです。そのため、この引数が設定されていると、-sc/selectCommand someCommand は 1 回だけコールされます。
-allowMultiSelection(-ams)	boolean
マルチあるいはシングル セレクション モードを指定します。
-doubleClickCommand(-dcc)	script
項目をダブル クリックしたときに実行するコマンドを指定します。
-deleteKeyCommand(-dkc)	script
Delete キーまたは Backspace キーを押したときに実行するコマンドを指定します。
-lineFont(-lf)	int string
リストの特定の行のフォントを指定します。インデックスは 1 ベースです。フォントの有効な値は、「boldLabelFont」、「smallBoldLabelFont」、「tinyBoldLabelFont」、「plainLabelFont」、「smallPlainLabelFont」、「obliqueLabelFont」、「smallObliqueLabelFont」、「fixedWidthFont」、「smallFixedWidthFont」です。
-numberOfItems(-ni)
項目の数。
-numberOfRows(-nr)	int
可視となる行の数。
-numberOfSelectedItems(-nsi)
選択した項目の数。
-removeAll(-ra)
全項目を除去します。
-removeItem(-ri)	string
指定したテキストがある項目を除去します。
-removeIndexedItem(-rii)	int
インデックスされた項目を除去します。インデックスは 1 ベースです。
-selectCommand(-sc)	script
項目を選択したときに実行するコマンドを指定します。
-selectItem(-si)	string
指定したテキストを含む項目を選択します。
-selectIndexedItem(-sii)	int
インデックスされた項目を選択します。インデックスは 1 ベースです。
-deselectAll(-da)
すべての項目を選択解除します。
-deselectItem(-di)	string
指定したテキストを含む項目を選択解除します。
-deselectIndexedItem(-dii)	int
インデックスされた項目を選択解除します。インデックスは 1 ベースです。
-showIndexedItem(-shi)	int
インデックスされた項目を表示します。必要に応じてリストをスクロールし、インデックスされた項目を可視にします。インデックスは 1 ベースです。
-font(-fn)	string
項目リストのフォントです。有効な値は、「boldLabelFont」、「smallBoldLabelFont」、「tinyBoldLabelFont」、「plainLabelFont」、「smallPlainLabelFont」、「obliqueLabelFont」、「smallObliqueLabelFont」、「fixedWidthFont」、「smallFixedWidthFont」です。
-uniqueTag(-utg)	string
このフラグは、append または appendPosition フラグと一緒に使用した場合のみに使用できます。文字列は、アペンドした項目に対する一意のタグを指定します。このタグは項目の照会に使用できます。このタグは、インデックスではなく文字列を使用してリスト項目を一意に識別するための代替手段を提供します。タグの大文字と小文字は区別されます。
-selectUniqueTagItem(-sut)	string
一意のタグに基づいて項目を選択できます。照会モードでは、選択した項目の一意のタグを返します。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	コマンド内でフラグを複数回使用できます。

MEL 例

window;
paneLayout;
textScrollList -numberOfRows 8 -allowMultiSelection true
    -append "one"      -append "two"      -append "three"
    -append "four"     -append "five"     -append "six"
    -append "seven"    -append "eight"    -append "nine"
    -append "ten"      -append "eleven"   -append "twelve"
    -append "thirteen" -append "fourteen" -append "fifteen"
    -selectItem "six"
    -showIndexedItem 4;
showWindow;

window;
paneLayout;
textScrollList -allowMultiSelection true
    -append "Only two things are infinite, the universe and human stupidity, and I'm not sure about the former."
    -uniqueTag "Albert Einstein"
    -append "Each problem that I solved became a rule, which served afterwards to solve other problems."
    -uniqueTag "Rene Descartes"
	myControlObj;
showWindow;

textScrollList -e -selectUniqueTagItem "Albert Einstein" myControlObj;
textScrollList -q -selectUniqueTagItem myControlObj;

textScrollList -e -appendPosition 2 "Your theory is crazy, but it's not crazy enough to be true."
				  -uniqueTag "Niels Bohr" myControlObj;

textScrollList -e -selectUniqueTagItem "Rene Descartes"
		          -selectUniqueTagItem "Niels Bohr"
		           myControlObj;
textScrollList -q -selectUniqueTagItem myControlObj;