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

概要

cmdScrollFieldReporter [-annotation string] [-backgroundColor float float float] [-clear] [-copySelection] [-cutSelection] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-echoAllCommands boolean] [-enable boolean] [-enableBackground boolean] [-enableKeyboardFocus boolean] [-exists] [-filterSourceType string] [-fullPathName] [-hasFocus] [-height int] [-highlightColor float float float] [-isObscured] [-lineNumbers boolean] [-manage boolean] [-noBackground boolean] [-numberOfPopupMenus] [-parent string] [-pasteSelection] [-popupMenuArray] [-preventOverride boolean] [-receiveFocusCommand script] [-saveSelection string] [-saveSelectionToShelf] [-select uint uint] [-selectAll] [-stackTrace boolean] [-statusBarMessage string] [-suppressErrors boolean] [-suppressInfo boolean] [-suppressResults boolean] [-suppressStackTrace boolean] [-suppressWarnings boolean] [-text string] [-textLength] [-useTemplate string] [-visible boolean] [-visibleChangeCommand script] [-width int]

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

処理したコマンドのヒストリを受信して表示するために使用するスクリプト エディタ レポータ コントロール。

戻り値

stringレポータ コントロールの名前

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

フラグ

annotation, backgroundColor, clear, copySelection, cutSelection, defineTemplate, docTag, dragCallback, dropCallback, echoAllCommands, enable, enableBackground, enableKeyboardFocus, exists, filterSourceType, fullPathName, hasFocus, height, highlightColor, isObscured, lineNumbers, manage, noBackground, numberOfPopupMenus, parent, pasteSelection, popupMenuArray, preventOverride, receiveFocusCommand, saveSelection, saveSelectionToShelf, select, selectAll, stackTrace, statusBarMessage, suppressErrors, suppressInfo, suppressResults, suppressStackTrace, suppressWarnings, text, textLength, useTemplate, visible, visibleChangeCommand, width
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
-annotation(-ann) string createqueryedit
コントロールに文字列値で注釈を付けます。
-backgroundColor(-bgc) float float float createqueryedit
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。
backgroundColor を設定する場合、enableBackground を false に指定していない限り、バックグラウンドは自動的に有効になります。
-clear(-clr) createedit
フィールドをクリアします。
-copySelection(-cp) createedit
このフィールドから現在の選択項目をコピーします。
-cutSelection(-ct) createedit
このフィールドから現在の選択項目をカットします。
-defineTemplate(-dt) string create
他の任意のフラグと引数を解析し、かつ引数で指定したコマンド テンプレートに追加するモードに、コマンドのモードを変更します。 templateName が現在のテンプレートとして設定されていれば、その後コマンドが実行されるたびに、この引数が既定の引数として使用されます。
-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 で、キー モディファイアである CTRL と SHIFT をテストできます。 有効な値は、0 == モディファイアなし、1 == SHIFT、2 == CTRL、3 == CTRL + 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'」)。

