TreeView<T0> · Справочник

класс в UnityEditor.IMGUI.Controls

Описание

TreeView — это IMGUI элемент управления, который позволяет создавать деревья представлений, списки представлений и многосторонние таблицы для инструментов Редактора.

Он настраивается в отношении отображения содержимого строки, логики перетаскивания, логики выбора, поиска, сортировки и переименования элементов. Чтобы обеспечить последовательность между TreeViews, следующие функции не настраиваются: отображение стрелок, отображение выбора, отображение маркеров перетаскивания.

Хорошим местом для начала является BuildRoot.

Свойства

Свойство	Описание
baseIndent	Отступ, используемый для всех строк перед стрелками и содержимым дерева.
cellMargin	При использовании MultiColumnHeader это значение настраивает прямые ячеек, предоставляемые для всех столбцов, кроме столбца развернутого дерева.
columnIndexForTreeFoldouts	При использовании MultiColumnHeader это значение должно быть установлено на индекс столбца, в котором должны появляться стрелки разворачивания.
customFoldoutYOffset	Настраиваемое вертикальное смещение стрелки разворачивания.
depthIndentWidth	Значение, которое возвращает, насколько развернутые элементы будут отставлены для каждого увеличивающегося значения глубины.
enableItemHovering	Установите это свойство на true, если требуется эффект перемещения объекта. Значение по умолчанию — false.
extraSpaceBeforeIconAndLabel	Значение для управления пробелом перед значком и меткой по умолчанию. Может использоваться e.g для размещения переключателя слева от содержимого.
foldoutOverride	Зарегистрируйте обратный вызов в этом свойстве, чтобы переопределить кнопку сворачивания в TreeView.
foldoutWidth	Ширина встроенной стрелки развертывания.
getNewSelectionOverride	Зарегистрируйте обратный вызов в этом поле, чтобы переопределить обработку изменений выделения в TreeView при нажатии клавиш и щелчках мышью.
hasSearch	Текущее состояние поиска из TreeView.
hoveredItem	Используйте это свойство для определения того, над каким TreeViewItem в TreeView в данный момент находится курсор мыши. Это свойство действительно только в том случае, если свойство enableItemHovering установлено на true.
isDragging	True, если пользователь перетаскивает один или несколько элементов в TreeView, и false в противном случае.
isInitialized	TreeView инициализируется при вызове Reload(). Поэтому возвращает false до тех пор, пока Reload() не будет вызван в первый раз.
multiColumnHeader	Получить MultiColumnHeader из TreeView. Может быть null, если TreeView был создан без MultiColumnHeader.
rootItem	Скрытый корневой элемент TreeView (он никогда не отображается).
rowHeight	Фиксированная высота, используемая для каждой строки в TreeView, если GetCustomRowHeight не переопределена.
searchString	Текущая строка поиска TreeView.
showAlternatingRowBackgrounds	Включите эту опцию, чтобы показать чередующиеся цвета фона строк.
showBorder	Включите это, чтобы показать границу вокруг TreeView.
showingHorizontalScrollBar	Возвращает true, если показана горизонтальная прокрутка, в противном случае false.
showingVerticalScrollBar	Возвращает true, если показана вертикальная полоса прокрутки, в противном случае false.
state	Состояние TreeView (развёрнутое состояние, выделение, прокрутка и т. д.)
totalHeight	Возвращает сумму высот строк TreeView, высоты MultiColumnHeader (если используется) и границы (если используется).
treeViewControlID	controlID используется TreeView для получения фокуса управления клавиатуры.
treeViewRect	Прямоугольник, на который отображается TreeView.
useScrollView	При рисовании содержимого TreeView, будет ли оно включено в ScrollView?

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

Конструктор	Описание
TreeView_1	Объект TreeView всегда создаётся с объектом состояния и, при необходимости, с объектом многоколоночного заголовка, если заголовок нужен.

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

