UI Toolkit は、ユーザーが UI Toolkit の要素と相互作用しそれらの要素の状態を変更すると、イベントを送信します。例えば、以下のアクションはすべてそれに関連しています。
イベントのデザインは、HTML 要素の Event インターフェース と似ています。
イベントタイプは、EventBase クラスに基づく階層に当てはまります。各イベントファミリーは、同じファミリーのすべてのイベントに共通の特性を定義するインターフェースを実装します。例えば、BlurEvent と FocusEvent は、FocusEventBase クラスを使用します。
イベント、親クラスに関する詳しい情報と、API スクリプトリファレンスは、下記のリストのリンクを参照してください。
以下の表は、各イベントタイプの簡単な概要です。イベントの詳細については、上記のページを参照してください。
| イベントタイプ | 説明 | トリクルダウン (下降) 伝播 | バブルアップ (上昇) 伝播 | キャンセル可能 | |
|---|---|---|---|---|---|
| キャプチャイベント | |||||
| MouseCaptureEvent | 要素がマウスキャプチャを取得したときに送信されます。 | 可 | 可 | ||
| MouseCaptureOutEvent | 要素がマウスキャプチャを解除したり、失うときに送信されます。 | 可 | 可 | ||
| PointerCaptureEvent | 要素がポインターを捉えるときに送信されます。 | 可 | 可 | ||
| PointerCaptureOutEvent | 要素がポインターをリリースするときに送信されます。 | 可 | 可 | ||
| Change イベント | |||||
| ChangeEvent | 要素の値が変化するときに送られる一般的なイベントです。 | 可 | 可 | ||
| コマンドイベント | |||||
| ValidateCommandEvent | IMGUI は、コマンドがパネルの要素によって処理されるかどうかを判別する間に、このイベントを送信します。 | 可 | 可 | 可 | |
| ExecuteCommandEvent | IMGUI は、パネルの要素がコマンドを実行する必要があるときにこのイベントを送信します。 | 可 | 可 | 可 | |
| ドラッグイベント | |||||
| DragExitedEvent | ドラッグアンドドロップ処理の終了時に送信されます。 | 可 | 可 | ||
| DragUpdatedEvent | ドラッグされた要素がドロップするターゲットの上に移動するときに送信されます。 | 可 | 可 | 可 | |
| DragPerformEvent | ドラッグされた要素が受け入れ可能なターゲットにドロップされたときに送信されます。 | 可 | 可 | 可 | |
| DragEnterEvent | ドラッグされた要素が新しい VisualElement に入りました。このイベントはドラッグ操作を開始するときに送信されます。 |
可 | |||
| DragLeaveEvent | ドラッグされた要素が現在のドロップターゲットの外に出ました。このイベントはドラッグ操作が終了するときに送信されます。 | 可 | |||
| フォーカスイベント | |||||
| FocusOutEvent | 要素がフォーカスを失う前に送信されます。 | 可 | 可 | ||
| FocusInEvent | 要素がフォーカスを得る前に送信されます。 | 可 | 可 | ||
| BlurEvent | 要素がフォーカスを失った後に送信されます。 | 可 | |||
| FocusEvent | 要素がフォーカスを得た後に送信されます。 | 可 | |||
| IMGUI イベント | |||||
| IMGUIEvent | IMGUI 特有のイベントをカプセル化するために送信されます。 | 可 | 可 | 可 | |
| Input イベント | |||||
| InputEvent | ビジュアル要素 (通常は、コントロール) にデータが入力されるときに送信されます。 | ||||
| キーボードイベント | |||||
| KeyDownEvent | ユーザーがキーボードのキーを押下するときに送信されます。 | 可 | 可 | 可 | |
| KeyUpEvent | ユーザーがキーボードのキーをリリースするときに送信されるイベント | 可 | 可 | 可 | |
| レイアウトイベント | |||||
| GeometryChangedEvent | 要素の位置または寸法のいずれかが変更されるときに送信されます。 | ||||
| マウスイベント | |||||
| MouseDownEvent | ユーザーがマウスボタンを押すときに送信されます。 | 可 | 可 | 可 | |
| MouseUpEvent | ユーザーがマウスボタンを離すときに送信されます。 | 可 | 可 | 可 | |
| MouseMoveEvent | ユーザーがマウスを動かすと送信されます。 | 可 | 可 | 可 | |
| WheelEvent | ユーザーがマウスホイールをアクティブにすると送信されます。 | 可 | 可 | 可 | |
| MouseEnterWindowEvent | マウスがウィンドウに入るときに送信されます。 | Yes | |||
| MouseLeaveWindowEvent | マウスがウィンドウを離れるときに送信されます。 | Yes | |||
| MouseEnterEvent | マウスが要素またはその子孫に入るときに送信されます。 | 可 | 可 | ||
| MouseLeaveEvent | マウスが要素またはその子孫から離れるときに送信されます。 | 可 | 可 | ||
| MouseOverEvent | マウスが要素に入るときに送信されます。 | 可 | 可 | 可 | |
| MouseOutEvent | マウスが要素から離れるときに送信されます。 | 可 | 可 | 可 | |
| ContextClickEvent (廃止予定) | ユーザーが第 3 のマウスボタンを押して離すときに送信されます。IMGUI との後方互換性のために存在します。 | 可 | 可 | 可 | |
| ポインターイベント | |||||
| PointerDownEvent | ポインターを押すときに送信されます。 | 可 | 可 | 可 | |
| PointerUpEvent | ポインターをリリースするときに送信されます。 | 可 | 可 | 可 | |
| PointerMoveEvent | ポインターの状態が変化するときに送信されます。 | 可 | 可 | 可 | |
| PointerEnterEvent | ポインターがビジュアル要素またはその子孫に入るときに送信されます。 | 可 | 可 | ||
| PointerLeaveEvent | ポインターがビジュアル要素とその子孫すべてから離れるときに送信されます。 | 可 | 可 | ||
| PointerOverEvent | ポインターがビジュアル要素に入るときに送信されます。 | 可 | 可 | 可 | |
| PointerOutEvent | ポインターがビジュアル要素から離れるときに送信されます。 | 可 | 可 | 可 | |
| PointerStationaryEvent | タッチペンや指などのポインタータイプが、OS で決められた一定時間変化しない場合に送信されます。 | 可 | 可 | 可 | |
| PointerCancelEvent | ポインターの動作が OS によってキャンセルされるときに送信されます。 | 可 | 可 | 可 | |
| パネルイベント | |||||
| AttachToPanelEvent | 要素がパネルにアタッチされた直後に送信されます。 | ||||
| DetachFromPanelEvent | 要素がパネルから外される直前に送信されます。 | ||||
| ツールチップイベント | |||||
| TooltipEvent | Tooltip が表示される直前に送信されます。 | 可 | 可 | 可 |