-echoAllCommands(-eac) boolean createqueryedit
すべてのコマンドをエコーします(グローバル パラメータ。すべてのコマンド レポータに影響します)。
-enable(-en) boolean createqueryedit
コントロールの有効、無効です。既定では true に設定されていて、コントロールは有効になっています。false を指定するとコントロールはグレー表示になって無効になります。
-enableBackground(-ebg) boolean createqueryedit
コントロールのバックグラウンド カラーを有効にします。
-enableKeyboardFocus(-ekf) boolean createqueryedit
有効にすると、[Tab]キーを押してコントロールに移動し、キーボードで値を選択することができます。有効でない場合は、マウスのみを使用できます。このフラグは通常、編集コントロールやリスト コントロールなどで既定で使用されるコントロールから、キーボード フォーカスのサポートをオフにするために使用されます。
-exists(-ex) create
指定したオブジェクトが存在するかどうかを返します。他のフラグは無視されます。
-filterSourceType(-fst) string createqueryedit
このコマンド レポータの表示から、指定したソース タイプをフィルタリングします。現在は、「mel」、「python」または「」(既定)をサポートしています。フィルタに空の文字列(「」)を設定すると、すべてのフィルタリングが除去され、「mel」と「python」の両方の結果が表示されます。
-fullPathName(-fpn) query
すべての親を含むウィジェットのフル パス名を返します。
-hasFocus(-hf) query
現在このコントロールにフォーカスがあるかどうかです。
-height(-h) int createqueryedit
コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
-highlightColor(-hlc) float float float createqueryedit
コントロールのハイライト カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。
-isObscured(-io) query
コントロールが実際に表示されるかどうかを返します。コントロールは、次の場合に隠れた状態になります。非表示の場合、別のコントロールで(完全に、または部分的に)ブロックされた場合、コントロールまたは親のレイアウトを制御できない場合、あるいはコントロールのウィンドウが非表示またはアイコン化されている場合。
-lineNumbers(-ln) boolean createqueryedit
(エラー/警告メッセージで)行番号を表示します(グローバル パラメータ。すべてのコマンド レポータに影響します)。
-manage(-m) boolean createqueryedit
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。既定では、コントロールは管理できるように作成されます。
-noBackground(-nbg) boolean createedit
コントロールのバックグラウンドをクリア/リセットします。バックグラウンドは、true を渡すと一切描画されず、false を渡すと描画されます。このフラグの状態は、このコントロールの子に継承されます。
-numberOfPopupMenus(-npm) query
このコントロールにアタッチされるポップアップ メニューの数を返します。
-parent(-p) string createquery
コントロールの親のレイアウトです。
-pasteSelection(-pst) createedit
現在のキャレット位置で、このフィールドにテキストをペーストします。
-popupMenuArray(-pma) query
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
-preventOverride(-po) boolean createqueryedit
true の場合、コントロールの右マウス ボタン メニューを使用したコントロール アトリビュートのオーバーライドは無効になります。
-receiveFocusCommand(-rfc) script createedit
フィールドにフォーカスが移ったときに実行されるコマンドです。
-saveSelection(-sv) string createedit
現在の選択項目をファイルに保存することを求めるプロンプトを表示します。指定した文字列の前に既定のファイル名プロンプトが追加されます。
-saveSelectionToShelf(-svs) createedit
現在の選択項目をシェルフの項目に保存することを求めるプロンプトを表示します。
-select(-sl) uint uint createedit
指定範囲内のテキストを選択します。
-selectAll(-sla) createedit
すべてのテキストを選択します。
-stackTrace(-st) boolean createqueryedit
スタック トレースを表示します(グローバル パラメータ。すべてのコマンド レポータに影響します)。
-statusBarMessage(-sbm) string createedit
マウスがコントロール上にある場合にステータス バーに表示する追加の文字列です。
-suppressErrors(-se) boolean createqueryedit
エラーを表示しないようにします。
-suppressInfo(-si) boolean createqueryedit
情報を表示しないようにします。
-suppressResults(-sr) boolean createqueryedit
結果を表示しないようにします。
-suppressStackTrace(-sst) boolean createqueryedit
スタック トレースを表示しないようにします。
-suppressWarnings(-sw) boolean createqueryedit
警告メッセージを表示しないようにします。
-text(-t) string createqueryedit
フィールド テキストを指定した文字列に置き換えます。
-textLength(-tl) query
このテキスト フィールドの文字数です。
-useTemplate(-ut) string create
コマンドに、現在のものとは異なるコマンド テンプレートを使用するように強制します。
-visible(-vis) boolean createqueryedit
コントロールの可視の状態です。既定では、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。
-visibleChangeCommand(-vcc) script createqueryedit
コントロールの可視の状態が変更されたときに実行されるコマンドです。
-width(-w) int createqueryedit
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
フラグはコマンドの作成モードで表示できます フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます コマンド内でフラグを複数回使用できます。

MEL 例

// this will create a tiny window with a command history reporter
window;
    columnLayout;
        cmdScrollFieldReporter -width 200 -height 100;
showWindow;