Метод	Описание
BeginRename	Показывает накладку переименования для TreeViewItem.
CollapseAll	Свернуть все развернутые элементы в TreeView.
EndRename	Прекращает переименование, если показано наложение переименования. Если этот метод вызван, когда наложение переименования не показано, он ничего не делает.
ExpandAll	Развернуть все свернутые элементы в TreeView.
FrameItem	Это откроет элемент с id ID (путем расширения предков этого элемента) и убедится, что он видим в ScrollView.
GetExpanded	Возвращает список TreeViewItem IDs, которые в настоящее время развернуты в TreeView.
GetRows	Это список TreeViewItems, которые были построены в BuildRows.
GetSelection	Возвращает список TreeViewItem IDs, которые выбраны в данный момент.
HasFocus	Возвращает true, если TreeView и его EditorWindow имеют фокус клавиатуры.
HasSelection	Возвращает true, если TreeView имеет выборку.
IsExpanded	Возвращает true, если TreeViewItem с id ID в настоящее время развернут.
IsSelected	Возвращает true, если выбран TreeViewItem с id ID.
OnGUI	Это основной метод GUI метода TreeView, где TreeViewItems обрабатывается и рисуется.
Reload	Вызывайте это, чтобы заставить TreeView перезагрузить свои данные. Это, в свою очередь, вызывает BuildRoot и BuildRows.
Repaint	Запросить перерисовку окна, в котором отображается TreeView.
SelectAllRows	Выбирает все строки в TreeView.
SetExpanded	Устанавливает одиночный TreeViewItem для развертывания или сжатия.
SetExpandedRecursive	Развернуть или сжать все элементы под элементом с id.
SetFocus	Вызов этой функции изменяет фокус клавиатуры на TreeView.
SetFocusAndEnsureSelectedItem	Вызов этой функции изменяет фокус клавиатуры на TreeView и обеспечивает выделение элемента. Используйте эту функцию для включения навигации по клавишам TreeView.
SetSelection	Устанавливает выбранные элементы TreeView.

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

