Version: 6000.3
语言: 中文
工具栏痕迹导航
工具栏菜单

工具栏按钮

ToolbarButton 是一个仅限编辑器的控件,用作工具栏Unity 编辑器顶部的一排按钮和基本控件,允许您以各种方式(例如缩放、平移)与编辑器交互。更多信息
请参阅术语表
.它是一个具有与工具栏样式匹配的预定义样式的按钮

创建 ToolbarButton

你可以使用 UI Builder、UXML 或 C# 创建 ToolbarButton。以下 C# 示例创建带有标签和单击回调的 ToolbarButton:

using UnityEngine;
using UnityEditor;
using UnityEditor.UIElements;

public class ToolbarExample : EditorWindow
{
    [MenuItem("Window/Toolbar Example")]
    public static void ShowExample()
    {
        GetWindow<ToolbarExample>("Toolbar Example");
    }

    void CreateGUI()
    {
        // Create a Toolbar
        var toolbar = new Toolbar();

        // Create the first ToolbarButton
        var button1 = new ToolbarButton(() => { Debug.Log("First button clicked"); }) { text = "Button 1" };

        // Create the second ToolbarButton
        var button2 = new ToolbarButton(() => { Debug.Log("Second button clicked"); }) { text = "Button 2" };

        // Add the buttons to the toolbar
        toolbar.Add(button1);
        toolbar.Add(button2);

        // Add the toolbar to the window's rootVisualElement
        rootVisualElement.Add(toolbar);
    }
}

C# 基类和命名空间

C# 类ToolbarButton
命名空间UnityEditor.UIElements
基类Button

继承的UXML属性

此元素从其基类继承以下属性:

名字 类型 描述
binding-path string 要绑定的目标属性的路径。
display-tooltip-when-elided boolean 如果为 true,则工具提示显示省略文本的完整版本,并且如果之前提供了工具提示,则该工具提示将被覆盖。
double-click-selects-word boolean 控制是否双击选择鼠标指针下的单词。
emoji-fallback-support boolean 指定系统在呈现文本时查找表情符号字符的顺序。如果启用此设置,则将首先在全局表情符号回退列表中搜索在 Unicode 14.0 标准中定义为表情符号的字符。
enable-rich-text boolean 如果为 false,则不会解析富文本标记。
focusable boolean 如果为 false,则不会聚焦元素。

只有当元素的 canGrabFocus 属性为 true 时,才能聚焦该元素。
icon-image Object 纹理,精灵A 2D 图形对象。如果你习惯于在3D中工作,精灵本质上只是标准纹理,但有一些特殊的技术可以组合和管理精灵纹理,以提高开发过程中的效率和便利性。更多信息
请参阅术语表
或 VectorImage,它将表示 Button 元素中的图标。
parse-escape-sequences boolean 确定转义序列的显示方式。当设置为true、转义序列(例如\n,\t)被解析并转换为其相应的字符。例如,'\n' 将插入一行新行。当设置为false,转义序列显示为原始文本(例如,\n显示为字符 '' 后跟 'n')。
selectable boolean 如果字段可选择,则返回 true。
tabindex int 用于对焦点环中的可聚焦元素进行排序的整数。必须大于或等于零。

设置
tabIndex值小于0(例如,−1) 从焦点环和选项卡导航中删除元素。
text string 发短信
triple-click-selects-line boolean 控制三次单击是否选择鼠标指针下的整行。

此元素还继承了以下属性VisualElement:

名字 类型 描述
content-container string 添加子元素的逻辑容器。如果将子项添加到此元素,则该子项将改为添加到此元素的内容容器中。

迭代
VisualElement.Children元素的,则使用元素的内容容器层次结构而不是元素本身。这可能会导致意外结果,例如,如果元素不直接位于内容容器的层次结构中,则导航事件会忽略元素。指IFocusRing了解更多信息。

如果内容容器与元素本身相同,则子元素将直接添加到元素中。对于大多数元素来说都是如此,但可以被更复杂的类型覆盖。

