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

概要

iconTextScrollList [-allowMultiSelection boolean] [-annotation string] [-append string] [-backgroundColor float float float] [-defineTemplate string] [-deselectAll] [-docTag string] [-doubleClickCommand script] [-dragCallback script] [-dropCallback script] [-dropRectCallback script] [-enable boolean] [-enableBackground boolean] [-exists] [-fullPathName string] [-height int] [-isObscured] [-itemAt int int] [-itemTextColor int float float float] [-manage boolean] [-noBackground boolean] [-numberOfPopupMenus] [-numberOfRows] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-removeAll] [-selectCommand script] [-selectIndexedItem int] [-selectItem string] [-useTemplate string] [-visible boolean] [-visibleChangeCommand script] [-visualRectAt int int] [-width int] [string]

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

このコマンドは、テキストのスクロール リストの作成、編集、照会を行います。リストは、一度に 1 つの項目だけを選択するシングル セレクト モード、または複数の項目が選択できるマルチセレクト モードにすることができます。

戻り値

stringコントロールへのフル パス名

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

フラグ

allowMultiSelection, annotation, append, backgroundColor, defineTemplate, deselectAll, docTag, doubleClickCommand, dragCallback, dropCallback, dropRectCallback, enable, enableBackground, exists, fullPathName, height, isObscured, itemAt, itemTextColor, manage, noBackground, numberOfPopupMenus, numberOfRows, parent, popupMenuArray, preventOverride, removeAll, selectCommand, selectIndexedItem, selectItem, useTemplate, visible, visibleChangeCommand, visualRectAt, width
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
-exists(-ex) create
指定したオブジェクトが存在するかどうかによって、true または false を返します。他のフラグは無視されます。
-defineTemplate(-dt) string create
他の任意のフラグと引数を解析し、かつ引数で指定したコマンド テンプレートに追加するモードに、コマンドのモードを変更します。templateName が現在のテンプレートとして設定されていれば、その後コマンドが実行されるたびに、この引数が既定の引数として使用されます。
-useTemplate(-ut) string create
コマンドに、現在以外のコマンド テンプレートの使用を強制します。
-parent(-p) string createquery
コントロールの親のレイアウトです。
-enable(-en) boolean createqueryedit
コントロールの有効、無効です。既定では true に設定されていて、コントロールは有効になっています。false を指定するとコントロールはグレー表示になって無効になります。
-width(-w) int createqueryedit
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
-height(-h) int createqueryedit
コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
-visible(-vis) boolean createqueryedit
コントロールの可視の状態です。既定では、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。
-visibleChangeCommand(-vcc) script createqueryedit
コントロールの可視の状態が変更されたときに実行されるコマンドです。
-isObscured(-io) query
コントロールが実際に表示されるかどうかを返します。コントロールは、次の場合に隠れた状態になります。非表示の場合、別のコントロールで(完全に、または部分的に)ブロックされた場合、コントロールまたは親のレイアウトを制御できない場合、あるいはコントロールのウィンドウが非表示またはアイコン化されている場合。
-manage(-m) boolean createqueryedit
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。既定では、コントロールは管理できるように作成されます。
-numberOfPopupMenus(-npm) query
このコントロールにアタッチされるポップアップ メニューの数を返します。
-popupMenuArray(-pma) query
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
-preventOverride(-po) boolean createqueryedit
true の場合、コントロールのコントロールは親のレイアウトの条件によって無効にされ右マウス ボタン メニューを使用したコントロール アトリビュートのオーバーライドは無効です。
-annotation(-ann) string createqueryedit
コントロールに文字列値で注釈を付けます。
-backgroundColor(-bgc) float float float createqueryedit
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。
backgroundColor を設定する場合、enableBackground を false に指定していない限り、バックグラウンドは自動的に有効になります。
-noBackground(-nbg) boolean createedit
コントロールのバックグラウンドをクリア/リセットします。バックグラウンドは、true を渡すと一切描画されず、false を渡すと描画されます。このフラグの状態は、このコントロールの子に継承されます。
-enableBackground(-ebg) boolean createqueryedit
コントロールのバックグラウンド カラーを有効にします。
-docTag(-dtg) string createqueryedit
コントロールにドキュメンテーション フラグを追加します。ドキュメンテーション フラグは、階層のようなディレクトリ構造になっています。例: -dt render/multiLister/createNode/material
-dragCallback(-dgc) script createedit
中マウス ボタンを押すとコールされるコールバックを追加します。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 createedit
ドラッグ＆ドロップ操作をドロップ位置で解放したときにコールされるコールバックを追加します。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 query
すべての親を含むウィジェットのフル パス名を返します。
-append(-a) string createeditmultiuse
リストの最後に項目を追加します。
-removeAll(-ra) createedit
全項目を除去します。
-allowMultiSelection(-ams) boolean createqueryedit
マルチあるいはシングル セレクション モードを指定します。
-selectCommand(-sc) script createedit
項目を選択したときに実行するコマンドを指定します。
-selectItem(-si) string createqueryeditmultiuse
指定したテキストを含む項目を選択します。
-selectIndexedItem(-sii) int createqueryeditmultiuse
インデックスされた項目を選択します。インデックスは 1 ベースです。
-deselectAll(-da) createedit
すべての項目を選択解除します。
-itemTextColor(-itc) int float float float createeditmultiuse
指定されたインデックスにある項目のテキスト カラーを設定します。引数は、index、red、green、および blue です。インデックスは 1 ベースです。それぞれのカラー コンポーネントの値は、0.0～ 1.0 です。
-itemAt(-ia) int int query
存在する場合は、指定位置にある項目名を戻します。

照会モードでは、このフラグに値が必要になります。
-visualRectAt(-vra) int int query
存在する場合は、指定位置にある項目を示す長方形表示を戻します。結果は、長方形を表すローカル座標の 4 つの整数から成る配列で、順番は次のとおりです。左上の X 座標、左上の Y 座標、幅、高さ。

照会モードでは、このフラグに値が必要になります。
-doubleClickCommand(-dcc) script createedit
項目をダブル クリックしたときに実行するコマンドを指定します。
-numberOfRows(-nr) query
可視となる行の数。
-dropRectCallback(-drc) script edit
ドラッグ＆ドロップ操作の、マウスをドロップ位置の上に置いたままにしたときにコールされるコールバックを追加します。コントロールがドロップされたデータを受信できると、エントリをハイライトするために描画した長方形のシェイプを戻します。MEL バージョンのコールバックの書式は次のとおりです。

global proc int[] callbackName(string $dropControl, int $x, int $y)

戻り値は、サイズを表す 4 つの数字から成る配列で、パラメータを伴います。数値は、描画される長方形の左上の X 座標、左上の Y 座標、幅、高さの順です。この機能は、現在、MEL でのみ実装されます。

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

MEL 例

window;
paneLayout;
iconTextScrollList -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";
showWindow;