TabView

класс в UnityEngine.UIElements

Выполнено в:UnityEngine.UIElementsModule

Описание

Создает представление вкладки, в котором группируются один или несколько элементов Tab.

Представление вкладок предоставляет дополнительную функциональность для Вкладки. Оно позволяет группе вкладок взаимодействовать друг с другом, скрывая неактивные вкладки и отображая активную. Кроме того, оно добавляет возможность изменять порядок группы вкладок.

Для вкладок с возможностью изменения порядка важно, чтобы ключ view-data-key оставался уникальным у элементов TabView и Tab внутри вкладки. Этот ключ помогает сохранять состояние вкладок — например, их порядок и состояние. Пустой ключ view-data-key (значение по умолчанию) означает, что состояние вкладок при перезагрузке документа не сохранится.

Для более подробной информации, см. UXML элемент TabView.

Статические свойства

Свойство	Описание
contentContainerUssClassName	Имя USS-класса для контейнера содержимого этого типа.
headerContainerClassName	Имя USS-класса для контейнера заголовка этого типа.
nextButtonUssClassName	Имя USS-класса для кнопки прокрутки вперёд этого типа.
previousButtonUssClassName	Имя USS-класса для кнопки прокрутки назад этого типа.
reorderableUssClassName	Имя USS-класса для представления вкладок с переупорядочиванием.
ussClassName	Имя USS-класса для элементов этого типа.
verticalUssClassName	Имя USS-класса для вертикального представления вкладок.
viewportUssClassName	Имя USS-класса для области просмотра содержимого этого типа.

Свойства

Свойство	Описание
activeTab	Свойство, содержащее текущую активную вкладку.
contentContainer	Контейнер для содержимого TabView.
contentViewport	Представляет видимую часть contentContainer.
reorderable	Свойство, которое добавляет поддержку перетаскивания к вкладкам.
selectedTabIndex	Свойство, которое возвращает индекс текущей активной вкладки в списке доступных вкладок.

Конструкторы

Конструктор	Описание
TabView	Создает TabView.

Открытые методы

Метод	Описание
GetTab	Возвращает табуляцию в указанном индексе.
GetTabHeader	Возвращает заголовок вкладки в указанном индексе.
ReorderTab	Перемещает вкладку из указанного индекса в новый индекс.

Мероприятия

Мероприятие	Описание
activeTabChanged	Вызывается при переназначении активной вкладки.
tabClosed	Возникает при закрытии вкладки. Первым аргументом является вкладка, которая была закрыта, вторым — индекс вкладки, которая была закрыта.
tabReordered	Возникает при изменении порядка вкладок. Первый аргумент — индекс источника, второй — индекс назначения.

Унаследованные члены 4

Статические свойства

Свойство	Описание
disabledUssClassName	Имя USS-класса для локально отключённых элементов.

Свойства

