版本: Unity 6 (6000.0)
语言英语
  • C#

EditorToolbarToggle

UnityEditor.Toolbars 类中的类

/

继承自:UIElements.ToolbarToggle

建议更改

成功!

感谢您帮助我们改进 Unity 文档的质量。虽然我们无法接受所有提交的内容,但我们会阅读用户提出的每个更改建议,并在适用的情况下进行更新。

关闭

提交失败

由于某种原因,您的建议更改无法提交。请<a>稍后再试</a>。感谢您抽出时间帮助我们改进 Unity 文档的质量。

关闭

取消

描述

一个与 EditorToolbarElementAttribute 一起使用的切换。

静态属性

ussClassName用于设置 EditorToolbarToggle 样式的 USS 类名。

属性

icon与切换关联的图标。
offIcon当值为 false 时与切换关联的图标。
onIcon当值为 true 时与切换关联的图标。
text与切换关联的文本。
textIcon与切换关联的文本图标。

构造函数

EditorToolbarToggle构造函数。

公共方法

SetValueWithoutNotify允许设置值,而无需在有更改时收到通知。

继承的成员

静态属性

alignedFieldUssClassName在检查器元素中对齐的元素的 USS 类名。
labelDraggerVariantUssClassName当标签上附加了拖动器时,此类型元素中标签的 USS 类名。
mixedValueLabelUssClassName显示混合值的元素的 USS 类名。
noLabelVariantUssClassName当没有标签时,此类型元素的 USS 类名。
checkmarkUssClassName切换元素中图像的 USS 类名。
inputUssClassName切换元素中输入元素的 USS 类名。
labelUssClassName切换元素中标签的 USS 类名。
mixedValuesUssClassName具有混合值的切换元素的 USS 类名。
noTextVariantUssClassName没有文本的切换元素的 USS 类名。
textUssClassName切换元素中文本元素的 USS 类名。
ussClassName切换元素的 USS 类名。
ussClassName此类型元素的 USS 类名。
disabledUssClassName局部禁用的元素的 USS 类名。

属性

textBaseBoolField 后面出现的可选文本。
toggleOnLabelClick用户点击标签时是否激活切换。
label表示将出现在字段旁边的标签的字符串。
labelElement这是出现在字段输入旁边的标签对象。
mixedValueLabel用于呈现编辑多个不同值的只读标签。
rawValue元素的值。
showMixedValue设置为 true 时,使字段呈现出编辑多个不同值的样式。
value与字段关联的值。
binding将要更新的绑定对象。
bindingPath要绑定的目标属性的路径。
canGrabFocus如果元素可以获得焦点,则返回 true。
delegatesFocus元素是否应该将焦点委托给其子元素。
focusable如果元素可以获得焦点,则为 true。
focusController返回此元素的焦点控制器。
tabIndex用于在焦点环中对可获得焦点的元素进行排序的整数。必须大于或等于零。
childCount此对象 contentContainer 中的子元素数量。
contentContainer子元素将被添加到其中,通常与元素本身相同。
contentRect元素的内容区域的矩形,在元素的局部空间中。(只读)
customStyleVisualElement 的自定义样式属性访问器。(只读)
dataSource将数据源分配给此 VisualElement,该数据源会覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath从数据源到值的路径。
dataSourceType可以分配给此 VisualElement 的数据源的可能类型。此信息仅供 UI 生成器使用,作为提示,以便在设计时无法指定有效数据源时,为数据源路径字段提供一些自动完成。
disablePlayModeTint除非将此属性设置为 true,否则默认情况下会应用播放模式色调。它会按层次结构应用于此 VisualElement 以及其所有存在于编辑器面板上的子元素。
enabledInHierarchy如果 VisualElement 在其自身层次结构中启用,则返回 true。
enabledSelf如果 VisualElement 在本地启用,则返回 true。
experimental返回 UIElements 实验性接口。
generateVisualContent委托函数,用于生成视觉元素的视觉内容。
hierarchy访问此元素的物理层次结构。
languageDirection指示元素文本的方向性。此值将传播到元素的子元素。
layoutVisualElement 相对于其父元素的位置和大小,由布局系统计算。(只读)
localBound返回一个 Rect,表示应用变换后但应用布局平移前,轴对齐包围盒 (AABB)。
name此 VisualElement 的名称。
paddingRect元素的填充区域的矩形,在元素的局部空间中。
panel附加此 VisualElement 的面板。
parent此 VisualElement 的父元素。
pickingMode确定此元素是否可以在鼠标事件或 IPanel.Pick 查询期间被拾取。
resolvedStyle视觉元素的最终渲染样式值,如当前帧中渲染的那样。(只读)
scaledPixelsPerPoint返回面板的缩放比例,该比例考虑了屏幕 DPI 和可自定义的缩放因子,但不考虑元素及其祖元素的变换缩放。请参阅 Panel.scaledPixelsPerPoint。这应该仅在属于面板的元素上调用。
schedule检索此 VisualElement 的 IVisualElementScheduler
style设置 VisualElement 上的样式值。
styleSheets返回一个 VisualElementStyleSheetSet,它可以操作附加到此元素的样式表。
this[int]检索特定索引处的子元素。
tooltip在用户将鼠标悬停在元素上短时间后,在信息框中显示的文本。这仅在编辑器 UI 中受支持。
transform返回此 VisualElement 的变换对象。ITransform
usageHints指定 VisualElement 的高级预期使用模式的提示值组合。此属性只能在 VisualElement 尚未成为面板的一部分时设置。一旦成为面板的一部分,此属性将变得实际上只读,尝试更改它会引发异常。正确指定 UsageHints 会使系统能够更好地决定如何处理或加速某些操作,具体取决于预期的使用模式。请注意,这些提示不会影响行为或视觉结果,只会影响面板和面板内元素的整体性能。建议始终考虑指定正确的 UsageHints,但请记住,某些 UsageHints 可能在某些情况下被内部忽略(例如,由于目标平台的硬件限制)。
userData此属性可用于将特定于应用程序的用户数据与此 VisualElement 关联。
viewDataKey用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。
visible指示此元素是否应该被渲染。
visualTreeAssetSource存储资产引用,如果生成的元素是从 VisualTreeAsset 克隆的。
worldBound返回一个 Rect,表示应用世界变换后,轴对齐包围盒 (AABB)。
worldTransform返回一个矩阵,该矩阵累积了以下操作(按顺序):-局部缩放 -局部旋转 -局部平移 -布局平移 -父世界变换(递归定义 - 如果没有父元素,则考虑为恒等矩阵)

