移動先: 概要 戻り値 フラグ. MEL 例.

概要

scrollField [-annotation string] [-backgroundColor float float float] [-changeCommand script] [-clear] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-editable boolean] [-enable boolean] [-enterCommand script] [-exists] [-font string] [-height int] [-insertText string] [-insertionPosition int] [-isObscured] [-keyPressCommand script] [-manage boolean] [-numberOfLines int] [-numberOfPopupMenus] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-selection] [-text string] [-useTemplate string] [-visible boolean] [-width int] [-wordWrap boolean] [string]

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

このコマンドは、複数行のテキストを処理するスクロール可能フィールドを作成します。

戻り値

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

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

フラグ

annotation, backgroundColor, changeCommand, clear, defineTemplate, docTag, dragCallback, dropCallback, editable, enable, enterCommand, exists, font, height, insertText, insertionPosition, isObscured, keyPressCommand, manage, numberOfLines, numberOfPopupMenus, parent, popupMenuArray, preventOverride, selection, text, useTemplate, visible, width, wordWrap
ロング ネーム（ショート ネーム） 引数型 プロパティ
-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'」）。

-wordWrap(-ww) boolean create
true を指定すると、スペース、タブ位置、あるいは新しい行で改行されます。テキストは次の行に続きます。false を指定すると、テキストは語と語の間で分割されず、フィールドの端を越える部分のテキストは表示されません。このフラグは、作成時に設定する必要があります。 デフォルトでは、行は折り返されません。
-enterCommand(-ec) script createedit
Enter キーが押されたときに実行されるコマンド。 このコマンドはテン キーにある Enter キーにのみ適用されます。
-keyPressCommand(-kpc) script createedit
任意のキーを押したときに実行されるコマンド。
-changeCommand(-cc) script createedit
値が変更されたときに実行されるコマンドです。このコマンドは、フィールドのフォーカスがほかに移ると必ず実行されます。
-font(-fn) string createqueryedit
テキストのフォントです。有効な値は、「boldLabelFont」、「smallBoldLabelFont」、「tinyBoldLabelFont」、「plainLabelFont」、「smallPlainLabelFont」、「obliqueLabelFont」、「smallObliqueLabelFont」、「fixedWidthFont」、「smallFixedWidthFont」です。
-text(-tx) string createqueryedit
フィールド テキストです。
-insertText(-it) string createedit
現在の挿入位置で、フィールドにテキストを挿入します（-ip/insertionPosition flag で指定します）。
-insertionPosition(-ip) int createqueryedit
挿入テキストの挿入位置です。これは 1 をベースにした値です。つまり、位置 1 はフィールドの先頭を示します。位置 0 を使用してフィールドの最後を指定することもできます。
-selection(-sl) query
フィールド内の選択したテキスト。選択したテキストが存在しない場合は、空の文字列が返されます。
-clear(-cl) createedit
フィールド内のすべてのテキストを削除します。
-editable(-ed) boolean createqueryedit
フィールドの編集状態です。デフォルトでは、このフラグは true に設定され、これに入力することでフィールド値を変更することができます。 false の場合は、フィールドは「読み取り専用」になるので、フィールドに入力することはできません。 フィールドのテキストは、-ed/editable フラグの状態にかかわらず、常に -tx/text フラグを使用して変更できます。
-numberOfLines(-nl) int query
スクロール可能フィールド内の行数。
: コマンドの作成モードで使用可能なフラグ : コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ : 1 つのコマンドで複数回使用可能なフラグ

MEL 例

window;
    paneLayout -configuration "horizontal4";
        scrollField -wordWrap true
            -text "Non editable with word wrap" -editable false;
        scrollField -wordWrap false
            -text "Non editable with no word wrap" -editable false;
        scrollField -wordWrap true
            -text "Editable with word wrap";
        scrollField -wordWrap false
            -text "Editable with no word wrap";
showWindow;