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

概要

textField [-alwaysInvokeEnterCommandOnReturn boolean] [-annotation string] [-backgroundColor float float float] [-changeCommand script] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-editable boolean] [-enable boolean] [-enableBackground boolean] [-enterCommand script] [-exists] [-fileName string] [-font string] [-fullPathName string] [-height int] [-insertText string] [-insertionPosition int] [-isObscured] [-manage boolean] [-noBackground boolean] [-numberOfPopupMenus] [-parent string] [-placeholderText string] [-popupMenuArray] [-preventOverride boolean] [-receiveFocusCommand script] [-text string] [-useTemplate string] [-visible boolean] [-visibleChangeCommand script] [-width int] [string]

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

テキスト フィールド コントロールを作成します。

戻り値

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

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

フラグ

alwaysInvokeEnterCommandOnReturn, annotation, backgroundColor, changeCommand, defineTemplate, docTag, dragCallback, dropCallback, editable, enable, enableBackground, enterCommand, exists, fileName, font, fullPathName, height, insertText, insertionPosition, isObscured, manage, noBackground, numberOfPopupMenus, parent, placeholderText, popupMenuArray, preventOverride, receiveFocusCommand, text, useTemplate, visible, visibleChangeCommand, 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
すべての親を含むウィジェットのフル パス名を返します。
-text(-tx) string createqueryedit
フィールド テキストです。
-placeholderText(-pht) string createqueryedit
このプロパティを設定すると、テキスト フィールドが空でウィジェットにフォーカスがない限り、ライン編集にはグレー表示のプレースホルダ テキストが表示されます。このプロパティには既定で空の文字列が含まれます。
-fileName(-fi) string createqueryedit
ファイル名としてフィールドにあるテキストです。これは、内部と外部の間で(UI)ファイル表現を変換します。
-font(-fn) string createqueryedit
テキストのフォントです。有効な値は、「boldLabelFont」、「smallBoldLabelFont」、「tinyBoldLabelFont」、「plainLabelFont」、「smallPlainLabelFont」、「obliqueLabelFont」、「smallObliqueLabelFont」、「fixedWidthFont」、「smallFixedWidthFont」です。
-insertText(-it) string createedit
現在の挿入位置で、フィールドにテキストを挿入します(-ip/insertionPosition flag で指定します)。
-insertionPosition(-ip) int createqueryedit
挿入テキストの挿入位置です。これは 1 をベースにした値です。つまり、位置 1 はフィールドの先頭を示します。位置 0 を使用してフィールドの最後を指定することもできます。
-editable(-ed) boolean createqueryedit
フィールドの編集状態です。既定では、このフラグは true に設定され、これに入力することでフィールド値を変更することができます。false の場合は、フィールドは「読み取り専用」になるので、フィールドに入力することはできません。フィールドのテキストは、-ed/editable フラグの状態にかかわらず、常に -tx/text フラグを使用して変更できます。
-changeCommand(-cc) script createedit
フィールド テキストが変更されたときに実行されるコマンドを指定します。-tx/text フラグを使用して値を変更した場合は、このコマンドは呼び出されません。
-enterCommand(-ec) script createedit
キーパッドの「Enter」キーが押されたときに実行されるコマンドです。
-receiveFocusCommand(-rfc) script createedit
フィールドにフォーカスが移ったときに実行されるコマンドです。
-alwaysInvokeEnterCommandOnReturn(-aie) boolean createqueryedit
常に enter コマンドを起動するか、ユーザが Return キーを押したときのみ起動するかを設定します。
既定では、このオプションは false です。
フラグはコマンドの作成モードで表示できます フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます コマンド内でフラグを複数回使用できます。

MEL 例

//    Create a window with a some fields for entering text.
//
string $window = `window`;
rowColumnLayout -numberOfColumns 2 -columnAttach 1 "right" 0
    -columnWidth 1 100 -columnWidth 2 250;
text -label "Name";
string $name = `textField`;
text -label "Address";
string $address = `textField`;
text -label "Phone Number";
string $phoneNumber = `textField`;
text -label "Email";
string $email = `textField`;
//    Attach commands to pass focus to the next field if the Enter
//    key is pressed. Hitting just the Return key will keep focus
//    in the current field.
//
textField -edit -enterCommand ("setFocus " + $address) $name;
textField -edit -enterCommand ("setFocus " + $phoneNumber) $address;
textField -edit -enterCommand ("setFocus " + $email) $phoneNumber;
textField -edit -enterCommand ("setFocus " + $name) $email;
showWindow $window;