公共方法

SetValueWithoutNotify允许设置值,而无需在有更改时收到通知。
HasBubbleUpHandlers如果已将事件传播 BubbleUp 阶段的事件处理程序附加到此对象,则返回 true。
HasTrickleDownHandlers如果已将事件传播 TrickleDown 阶段的事件处理程序附加到此对象,则返回 true。
RegisterCallback将事件处理程序添加到实例。如果事件处理程序已为相同阶段(TrickleDown 或 BubbleUp)注册,则此方法无效。
RegisterCallbackOnce将事件处理程序添加到实例。如果事件处理程序已为相同阶段(TrickleDown 或 BubbleUp)注册,则此方法无效。事件处理程序将在完全调用一次后自动取消注册。
UnregisterCallback从实例中删除回调。
Blur告诉元素释放焦点。
Focus尝试将焦点赋予此元素。
Add将元素添加到此元素的 contentContainer
AddToClassList将类添加到元素的类列表中,以便从 USS 分配样式。请注意,类名区分大小写。
BringToFront将此元素移至其父元素子元素列表的末尾。该元素将位于任何重叠的同级元素的前面。
Children返回其 contentContainer 中的元素。
ClassListContains在元素的类列表中搜索类。
Clear从此元素的 contentContainer 中删除所有子元素。
ClearBinding从元素中删除绑定。
ClearBindings从元素中删除所有绑定。
ClearClassList从此元素的类列表中删除所有类。AddToClassList
Contains检查此元素是否是指定子元素的祖元素。
ContainsPoint检查指定点是否与此 VisualElement 的布局相交。
ElementAt检索特定索引处的子元素。
EnableInClassList启用或禁用具有给定名称的类。
FindAncestorUserData向上搜索此 VisualElement 的层次结构,并检索存储的 userData(如果找到)。
FindCommonAncestor在 VisualTree 层次结构中找到两个 VisualElement 之间的最低共同祖元素。
GetBinding获取提供的目标属性的绑定实例。
GetBindingInfos获取当前元素所有绑定的信息。
GetClasses检索此元素的类。
GetDataSourceContext查询绑定对象的 dataSource 和 dataSourcePath。
GetFirstAncestorOfType从此元素的父元素开始向上遍历层次结构,并返回此类型的第一个 VisualElement。
GetFirstOfType从此元素开始向上遍历层次结构,并返回此类型的第一个 VisualElement。
GetHierarchicalDataSourceContext查询从层次结构继承的 dataSource 和 dataSourcePath。
HasBinding允许知道目标属性是否与之关联了绑定。
IndexOf检索指定 VisualElement 的子元素索引。
插入将元素插入到此元素的 contentContainer 中。
MarkDirtyRepaint在下一帧触发 VisualElement 的重绘。当发生需要重绘的更改时,此方法会在内部调用,例如当 UIElements.BaseField_1.value 发生更改或 Label 中的文本发生更改时。如果您正在实现自定义控件,则可以在发生需要重绘的更改时调用此方法以触发重绘,例如当使用 generateVisualContent 渲染网格且网格数据已更改时。
PlaceBehind将此元素放置在其父级子级列表中同级元素的正前方。如果元素和同级元素的位置重叠,则该元素将位于同级元素的视觉后方。
PlaceInFront将此元素放置在其父级子级列表中同级元素的正后方。如果元素和同级元素的位置重叠,则该元素将位于同级元素的视觉前方。
移除从此元素的 contentContainer 层次结构中移除此子级。
RemoveAt从此元素的 contentContainer 中移除位于此位置的子级元素。
RemoveFromClassList从元素的类列表中移除一个类。
RemoveFromHierarchy从此元素的父级层次结构中移除此元素。
SendEvent向事件处理程序发送事件。
SendToBack将此元素发送到其父级子级列表的开头。该元素将位于任何重叠的同级元素的视觉后方。
SetBinding在目标和源之间分配绑定。
SetEnabled更改 VisualElement 的启用状态。禁用的 VisualElement 不会接收大多数事件。
排序重新排序从此 VisualElement contentContainer 中的子级元素。
ToggleInClassList在将给定类名添加到类列表和从中移除类名之间切换。
TryGetBinding获取提供的目标属性的绑定实例。
TryGetDataSourceContext查询绑定对象的 dataSource 和 dataSourcePath。
TryGetLastBindingToSourceResult返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
TryGetLastBindingToUIResult返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护方法

InitLabel每当 BaseBoolField.text 属性发生变化时,都会初始化 Label 元素。
ToggleValue反转 BaseBoolField.value 属性。
UpdateMixedValueContent根据 showMixedValue 更新字段的视觉内容。
HandleEventBubbleUp在 BubbleUp 阶段在此元素上执行逻辑,紧接在此元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
HandleEventTrickleDown在 TrickleDown 阶段在此元素上执行逻辑,紧接在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
NotifyPropertyChanged通知数据绑定系统,控件的某个属性已更改。