Version: 2019.4
言語: 日本語
イベントの統合
ビルトインコントロール

イベントタイプリファレンス

ここでは、各イベントタイプの概要を説明します。各イベントメンバーの詳細な説明とその目的に関しては、スクリプトリファレンスを参照してください。

キャプチャイベント

IMouseCaptureEvent を実装するイベント

MouseCaptureEvent

MouseCaptureEvent は、要素がマウスキャプチャを取得するときに送信されます。

target: キャプチャを取得する要素

MouseCaptureOutEvent

MouseCaptureOutEvent は、要素がマウスキャプチャを解放したり、失うと送信されます。

target: キャプチャを失う要素

変更イベント

IChangeEvent を実装するイベント

ChangeEvent

ChangeEvent <T> は、要素の値が変化するときに送信されるジェネリックイベントです。これは、通常、コントロールが変更されるときに送信されます。InputEvent コントロールでは、このイベントはコントロール内のすべての入力イベントに対して送信されるのではなく、値が変更されるときにのみ送信されます。これは、通常、コントロールがフォーカスを失うか、Enter キーが押された場合です。

<T> 値の型

target 値が変化した要素

previousValue コントロールの古い値

newValue コントロールの新しい値

コマンドイベント

ICommandEvent を実装するイベント

target キーボードフォーカスのある要素。要素がフォーカスを持っていない場合は null。

commandName 検証または実行するコマンド

ValidateCommandEvent

このイベントは、コマンドがパネル内の要素によって処理されるかどうかを決定する間、IMGUI によって送信されます。

ExecuteCommandEvent

このイベントは、パネルの要素がコマンドを実行するときに IMGUI によって送信されます。

ドラッグアンドドロップイベント

ドラッグアンドドロップ操作中に送信されるイベント

DragExitedEvent

ドラッグアンドドロップ操作がキャンセルされ、ドロップターゲットがドラッグされた要素を受け取らなかった場合に送信されるイベント

DragUpdatedEvent

ドラッグされた要素がドロップターゲット上に移動しました。ドロップターゲットがドラッグされた要素を受け入れる場合は、このイベントのコールバックは DragAndDrop.visualMode を設定して、ユーザーがマウスボタンを離したときに DragPerformEvent が送信されるようにします。

DragPerformEvent

ドラッグされた要素は、それらを受領するターゲットにドロップされた場合に送信されるイベント。これで、ドラッグアンドドロップ操作が終了します。

DragEnterEvent

ドラッグされた要素が新しい VisualElement に入りました。特に、このイベントはドラッグ操作を開始したときに送信されます。

DragLeaveEvent

ドラッグされた要素は現在のドロップターゲットの外に出ます。特に、このイベントはドラッグ操作が終了したときに送信されます。

レイアウトイベント

GeometryChangedEvent

要素の位置またはサイズが変更されたときに送信されるイベントです。このタイプのイベントはイベントターゲットにのみ送信されます。それらは伝搬しません。

target 新しいジオメトリを持つ要素

oldRect 要素の以前の位置とサイズ

newRect 要素の新しい位置とサイズ

フォーカスイベント

IFocusEvent を実装するイベント

これらのイベントは、要素がキーボードフォーカスを得たり、失うときに送信されます。フォーカスイベントには 2 つのセットがあります。

  • FocusOutEventFocusInEvent はフォーカスの変更が発生する直前に、伝播経路に沿って送信されます。
  • FocusEventBlurEvent はフォーカスの変更が発生した直後に、イベントのターゲットにのみ送信されます。

FocusOutEvent

要素がフォーカスを失う直前に送信されるイベント

target フォーカスを失う要素

relatedTarget フォーカスを得る要素

FocusInEvent

要素がフォーカスを得る直前に送信されるイベント

target フォーカスを得る要素

relatedTarget フォーカスを失う要素

BlurEvent

要素がフォーカスを失った後に送信されるイベント

target フォーカスを失った要素

relatedTarget フォーカスを得た要素

FocusEvent

要素がフォーカスを得た後に送信されるイベント

target フォーカスを得た要素

relatedTarget フォーカスを失った要素

入力イベント

InputEvent

データがビジュアル要素 (通常はコントロール) に入力されるときに送信されるイベント。このイベントは、コントロールの値が変更されなくても、コントロールのすべての入力イベントに対して送信されるという点で ChangeEvent と異なります。

target 入力が発生した要素

previousData 以前のデータ

newData 新しいデータ

キーボードイベント

IKeyboardEvent を実装するイベント

KeyDownEvent

ユーザーがキーボードのキーを押下するときに送信されるイベント

