Version: 2018.4
事件类型参考
支持 IMGUI

内置控件

UIElements 中内置了以下标准控件:

  • 按钮 (Button)
  • 上下文菜单 (Contextual menu)
  • 编辑器文本字段 (EditorTextField)
  • 标签 (Label)
  • 滚动视图 (ScrollView)
  • 文本字段 (TextField)
  • 开关 (Toggle)

上下文菜单

上下文菜单控件是根据上下文显示一组选项或操作的标准控件。此上下文通常适用于当前选择对象,但可包含任何内容。

本主题将说明如何添加上下文菜单,介绍其回调,并展示如何响应用户选择。

向视觉元素添加上下文菜单

要显示上下文菜单,请在回调中为触发上下文菜单显示的事件调用 ContextualMenuManager.DisplayMenu()

例如,要在松开鼠标右键时显示上下文菜单,请将以下代码添加到 OnMouseUpEvent 的回调中:

// 在 VisualElement 子类中
void OnMouseUpEvent(MouseUpEvent evt)
{
    if (elementPanel == null || elementPanel.contextualMenuManager == null)
        return;

    if (evt.button != MouseButton.RightMouse || evt.modifiers != EventModifiers.None)
        return;

    elementPanel.contextualMenuManager.DisplayMenu(evt, this);
    evt.StopPropagation();
    evt.PreventDefault();
}

在上面的例子中,ContextualMenuManager.DisplayMenu() 发送 ContextualMenuPopulateEvent 事件目标作为 DisplayMenu() 的第二个参数。此事件沿以下传播路径传播到视觉元素树:从视觉树的根到事件目标,再退回到视觉树的根。沿着传播路径,具有 ContextualMenuPopulateEvent 事件回调的元素可以在上下文菜单中添加、删除或修改菜单项。

上面的例子还展示了如何使用 StopPropagation,以及如何使用 PreventDefault() 来阻止元素显示。

要添加上下文菜单,请将 ContextualMenuManipulator 操控器添加到视觉元素。此操控器会添加一个回调,用于在发生鼠标右键按下事件或菜单键松开事件后显示上下文菜单。ContextualMenuManipulator 操控器还添加一个响应 ContextualMenuPopulateEvent 的回调。

此装入的回调还会调用委托来填充上下文菜单。应在实例化操控器时提供委托。以下代码示例展示了如何执行此操作:

void InstallManipulator(VisualElement element)
{
    ContextualMenuManipulator m = new ContextualMenuManipulator(MyDelegate);
    m.target = element;
}

void MyDelegate(ContextualMenuPopulateEvent event)
{
    // 修改 event.menu
    event.menu.AppendAction("Properties", DisplayProperties, DropdownMenu.MenuAction.AlwaysEnabled);
}

void DisplayProperties(DropdownMenu.MenuAction menuItem)
{
    // ...
}

响应用户选择

一个元素收到 ContextualMenuPopulateEvent 时会通过调用 DropdownMenu.InsertAction()DropdownMenu.AppendAction() 将菜单项添加到上下文菜单中。

这些函数中的每一个函数都采用两个回调作为参数。用户在菜单中选择菜单项时执行第一个回调。在显示菜单之前执行第二个回调。第二个回调还会检查菜单项是否已启用。

两个回调都接收一个 MenuAction 作为参数。MenuAction 代表菜单项,具有以下其他有用的属性:

  • MenuAction.userData 会引用可能已用于 AppendAction()InsertAction() 的用户数据。
  • MenuAction.eventInfo 包含触发上下文菜单显示的事件的 相关信息。应在响应事件的操作中使用 MenuAction.eventInfo。例如,可以使用鼠标位置根据所选的上下文菜单项创建和放置对象。

  • 2018–11–02 页面已修订并只进行了有限的编辑审查
事件类型参考
支持 IMGUI