dockControl command

概要

dockControl [-allowedArea string] [-annotation string] [-area string] [-backgroundColor float float float] [-content string] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-enable boolean] [-enableBackground boolean] [-enablePopupOption boolean] [-exists] [-floatChangeCommand script] [-floating boolean] [-fullPathName string] [-height int] [-isObscured] [-label string] [-manage boolean] [-numberOfPopupMenus] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-raise] [-useTemplate string] [-visible boolean] [-visibleChangeCommand script] [-width int] [name]

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

ドック可能なコントロールを作成します。これはツールパレットまたはユーティリティウィンドウとも呼ばれます。ドックコントロールは、メインウィンドウの中央コントロールの周囲のドック領域に配置される補助的なウィンドウです。ドックウィンドウは、現在の領域より内側へ移動したり、新しい領域へ移動したり、あるいはフロート状態にする（例: 固定しない）ことができます。ドックコントロールはタイトルバーと内容領域からなります。タイトルバーにはドックコントロールウィンドウのタイトル、フロートボタン、閉じるボタンが表示されます。ドックコントロールの状態に応じて、フロートボタンと閉じるボタンはどちらかが無効になるか、または全く表示されません。

戻り値

string

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

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

フラグ

allowedArea, annotation, area, backgroundColor, content, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, enablePopupOption, exists, floatChangeCommand, floating, fullPathName, height, isObscured, label, manage, numberOfPopupMenus, parent, popupMenuArray, preventOverride, raise, useTemplate, visible, visibleChangeCommand, width

ロングネーム（ショートネーム） 引数型 プロパティ

-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 に指定していない限り、バックグラウンドは自動的に有効になります。

-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

すべての親を含むウィジェットのフルパス名を返します

-label(-l) string

ラベルテキストです。デフォルトのラベルはコントロールの名前です。

-allowedArea(-aa) string

ドックコントロールが配置される領域です。有効な値は「top」、「left」、「bottom」、「right」、「all」です。デフォルトは「all」です。

-floating(-fl) boolean

ドックウィジェットをフロート状態にするかどうかを定義します。フローティングドックウィジェットは、メインウィンドウに固定されずに、メインウィンドウの「最上部」に独立したウィンドウとして表示されます。

-floatChangeCommand(-fcc) script

スクリプトは、ドックウィジェットのフロート状態を変更した時に実行されます。

-area(-a) string

このドックコントロールの最初のドック領域です。これは必須フラグです。

-content(-con) string

コントロールの名前で、このドックコントロールの内容を示します。これは必須フラグです。

-enablePopupOption(-epo) boolean

UI 要素のポップアップメニューのドックコントロールのメニューオプションが有効になっているかどうかを示します。

-raise(-r)

ドックウィジェットが表示されているかどうか、そしてフローティングになっているか、あるいはドックウィジエット領域の上部にあるかどうかを示します。

: コマンドの作成モードで使用可能なフラグ	: コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ	: 1 つのコマンドで複数回使用可能なフラグ

MEL 例

string $myWindow = `window`;
string $buttonForm = `formLayout -parent $myWindow`;
button -parent $buttonForm;
dockControl -area "left"
        -content $myWindow
        -allowedArea "left"
        -allowedArea "right";

コマンド (MEL)	Python バージョン
dockControl	カテゴリ: ウィンドウ, レイアウト