Свойство	Описание
canGrabFocus	Можно ли фокусировать элемент.
delegatesFocus	Делегирует ли элемент фокус своим дочерним элементам.
focusable	Может ли элемент потенциально получать фокус.
focusController	Возвращает контроллер фокуса для этого элемента.
tabIndex	Целое число, используемое для сортировки фокусируемых элементов в кольце фокуса. Должно быть больше или равно нулю.
childCount	Количество дочерних элементов в contentContainer этого объекта.
contentContainer	Логический контейнер, в который добавляются дочерние элементы. Если к этому элементу добавляется дочерний элемент, то он добавляется в контейнер содержимого этого элемента.
contentRect	Прямоугольник области содержимого элемента в локальном пространстве элемента. (Только для чтения)
customStyle	Настраиваемый аксессор свойств стиля VisualElement (только для чтения).
dataSource	Назначает источник данных этому VisualElement, который переопределяет любой унаследованный источник данных. Этот источник данных наследуется всеми дочерними объектами.
dataSourcePath	Путь от источника данных к значению.
dataSourceType	Возможный тип источника данных, присваиваемый этому VisualElement. Эта информация используется UI Builder только как подсказка, чтобы дать некоторое заполнение в поле пути источника данных, когда эффективный источник данных не может быть указан во время проектирования.
disablePlayModeTint	Оттенки режима воспроизведения применяются по умолчанию, если это не установлено в true. Они применяются иерархически к этому VisualElement и ко всем его дочерним объектам, которые существуют на панели редактора.
enabledInHierarchy	Возвращает true, если VisualElement включен в собственной иерархии.
enabledSelf	Возвращает true, если VisualElement включен локально.
experimental	Возвращает экспериментальные интерфейсы UIElements.
generateVisualContent	Функция делегирования для генерации визуального содержания визуального элемента.
hasActivePseudoState	Возвращает true, если этот элемент соответствует псевдоклассу :active.
hasCheckedPseudoState	Возвращает true, если этот элемент соответствует псевдоклассу :checked.
hasDisabledPseudoState	Возвращает true, если этот элемент соответствует псевдоклассу :disabled.
hasEnabledPseudoState	Возвращает true, если этот элемент соответствует псевдоклассу :enabled.
hasFocusPseudoState	Возвращает true, если этот элемент соответствует псевдоклассу :focus.
hasHoverPseudoState	Возвращает true, если этот элемент соответствует псевдоклассу :hover.
hasInactivePseudoState	Возвращает true, если этот элемент соответствует псевдоклассу :inactive.
hasRootPseudoState	Возвращает true, если этот элемент соответствует псевдоклассу :root.
hierarchy	Доступ к физической иерархии этого элемента
languageDirection	Указывает направленность текста элемента. Значение будет распространяться на дочерей элемента.
layout	Положение и размер VisualElement относительно его родительского объекта, как вычислено системой макета. (Только для чтения)
localBound	Возвращает Rect, представляющий выравниваемый по оси Bounding Box (AABB) после применения преобразования, но до применения преобразования макета.
name	Имя этого VisualElement.
paddingRect	Прямоугольник зоны заполнения элемента, в локальном пространстве элемента.
panel	Панель, к которой прикреплен этот VisualElement.
parent	Родители этого VisualElement.
pickingMode	Определяет, может ли этот элемент быть целью событий указателя или выбран запросами IPanel.Pick.
resolvedStyle	Окончательные отображенные значения стиля визуального элемента, как он отображается в текущем кадре.(Только для чтения)
scaledPixelsPerPoint	Возвращает результат масштабирования панели, который учитывает экран DPI и настраиваемый фактор масштабирования, но не масштаб трансформации элемента и его предшественников. См. Panel.scaledPixelsPerPoint. Этот метод должен вызываться только для элементов, которые являются частью панели.
schedule	Получает IVisualElementScheduler, связанный с этим VisualElement. Используйте его для очереди действий.
style	Устанавливает значения стиля на VisualElement.
styleSheets	Возвращает VisualElementStyleSheetSet, который манипулирует таблицами стилей, прикрепленными к этому элементу.
это[int]	Получает дочерний элемент в определенном индексе.
tooltip	Текст, который будет отображаться внутри информационного поля после того, как пользователь задержится над элементом небольшое время. Это поддерживается только в Редакторе UI.
usageHints	Сочетание значений подсказки, которые указывают схемы предполагаемого использования высокого уровня для VisualElement. Это свойство может быть установлено только тогда, когда VisualElement если это свойство еще не является частью панели. Как только это свойство становится частью панели, оно становится доступным только для чтения, и попытки изменить его вызывают исключение. UsageHints Подсказки позволяют системе принимать лучшие решения о том, как обрабатывать или ускорять определенные операции на основе предполагаемой схемы использования. Обратите внимание, что эти подсказки не влияют на поведение или визуальные результаты, а только влияют на общую производительность панели и элементов внутри нее. Рекомендуется всегда учитывать указание надлежащего UsageHints, но помните, что некоторые UsageHints могут быть внутренне проигнорированы при определенных условиях (e.g. из-за аппаратных ограничений на целевой платформе).
userData	Это свойство может использоваться для связывания данных пользователя, специфичных для приложения, с этим VisualElement.
viewDataKey	Используется для сохранения данных представления, таких как развернутые состояния дерева, положение прокрутки или уровень масштаба.
visible	Указывает, должен ли этот элемент отображаться или нет.
visualTreeAssetSource	Хранит ссылку на ассет, если генерируемый элемент клонирован из VisualTreeAsset.
worldBound	Возвращает выравниваемую по оси границу элемента в координатах панели после кумулятивного преобразования из корня IPanel.
worldTransform	Возвращает матрицу, которая накапливает следующие преобразования (в порядке): Local scalingLocal rotationLocal translationLayout translationParent worldTransform (рекурсивное определение — рассматривается матрица идентичности, когда нет родителя)