ScrollView例如,具有与自身不同的内容容器。在这种情况下,添加到滚动视图的子元素将改为添加到其内容容器元素中。虽然物理父级 (VisualElement.Hierarchy.parent) 是滚动视图的内容容器元素,它们的逻辑父元素 (VisualElement.parent) 仍然引用滚动视图本身。由于滚动视图的一些可聚焦子项不是其逻辑层次结构的一部分,例如Scroller元素,在使用顺序导航时,默认情况下不考虑这些可聚焦的子项。如果默认导航规则与您的需求不符,请参阅如何更改接下来关注的元素,了解解决方法解决方案的示例。
data-source Object 将数据源分配给此 VisualElement,该 VisualElement 将替代任何继承的数据源。此数据源由所有子级继承。
data-source-path string 从数据源到值的路径。
data-source-type System.Type 可分配给此 VisualElement 的可能数据源类型。
当设计时无法指定有效数据源时,UI 生成器仅将
此信息用作提示,以对数据源路径字段进行一些补全。
enabled boolean 如果VisualElement在本地启用。
如果 VisualElement 的父级之一隐式禁用,则
不会更改此标志。要验证这一点,请使用
enabledInHierarchy.
language-direction UIElements.LanguageDirection 指示元素文本的方向性。该值将传播到元素的子项。

设置
languageDirectionRTL只能获得文本反转等基本的 RTL 支持。要获得更全面的 RTL 支持,例如换行、自动换行或文本整形,您必须启用高级文本生成器
name string 此 VisualElement 的名称。

使用此属性可以编写面向特定元素的 USS 选择器。标准做法是为元素指定一个唯一的名称。
picking-mode UIElements.PickingMode 确定此元素是可以作为指针事件的目标还是由IPanel.Pick查询。

如果出现以下情况,则无法拾取元素:

- 它们不可见- 它们的
style.display设置为DisplayStyle.None

拾取模式为PickingMode.Ignore永远不要接收悬停伪状态。
style string VisualElement.
返回
的样式数据是根据 USS 文件或在 C# 中写入此对象的内联样式计算得出的,不表示完全解析的样式,例如 VisualElement 的最终高度和宽度。要访问这些完全解析的样式,请使用
resolvedStyle.



有关如何使用此属性和所有受支持的 USS 属性的信息,请参阅在 C# 脚本中应用样式USS 属性参考手册页。
tooltip string 用户将鼠标悬停在元素上一小段时间后,要在信息框内显示的文本。这仅在编辑器UI中受支持。
usage-hints UIElements.UsageHints 提示值的组合,用于指定VisualElement.只有当VisualElement还不是Panel.曾经是Panel,则此属性实际上变为只读,尝试更改它将引发异常。适当的规范UsageHints驱动系统根据预期的使用模式就如何处理或加速某些作做出更好的决策。请注意,这些提示不会影响行为或视觉结果,而只会影响面板和其中元素的整体性能。建议始终考虑指定适当的UsageHints,但请记住,某些UsageHints在某些情况下(例如,由于目标平台上的硬件限制),可能会在内部忽略。
view-data-key string 用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。

此键用于从视图数据存储中保存和加载视图数据。如果未设置此键,则会禁用关联的持久性
VisualElement.有关更多信息,请参阅 Unity 手册中的查看数据持久性

USS 级

下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。

C# 属性 USS 选择器 描述
ussClassName .unity-toolbar-button 此类元素的 USS 级名称。
ussClassName .unity-button 此类元素的 USS 级名称。

Unity 将此 USS 类添加到 Button 元素的每个实例中。应用于此类的任何样式都会影响位于可视化树中样式表旁边或下方的每个按钮。
iconUssClassName .unity-button--with-icon 带有图标的 Button 元素的 USS 类名称。

Unity 会将此 USS 类添加到 Button 元素的实例中,如果该实例的
Button.iconImage属性包含有效的纹理。应用于此类的任何样式都会影响可视化树中样式表旁边或下方的每个带有图标的按钮。
iconOnlyUssClassName .unity-button--with-icon-only Button 元素的 USS 类名称,仅带有图标,没有文本。

Unity 会将此 USS 类添加到 Button 元素的实例中,如果该实例的
Button.iconImage属性包含有效的纹理,并且未设置任何文本。应用于此类的任何样式都会影响可视化树中样式表旁边或下方的每个带有图标的按钮。
ussClassName .unity-text-element 此类元素的 USS 级名称。
selectableUssClassName .unity-text-element__selectable 可选文本元素的 USS 类名称。
disabledUssClassName .unity-disabled 本地禁用元素的 USS 级名称。

您还可以使用 Inspector 或 UI Toolkit Debugger 中的 Matching Selectors 部分来查看哪些 USS 选择器会影响VisualElement在其层次结构的各个层面。

其他资源

工具栏痕迹导航
工具栏菜单