Метод	Описание
AddExpandedRows	Добавляет развернутые строки полного дерева в список входных данных. Используйте этот метод только в том случае, если полное дерево было построено в BuildRoot.
AfterRowsGUI	Эта функция вызывается после того, как все строки получили свой RowGUI.
BeforeRowsGUI	Эта функция вызывается до того, как будет вызвана функция RowGUI для любых строк.
BuildRoot	Абстрактный метод, который должен быть реализован. По умолчанию этот метод должен создать полное дерево TreeViewItems и возвратить корень.
BuildRows	Переопределите этот метод, чтобы взять на себя управление процессом создания строк.
CanBeParent	Переопределите этот метод, чтобы определить, какие элементы могут быть родителями.
CanChangeExpandedState	Переопределите этот метод, чтобы определить, может ли элемент разворачиваться или сжиматься при помощи клавиши или мыши.
CanMultiSelect	Переопределите этот метод, чтобы определить, может ли элемент быть частью многократного выбора.
CanRename	Переопределите этот метод, чтобы определить, можно ли переименовать элемент с помощью сочетания клавиш или при щелчке уже выбранного элемента.
CanStartDrag	Эта функция вызывается при нажатии и перетаскивании TreeViewItem. По умолчанию она возвращает false.
CenterRectUsingSingleLineHeight	Изменяет входное rect так, чтобы оно было центрировано и имело высоту равную EditorGUIUtility.singleLineHeight.
CommandEventHandling	Эта функция вызывается автоматически и обрабатывает события ExecuteCommand для “SelectAll” и “FrameSelection”. Переопределите эту функцию, чтобы расширить или избежать событий Команды.
ContextClicked	Переопределите этот метод для обработки контекстных кликов вне элементов (но все равно в TreeView rect).
ContextClickedItem	Переопределите этот метод для обработки контекстного щелчка по элементу с ID TreeViewItem<T0>.id.
DoesItemMatchSearch	Переопределите эту функцию, чтобы расширить или изменить поведение поиска.
DoubleClickedItem	Переопределите этот метод для обработки событий двойного щелчка по элементу.
ExpandedStateChanged	Переопределите, чтобы получать уведомления при разворачивании или сворачивании элементов. Это общее уведомление о том, что состояние развёрнутости изменилось.
FindItem	Находит TreeViewItem по ID.
FindRowOfItem	Возвращает строку заданного TreeViewItem.
FindRows	Полезно для преобразования из TreeViewItem IDs в TreeViewItems с использованием текущих строк.
GetAncestors	Этот метод e.g. используется для обнаружения элементов, которые в настоящее время находятся под свернутым элементом.
GetCellRectForTreeFoldouts	Утилита для многосторонних настроек. Этот метод привязывает ввод rowRect к прямой столбца, определенной columnIndexForTreeFoldouts, чтобы получить прямой ячейки, где появляются стрелки развертывания.
GetContentIndent	Возвращает горизонтальное смещение содержимого для элемента. Это место, где содержимое должно начинаться (после стрелки раскрывания).
GetCustomRowHeight	Переопределение для управления высотой отдельных строк.
GetDescendantsThatHaveChildren	Возвращает все потомки элемента с идентификатором ID, которые имеют детей.
GetFirstAndLastVisibleRows	Возвращает первый и последний индексы строк, которые видны в виде прокрутки TreeView.
GetFoldoutIndent	Возвращает горизонтальное смещение разворачивания для элемента. Здесь отображается стрелка разворачивания.
GetRenameRect	Переопределите этот метод, если пользовательский манипулятор GUI используется в RowGUI. Этот метод для контроллеров, где появляется накладка переименования.
GetRowRect	Получить прямой для ряда.
HandleDragAndDrop	Переопределите эту функцию, чтобы управлять перетаскиванием TreeView.
KeyEvent	Переопределите этот метод для обработки событий, когда TreeView имеет фокус клавиатуры.
RefreshCustomRowHeights	Обновляет кэш настраиваемых прямоугольников строк на основе высот, возвращенных GetCustomRowHeight.
RenameEnded	Вызывается, когда операция rename заканчивается либо завершением пользователем процесса переименования, либо когда накладка rename теряет фокус или закрывается с помощью EndRename.
RowGUI	Переопределите этот метод, чтобы добавить пользовательское содержимое GUI для строк в TreeView.
SearchChanged	Переопределить метод для получения уведомлений об изменениях строки поиска.
SelectionChanged	Переопределить метод, чтобы получать уведомления об изменениях выбора.
SelectionClick	Используйте этот метод в RowGUI для выполнения логики щелчка мыши.
SetupDragAndDrop	Эта функция вызывается, когда CanStartDrag возвращает true.
SingleClickedItem	Переопределите этот метод для обработки событий одного щелчка на элементе.
SortItemIDsInRowOrder	Возвращает список, отсортированный в том порядке, в котором они показаны в TreeView.

Статические методы

Метод	Описание
CreateChildListForCollapsedParent	Создает фиктивный список TreeViewItem. Полезно при переопределении BuildRows для предотвращения построения полного дерева элементов.
IsChildListForACollapsedParent	Утилита для проверки того, идентичен ли метод childList методу CreateChildListForCollapsedParent.
SetupDepthsFromParentsAndChildren	Утилита использует глубину входа TreeViewItem, чтобы установить правильные глубины для всех его потомков TreeViewItems.
SetupParentsAndChildrenFromDepths	Утилитный метод инициализации всех родительских и дочерних свойств строк с использованием заданных значений порядка и глубины.

Делегаты

делегат	Описание
DoFoldoutCallback	Сигнатура обратного вызова, используемая для переопределения сворачиваемого элемента TreeView. См. foldoutOverride.
GetNewSelectionFunction	Обратный вызов, который определяет, как TreeView обрабатывает изменения выбора в ответ на клавиши и щелчки мыши.