Открытые методы

Метод	Описание
HasBubbleUpHandlers	Возвращает true, если к этому объекту были прикреплены обработчики событий для фазы распространения событий BubbleUp.
HasTrickleDownHandlers	Возвращает true, если к этому объекту прикреплены обработчики событий для фазы распространения событий TrickleDown.
RegisterCallback	Добавление обработчика событий к экземпляру.
RegisterCallbackOnce	Добавление обработчика событий к экземпляру. Обработчик событий автоматически отменяет регистрацию после того, как он был вызван ровно один раз.
UnregisterAllRemovableCallbacks	Удаляет из экземпляра все обратные вызова, зарегистрированные с CallbackOptions.Removable.
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	Находит наименьшего общего предка между двумя VisualElements внутри иерархии VisualTree.
GetBinding	Получает экземпляр привязки для указанного целевого свойства.
GetBindingInfos	Получает информацию обо всех привязках текущего элемента.
GetClasses	Получить классы для этого элемента.
GetDataSourceContext	Запросы dataSource и dataSourcePath объекта привязки.
GetFirstAncestorOfType	Проходит вверх по иерархии, начиная с родителя этого элемента, и возвращает первый VisualElement этого типа
GetFirstOfType	Проходит вверх по иерархии, начиная с этого элемента, и возвращает первый VisualElement этого типа
GetHierarchicalDataSourceContext	Запросы dataSource и dataSourcePath унаследованы от иерархии.
HasBinding	Позволяет узнать, связана ли с целевым свойством привязка.
IndexOf	Получает дочерний индекс указанного VisualElement.
Insert	Вставить элемент в contentContainer этого элемента
IsMarkedForRepaint	Проверяет, не загрязнен ли VisualElement для перекраски.
MarkDirtyRepaint	Помечает, что VisualElement требует перекраски.
PlaceBehind	Помещает этот элемент прямо перед элементом-родственником в их родительском дочернем списке. Если позиция элемента и элемента-родственника перекрываются, элемент будет визуально находиться позади своего родственника.
PlaceInFront	Помещает этот элемент сразу после элемента-сестры в их родительском дочернем списке. Если элемент и позиция элемента-сестры перекрываются, элемент будет визуально находиться перед элементом-сестры.
Remove	Удаляет этот дочерний объект из иерархии его contentContainer.
RemoveAt	Удаляет дочерний элемент с указанным индексом из списка дочерних элементов текущего элемента.
RemoveFromClassList	Удаляет класс из списка классов элемента.
RemoveFromHierarchy	Удаляет этот элемент из родительской иерархии.
SendEvent	Отправляет событие в обработчик событий.
SendToBack	Отправляет этот элемент в начало родительского дочернего списка. Элемент будет визуально находиться за любыми перекрывающимися родственными элементами.
SetActivePseudoState	Задает, будет ли этот элемент отображаться как активный.
SetBinding	Назначает привязку между конечным объектом и источником.
SetCheckedPseudoState	Задает, будет ли этот элемент отображаться как отмеченный.
SetEnabled	Меняет состояние VisualElement. Отключённый визуальный элемент не получает большинство событий.
Sort	Переупорядочивает дочерние элементы из VisualElement в contentContainer.
ToggleInClassList	Переключает между добавлением и удалением заданного имени класса в списке классов.
TryGetBinding	Получает экземпляр привязки для указанного целевого свойства.
TryGetDataSourceContext	Запросы dataSource и dataSourcePath объекта привязки.
TryGetLastBindingToSourceResult	Возвращает последний BindingResult объекта привязки из UI в источник данных.
TryGetLastBindingToUIResult	Возвращает последний BindingResult объекта привязки из источника данных к UI.

Защищенные методы

Метод	Описание
HandleEventBubbleUp	Выполняет логику на этом элементе во время фазы BubbleUp, непосредственно перед обратными вызовами BubbleUp этого элемента. Вызов StopPropagation предотвратит дальнейшие вызовы этого метода вдоль пути распространения.
HandleEventTrickleDown	Выполняет логику на этом элементе во время фазы TrickleDown, сразу после обратных вызовов TrickleDown этого элемента. Вызов StopPropagation предотвратит дальнейшие вызовы этого метода вдоль пути распространения.
NotifyPropertyChanged	Сообщает системе привязки данных о том, что изменилось свойство контроля.