移動先: 概要 戻り値 フラグ. 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] [-exists] [-font string] [-height int] [-isObscured] [-manage boolean] [-numberOfItems] [-numberOfPopupMenus] [-numberOfRows int] [-numberOfSelectedItems] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-removeAll] [-removeIndexedItem int] [-removeItem string] [-selectCommand script] [-selectIndexedItem int] [-selectItem string] [-showIndexedItem int] [-useTemplate string] [-visible boolean] [-width int] [string]

textScrollList は 「元に戻す」が可能、「照会」が可能、「編集」が可能 です。

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

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

戻り値

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

戻り値の型は照会モードでは照会フラグが基になります。

フラグ

allItems, allowAutomaticSelection, allowMultiSelection, annotation, append, appendPosition, backgroundColor, defineTemplate, deleteKeyCommand, deselectAll, deselectIndexedItem, deselectItem, docTag, doubleClickCommand, dragCallback, dropCallback, enable, exists, font, height, isObscured, manage, numberOfItems, numberOfPopupMenus, numberOfRows, numberOfSelectedItems, parent, popupMenuArray, preventOverride, removeAll, removeIndexedItem, removeItem, selectCommand, selectIndexedItem, selectItem, showIndexedItem, useTemplate, visible, 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
コントロールの可視の状態です。デフォルトでは、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって 異なることに注意してください。
-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 createedit
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です（Windows のみのフラグです）。
-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'」）。

-append(-a) string createeditmultiuse
リストの最後に項目を追加します。
-appendPosition(-ap) int string createeditmultiuse
指定した場所に項目をアペンドします。 場所は 1 ベースのインデックスです。
-allItems(-ai) query
すべての項目。
-allowAutomaticSelection(-aas) boolean createqueryedit
自動セレクション モードを指定します。automaticSelection が ON の場合、マウスが通過した項目（ドラッグするときに項目が選択されます）が選択されます。-sc/selectCommand someCommand が設定されている場合、someCommand は選択項目それぞれで呼び出されます。 -aas/allowAutomaticSelection がオフの場合、マウス ボタンを離した状態で選択されているのは選択項目のみです。そのため、この引数が設定されていると、-sc/selectCommand someCommand は 1 回だけ呼び出されます。
-allowMultiSelection(-ams) boolean createqueryedit
マルチあるいはシングル セレクション モードを指定します。
-doubleClickCommand(-dcc) script createedit
項目をダブル クリックしたときに実行するコマンドを指定します。
-deleteKeyCommand(-dkc) script createedit
Delete キーまたは Backspace キーを押したときに実行するコマンドを指定します。
-numberOfItems(-ni) query
項目の数。
-numberOfRows(-nr) int createqueryedit
可視となる行の数。
-numberOfSelectedItems(-nsi) query
選択した項目の数。
-removeAll(-ra) createedit
全項目を削除します。
-removeItem(-ri) string createeditmultiuse
指定したテキストがある項目を削除します。
-removeIndexedItem(-rii) int createeditmultiuse
インデックスされた項目を削除します。インデックスは 1 ベースです。
-selectCommand(-sc) script createedit
項目を選択したときに実行するコマンドを指定します。
-selectItem(-si) string createqueryeditmultiuse
指定したテキストを含む項目を選択します。
-selectIndexedItem(-sii) int createqueryeditmultiuse
インデックスされた項目を選択します。インデックスは 1 ベースです。
-deselectAll(-da) createedit
すべての項目を選択解除します。
-deselectItem(-di) string createeditmultiuse
指定したテキストを含む項目を選択解除します。
-deselectIndexedItem(-dii) int createeditmultiuse
インデックスされた項目を選択解除します。インデックスは 1 ベースです。
-showIndexedItem(-shi) int createedit
インデックスされた項目を表示します。必要に応じてリストをスクロールし、インデックスされた項目を可視にします。インデックスは 1 ベースです。
-font(-fn) string createqueryedit
項目リストのフォントです。有効な値は、「boldLabelFont」、「smallBoldLabelFont」、「tinyBoldLabelFont」、「plainLabelFont」、「smallPlainLabelFont」、「obliqueLabelFont」、「smallObliqueLabelFont」、「fixedWidthFont」、「smallFixedWidthFont」です。
: コマンドの作成モードで使用可能なフラグ : コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ : 1 つのコマンドで複数回使用可能なフラグ

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;