コマンドイベントは、Unity エディターがトップレベルのメニューアクションと同等のキーボードショートカットを、エディター UI に転送するために送られます。
利用可能なコマンドは以下の通りです。
Copy
Cut
Paste
Delete
SoftDelete
Duplicate
FrameSelected
FrameSelectedWithLock
SelectAll
Find
FocusProjectWindow
イベント | 説明 | 下降伝播 | 上昇伝播 | キャンセル可能 |
---|---|---|---|---|
ValidateCommandEvent | エディターは、パネル内のエレメントがコマンドを処理するかどうかを決定するときに、このイベントを送信します。 | ✔ | ✔ | ✔ |
ExecuteCommandEvent | パネル内のエレメントがコマンドを実行すると、エディターはこのイベントを送信します。 | ✔ | ✔ | ✔ |
ターゲット
: キーボードフォーカスのある要素。フォーカスを持つ要素がない場合、値は null
。
commandName
: 検証または実行するコマンド。
ValidateCommandEvent
イベントは、EditorWindow にコマンドを実行できるかどうかを尋ねます。例えば、エディターは ValidateCommandEvent の結果に基づいて、メニュー項目を有効にしたり無効にしたりすることができます。
エディターがコマンドを実行できるかどうかを確認します。
ValidateCommandEvent
のコールバックを登録します。commandName
プロパティをテストします。Event.StopPropogation()
メソッドを呼び出します。ExecuteCommandEvent
イベントはエディターウィンドウにコマンドの実行を要求します。
このイベントが検証イベントの後に続くとしても、前の検証とは関係なく、最初にアクションが可能であることを確認するのが効率的な実践方法です。
コマンドに応答するには、以下を行います。
ExecuteCommandEvent
のコールバックを登録します。commandName
プロパティをテストする。Event.StopPropogation()
メソッドを呼び出します。エディターはコメントが実行されたことを知ることができます。次の例では、カスタムのエディターウィンドウでのコピーアンドペーストをサポートするためにコマンドイベントを使用します。この例では、カスタムのエディターウィンドウに果物のリストを表示します。ユーザーはキーボードショートカットを使って、任意の果物をコピーアンドペーストすることができます。
using System;
using System.Collections.Generic;
using System.Linq;
using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;
public class CopyPasteExample : EditorWindow
{
[MenuItem("Window/UI Toolkit Examples/CopyPasteExample")]
public static void Show()
{
GetWindow<CopyPasteExample>();
}
readonly List<string> fruits = new ()
{
"Banana",
"Apple",
"Lime",
"Orange"
};
ListView m_ListView;
public void CreateGUI()
{
Func<VisualElement> makeItem = () => new Label();
Action<VisualElement, int> bindItem = (e, i) => (e as Label).text = fruits[i];
m_ListView = new ListView();
m_ListView.makeItem = makeItem;
m_ListView.bindItem = bindItem;
m_ListView.itemsSource = fruits;
m_ListView.selectionType = SelectionType.Single;
m_ListView.RegisterCallback<ValidateCommandEvent>(OnValidateCommand);
m_ListView.RegisterCallback<ExecuteCommandEvent>(OnExecuteCommand);
rootVisualElement.Add(m_ListView);
}
void OnExecuteCommand(ExecuteCommandEvent evt)
{
if (evt.commandName == "Copy" && m_ListView.selectedIndices.Count() > 0)
{
EditorGUIUtility.systemCopyBuffer = fruits[m_ListView.selectedIndex];
evt.StopPropagation();
}
else if (evt.commandName == "Paste" && !string.IsNullOrEmpty(EditorGUIUtility.systemCopyBuffer))
{
fruits.Add(EditorGUIUtility.systemCopyBuffer);
m_ListView.RefreshItems();
evt.StopPropagation();
}
}
void OnValidateCommand(ValidateCommandEvent evt)
{
if (evt.commandName == "Copy" && m_ListView.selectedIndices.Count() > 0)
{
evt.StopPropagation();
}
else if (evt.commandName == "Paste" && !string.IsNullOrEmpty(EditorGUIUtility.systemCopyBuffer))
{
evt.StopPropagation();
}
}
}
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.