ToolbarButton
ToolbarButton — это элемент управления, доступный только в Editor, который используется как кнопка на Панель инструментов. Это Кнопка с предопределённым стилем, соответствующим стилю Toolbar.
Создать ToolbarButton
Вы можете создать ToolbarButton с помощью UI Builder, UXML или C#. Следующий пример 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, то tooltip отображает полную версию элидируемого текста, а также, если tooltip был ранее предоставлен, он будет перезаписан. |
double-click-selects-word |
boolean |
Управляет тем, выбирает ли двойной щелчок слово под указателем мыши. |
emoji-fallback-support |
boolean |
Указывает порядок, в котором система должна искать символы Emoji при отображении текста. Если этот параметр включен, поиск в глобальном резервном списке Emoji будет осуществляться сначала для символов, определенных как Emoji в стандарте Unicode 14.0. |
enable-rich-text |
boolean |
Если установлено false, богатые текстовые теги не будут анализироваться. |
focusable |
boolean |
Если false, то элемент не может быть фокусирован. Элемент может быть фокусирован только в том случае, если его свойство canGrabFocus имеет значение true. |
icon-image |
Object |
Текстура, Sprite или 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, который переопределяет любой унаследованный источник данных. Этот источник данных наследуется всеми дочерними объектами. |
data-source-path |
string |
Путь от источника данных к значению. |
data-source-type |
System.Type |
Возможный тип источника данных, присваиваемый этому VisualElement. Эта информация используется UI Builder только как подсказка для определенного заполнения поля пути источника данных, когда эффективный источник данных не может быть указан во время проектирования. |
enabled |
boolean |
Возвращает true, если VisualElement разрешен локально.Этот флаг не изменяется, если VisualElement имплицитно отключен одним из родителей. Чтобы проверить это, используйте enabledInHierarchy. |
language-direction |
UIElements.LanguageDirection |
Указывает направленность текста элемента. Значение будет распространяться на дочерей элемента. Установка languageDirection на RTL может получить только базовую поддержку RTL, такую как инверсия текста. Чтобы получить более полную поддержку RTL, такую как перерыв строки, перенос слов или формирование текста, вы должны включить Усовершенствованный текстовый генератор. |
name |
string |
Имя этого VisualElement. Используйте это свойство для написания селекторов USS, которые нацелены на определенный элемент. Стандартная практика заключается в том, чтобы дать элементу уникальное имя. |
picking-mode |
UIElements.PickingMode |
Определяет, может ли этот элемент быть целью событий указателя или выбран IPanel.Pick запросов.Элементы не могут быть выбраны, если: - Они невидимы. style.display установлен на DisplayStyle.NoneЭлементы с режимом подбора PickingMode.Ignore никогда не получать псевдо-state. |
style |
string |
Задает значения стиля на VisualElement.Возвращаемые данные стиля, рассчитанные из USS файлы или встроенные стили, записанные в этот объект в C#, не представляет полностью разрешенные стили, такие как окончательная высота и ширина VisualElement. Чтобы получить доступ к этим полностью разрешенным стилям, используйте resolvedStyle.Дополнительные сведения об использовании этого свойства и всех поддерживаемых USS свойства, см. Применить стили в C# сценарии и USS ссылка на свойства страницы руководства. |
tooltip |
string |
Текст, который будет отображаться внутри информационного поля после того, как пользователь задержится над элементом небольшое время. Это поддерживается только в Редакторе UI. |
usage-hints |
UIElements.UsageHints |
Комбинация значений подсказки, которые указывают высокоуровневые предполагаемые схемы использования для VisualElement. Это свойство может быть установлено только тогда, когда VisualElement еще не является частью Panel. Как только оно становится частью Panel, это свойство становится эффективно только для чтения, и попытки изменить его будут вызывать исключение. Указание правильного UsageHints заставляет систему принимать более правильные решения о том, как обрабатывать или ускорять определенные операции на основе предполагаемой схемы использования. Обратите внимание, что эти подсказки не влияют на поведение или визуальные результаты, а только влияют на общую производительность панели и элементов внутри нее. Рекомендуется всегда рассматривать возможность указания правильного UsageHints, но помните, что некоторые UsageHints могут быть внутренне проигнорированы при определенных условиях (e.g. из-за аппаратных ограничений на целевой платформе). |
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 |
Имя USS-класса для элементов Button со значком. Unity добавляет этот USS-класс к экземпляру элемента Button, если у этого экземпляра свойство Button.iconImage содержит допустимую Texture. Любые стили, применённые к этому классу, влияют на все кнопки со значком, расположенные рядом с таблицей стилей или ниже неё в визуальном дереве. |
iconOnlyUssClassName |
.unity-button--with-icon-only |
Имя USS-класса для элементов Button только со значком, без текста. Unity добавляет этот USS-класс к экземпляру элемента Button, если у этого экземпляра свойство Button.iconImage содержит допустимую Texture и текст не задан. Любые стили, применённые к этому классу, влияют на все кнопки со значком, расположенные рядом с таблицей стилей или ниже неё в визуальном дереве. |
ussClassName |
.unity-text-element |
Имя USS-класса для элементов этого типа. |
selectableUssClassName |
.unity-text-element__selectable |
Имя USS-класса для выделяемых текстовых элементов. |
disabledUssClassName |
.unity-disabled |
Имя USS-класса для локально отключённых элементов. |
Вы также можете использовать раздел Соответствующие селекторы в отладчике Inspector или UI Toolkit, чтобы увидеть, какие селекторы USS влияют на компоненты VisualElement на каждом уровне его иерархии.