target キーボードフォーカスを持つ要素。キーボードフォーカスを持つ要素がない場合は、パネルのルート要素。

KeyUpEvent

ユーザーがキーボードのキーを離すときに送信されるイベント

target キーボードフォーカスを持つ要素。キーボードフォーカスを持つ要素がない場合は、パネルのルート要素。

マウスイベント

IKeyboardEvent を実装するイベント

要素がマウスをキャプチャしている間、マウスイベントはキャプチャ要素にのみ送信されます。伝播はありません。

MouseDownEvent

ユーザーがマウスボタンの 1 つを押下するときに送信されるイベント

target ある要素がマウスのキャプチャを取得していた場合、マウスをキャプチャしている要素がターゲットになります。それ以外の場合は、カーソルの下の最も選択される可能性が高い要素がターゲットです。

MouseUpEvent

ユーザーがマウスボタンの 1 つを離すときに送信されるイベント

target ある要素がマウスのキャプチャを取得していた場合、マウスをキャプチャしている要素がターゲットになります。それ以外の場合は、カーソルの下の最も選択される可能性が高い要素がターゲットです。

MouseMoveEvent

ユーザーがマウスを動かすと送信されるイベント

target ある要素がマウスのキャプチャを取得していた場合、マウスをキャプチャしている要素がターゲットになります。それ以外の場合は、カーソルの下の最も選択される可能性が高い要素がターゲットです。

ContextClickEvent (古い機能)

ユーザーが 3 番目のマウスボタンを押下、離すときに送信されるイベント。このイベントは IMGUI との後方互換性のためにのみ存在します。

WheelEvent

ユーザーがマウスホイールをアクティブにするときに送信されるイベント

target ある要素がマウスのキャプチャを取得していた場合、マウスをキャプチャしている要素がターゲットになります。それ以外の場合は、カーソルの下の最も選択される可能性が高い要素がターゲットです。

MouseEnterWindowEvent

マウスがウィンドウに侵入するときに送信されるイベント

target ある要素がマウスのキャプチャを取得していた場合、マウスをキャプチャしている要素がターゲットになります。それ以外の場合は、カーソルの下の最も選択される可能性が高い要素がターゲットです。

MouseLeaveWindowEvent

マウスがウィンドウを離れるときに送信されるイベント

target 要素がマウスのキャプチャを得ていた場合、ターゲットはマウスをキャプチャしている要素です。そうでない場合は、カーソルが要素の上にないため null です。

MouseEnterEvent

マウスが要素またはその子孫の 1 つに侵入するときに送信されるイベント。このイベントはマウスが侵入する各要素に送信されるという点で、MouseOverEvent とは異なります。このイベントは伝播されません。

target マウスカーソルの下の要素、または、その子孫の 1 つ

MouseLeaveEvent

マウスが要素またはその子孫の 1 つから出るときに送信されるイベント。このイベントは、マウスが出ていく各要素に送信されるという点で、MouseOutEvent と異なります。このイベントは伝播されません。

target マウスカーソルが離れたばかりの要素、または、子孫の要素の 1 つ

MouseOverEvent

マウスが要素に侵入するときに送信されるイベントです。このイベントはマウスが侵入する要素にだけ送信されるという点で、MouseOverEvent とは異なります。このイベントは伝播されません。

target マウスカーソルの下にある要素。

MouseOutEvent

マウスが要素から出るときに送信されるイベントです。このイベントは、マウスが出ていく要素のみに送信されるという点で、MouseOutEvent と異なります。このイベントは伝播されます。

target マウスカーソルが離れたばかりの要素

ContextualMenuPopulateEvent

コンテキストメニューにメニューアイテムを設定する必要があるときに、ContextualMenuManager によって送信されるイベント

target コンテキストメニューが作成される要素。

パネルイベント

AttachToPanelEvent

要素が IPanel に設定された直後に送信されるイベント。パネルの設定は再帰的であるため、要素のすべての子孫もこのイベントを受信します。

target パネルに設定される要素

DetachFromPanelEvent

要素が IPanel から設定解除される直前に送信されるイベント。パネルの設定は再帰的であるため、要素のすべての子孫もこのイベントを受信します。

target パネルから設定解除される要素

ツールチップイベント

TooltipEvent

ツールチップが表示される直前に送信されるイベント。ハンドラーは TooltipEvent.tooltip 文字列と TooltipEvent.rect を設定します。

target ツールチップを表示する必要がある要素。

IMGUI イベント

IMGUIEvent

IMGUI 特有のイベントをカプセル化するために使用されるイベント


  • 2018–11–02 修正されたページ
イベントの統合
ビルトインコントロール