Tree
Успадковує: Control < CanvasItem < Node < Object
Контроль, який використовується для відображення комплексу внутрішніх TreeItem в ієрархічній структурі.
Опис
Елемент керування, який використовується для відображення набору внутрішніх TreeItem в ієрархічній структурі. Елементи дерева можна вибирати, розгортати та згортати. Дерево може мати кілька стовпців із настроюваними елементами керування, такими як LineEdit, кнопки та спливаючі вікна. Це може бути корисним для структурованих показів і взаємодії.
Дерева будуються за допомогою коду з використанням об’єктів TreeItem для створення структури. Вони мають один корінь, але кілька коренів можна симулювати за допомогою hide_root:
func _ready():
var tree = Tree.new()
var root = tree.create_item()
tree.hide_root = ture
var child1 = tree.create_item(root)
var child2 = tree.create_item(root)
var subchild1 = tree.create_item(child1)
subchild1.set_text(0, "Subchild1")
public override void _Ready()
{
var tree = new Tree();
Корінь TreeItem = tree.CreateItem();
tree.HideRoot = true;
TreeItem child1 = tree.CreateItem(root);
TreeItem child2 = tree.CreateItem(root);
TreeItem subchild1 = tree.CreateItem(child1);
subchild1.SetText(0, "Subchild1");
}
Щоб виконати ітерацію по всіх об’єктах TreeItem в об’єкті Tree, використовуйте TreeItem.get_next() і TreeItem.get_first_child() після отримання кореня через get_root(). Ви можете використовувати Object.free() для TreeItem, щоб видалити його з Tree.
Поступовий пошук: Подібно до ItemList і PopupMenu, Tree підтримує пошук у списку, коли елемент керування знаходиться в фокусі. Натисніть клавішу, яка відповідає першій літері назви об’єкта, щоб вибрати перший об’єкт, який починається з заданої літери. Після цього є два способи виконати поступовий пошук: 1) Натисніть ту саму клавішу ще раз до закінчення часу очікування, щоб вибрати наступний елемент, який починається з тієї ж літери. 2) Натискайте клавіші з літерами, які відповідають решті слова перед відповідним часом очікування, щоб безпосередньо вибрати відповідний елемент. Обидві ці дії буде скинуто на початок списку, якщо час очікування минув після останнього натискання клавіші. Ви можете налаштувати тривалість тайм-ауту, змінивши ProjectSettings.gui/timers/incremental_search_max_interval_msec.
Властивості
|
||
|
||
|
||
|
||
clip_contents |
|
|
|
||
|
||
|
||
|
||
focus_mode |
|
|
|
||
|
||
|
||
|
||
|
Методи
Властивості теми
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Сигнали
button_clicked(item: TreeItem, column: int, id: int, mouse_button_index: int) 🔗
При натисканні кнопки на дерево (див. TreeItem.add_button().
cell_selected() 🔗
Увімкніть, коли вибрано комірку.
check_propagated_to_item(item: TreeItem, column: int) 🔗
Викликається при виклику методу TreeItem.propagate_check(). Підключіться до цього сигналу для обробки елементів, на які впливає виклик методу TreeItem.propagate_check(). Порядок, у якому будуть оброблені елементи, такий: елемент, який викликав метод, дочірні елементи цього елемента та, нарешті, батьки цього елемента.
column_title_clicked(column: int, mouse_button_index: int) 🔗
Увімкнено, коли назва стовпця натискається як @GlobalScope.MOUSE_BUTTON_LEFT або @GlobalScope.MOUSE_BUTTON_RIGHT.
custom_item_clicked(mouse_button_index: int) 🔗
Випробувано в розділі TreeItem.CELL_MODE_CUSTOM] натискається на кнопку миші.
custom_popup_edited(arrow_clicked: bool) 🔗
Увімкнено, коли клітинка з TreeItem.CELL_MODE_CUSTOM натискається на редагування.
empty_clicked(click_position: Vector2, mouse_button_index: int) 🔗
Увімкніть, коли кнопка миші натискається у порожній простір дерева.
item_activated() 🔗
Випробувано, коли елемент подвійно клацнув, або вибирається з ui_accept вхідний захід (наприклад, за допомогою Enter або Space на клавіатурі).
item_collapsed(item: TreeItem) 🔗
Випромінюється, коли елемент розгортається або згортається клацанням на стрілку згортання або за допомогою коду.
Примітка: Незважаючи на свою назву, цей сигнал також випромінюється, коли елемент розгортається.
item_edited() 🔗
Випромінюється при редагуванні товару.
item_icon_double_clicked() 🔗
Випробувано, коли іконка елемента подвійна. Для сигналу, який випромінює, коли будь-яка частина пункту подвійна клацання, див. item_activated.
item_mouse_selected(mouse_position: Vector2, mouse_button_index: int) 🔗
Увімкніть, коли вибрано пункт з кнопкою миші.
item_selected() 🔗
Увімкніть, коли вибрано пункт.
multi_selected(item: TreeItem, column: int, selected: bool) 🔗
Видається замість item_selected, якщо select_mode встановлено на SELECT_MULTI.
nothing_selected() 🔗
Увімкніть, коли клацніть лівою кнопкою миші не вибрано жодного елемента.
Переліки
enum SelectMode: 🔗
SelectMode SELECT_SINGLE = 0
Дозволяє підбір однієї комірки одночасно. З точки зору елементів можна вибрати тільки один елемент. І є тільки один стовпчик, вибраний в вибраному елементі.
Курсор фокусу завжди прихований в цьому режимі, але він розташований на поточному підборі, що робить в даний час вибраний елемент на даний момент фокусований елемент.
SelectMode SELECT_ROW = 1
Дозволяє підбір одного ряду одночасно. З точки зору елементів можна вибрати тільки одинарні елементи. І всі стовпчики вибирають у вибраному елементі.
Курсор фокусу завжди прихований в цьому режимі, але він розташовується в першому стовпчику поточного вибору, що робить в даний час обраний елемент на даний момент фокусований елемент.
SelectMode SELECT_MULTI = 2
Дозволяє вибрати декілька клітин одночасно. З точки зору елементів можна вибрати декілька елементів. І можуть бути декілька стовпців, вибраних в кожному вибраному пункті.
Курсор фокусу видно в цьому режимі, елемент або стовпець під курсор не обов'язково вибраний.
enum DropModeFlags: 🔗
DropModeFlags DROP_MODE_DISABLED = 0
Вимкнено всі розділи крапель, але все ще дозволяє виявити розділ "в пункті" за допомогою get_drop_section_at_position().
Примітка: Це прапор за замовчуванням, він не має ефекту при поєднанні з іншими прапорами.
DropModeFlags DROP_MODE_ON_ITEM = 1
Увімкнути розділ "на місці" Цей розділ крапель охоплює весь елемент.
При поєднанні з DROP_MODE_INBETWEEN цей розділ краплини половинок висоти і залишається в центрі вертикально.
DropModeFlags DROP_MODE_INBETWEEN = 2
Увімкнено "приблизний елемент" та "повільний елемент" розділи крапель. В розділі «приблизний елемент» покривається верхню половину виробу, а розділ «повільний елемент» охоплює нижню половину.
При поєднанні з DROP_MODE_ON_ITEM ці розділи скидають висоту і залишаються зверху / вниз відповідно.
Описи властивостей
Якщо true, в даний час вибрана клітинка може бути вибрана знову.
bool allow_rmb_select = false 🔗
Якщо true, клацніть правою кнопкою миші можна вибрати елементи.
Якщо true, дозволяє навігувати Tree з літерними ключами через незрівнянний пошук.
Якщо true, елементи дерева без призначеної підказки відображатимуть текст як підказку. Дивіться також TreeItem.get_tooltip_text() і TreeItem.get_button_tooltip_text().
bool column_titles_visible = false 🔗
Якщо true, видимі назви стовпців.
Кількість стовпчиків.
Режим падіння як OR комбінації прапорів. DropModeFlags константи. Після того, як відбувається скидання, повертається до DROP_MODE_DISABLED. Налаштування цього під час Control._can_drop_data() рекомендується.
Це контролює розділи крапель, тобто рішення та креслення можливих місць крапель на основі положення мишки.
bool enable_recursive_folding = true 🔗
Якщо true, рекурсивний склад включений для цього Tree. Проведення Shift при натисканні стрілки або за допомогою ui_right/ui_left ярлики згортаються або незрівнянно TreeItem і всі її нащадки.
Якщо true, згорнутий стрілку.
Якщо true, корінь дерева прихована.
bool scroll_horizontal_enabled = true 🔗
Якщо true, дозволяє горизонтальне прокручування.
bool scroll_vertical_enabled = true 🔗
Якщо true, дозволяє вертикальне прокручування.
SelectMode select_mode = 0 🔗
void set_select_mode(value: SelectMode)
SelectMode get_select_mode()
Дозволяє один або кілька вибору. Дивитися SelectMode константи.
Описи методів
void clear() 🔗
Очищає дерево. Це видаляє всі елементи.
TreeItem create_item(parent: TreeItem = null, index: int = -1) 🔗
Створює елемент у дереві та додає його як дочірній елемент parent, який може бути або коректним TreeItem, або null.
Якщо parent має значення null, кореневим елементом буде батьківський елемент, або новий елемент буде коренем, якщо дерево порожнє.
Новий елемент буде index-м дочірнім елементом батьківського елемента, або останнім дочірнім елементом, якщо недостатньо братів і сестер.
void deselect_all() 🔗
Видаляє всі елементи дерева (рядки і стовпчики). У режимі SELECT_MULTI також видаляє курсор вибору.
bool edit_selected(force_edit: bool = false) 🔗
Редагує вибраний елемент дерева, якщо той було натиснуто.
Або елемент має бути зроблений доступним до редагування через TreeItem.set_editable(), або force_edit необхідно встановити до true.
Повертає true, якщо елемент можна редагувати. Провалюється, якщо не вибрано елемент.
void ensure_cursor_is_visible() 🔗
Зробляйте видиму клітинку в даний час.
Це буде прокручувати дерево при необхідності. У режимі SELECT_ROW це не займе горизонтального прокручування, оскільки всі клітини в вибраному ряді зосереджені логічно.
Примітка: Незважаючи на назву цього методу, сам курсор фокусу видно тільки в режимі SELECT_MULTI.
int get_button_id_at_position(position: Vector2) const 🔗
Повертає ідентифікатор кнопки в position, або -1, якщо немає кнопки.
int get_column_at_position(position: Vector2) const 🔗
Повертає індекс стовпця на position, або -1, якщо там немає.
int get_column_expand_ratio(column: int) const 🔗
Повертає коефіцієнт розширення, призначеного для стовпця.
String get_column_title(column: int) const 🔗
Повертає назву стовпця.
HorizontalAlignment get_column_title_alignment(column: int) const 🔗
Повертає вирівнювання стовпця.
TextDirection get_column_title_direction(column: int) const 🔗
Повертає напрямок написання стовпців.
String get_column_title_language(column: int) const 🔗
Повертає код мови стовпця.
int get_column_width(column: int) const 🔗
Повертає ширину стовпця в пікселів.
Rect2 get_custom_popup_rect() const 🔗
Повертає прямокутник для користувацьких спливаючих вікон. Допомагає створювати користувальницькі елементи управління, які відображають спливаючість. Див. TreeItem.set_cell_mode().
int get_drop_section_at_position(position: Vector2) const 🔗
Повертаємо розділ краплі на position, або -100, якщо там немає.
Цінності -1, 0, або 1 будуть повернуті на "приблизний елемент", "в пункті", і "повільний елемент" зрізи, відповідно. Див. DropModeFlags для опису кожного розділу краплі.
Щоб отримати пункт, який повернутий розділ, відносно, скористайтеся get_item_at_position().
Повертає поточний відредагований елемент. Можна використовувати з item_edited, щоб отримати елемент, який було змінено.
func _ready():
$Tree.item_edited.connect(on_Tree_item_edited)
func on_Tree_item_edited():
print($Tree.get_edited()) # Цей елемент щойно було відредаговано (наприклад, позначено).
public override void _Ready()
{
GetNode<Tree>("Tree").ItemEdited += OnTreeItemEdited;
}
public void OnTreeItemEdited()
{
GD.Print(GetNode<Tree>("Дерево").GetEdited()); // Цей елемент щойно було відредаговано (наприклад, перевірено).
}
int get_edited_column() const 🔗
Повернення стовпця для вказаного елемента.
Rect2 get_item_area_rect(item: TreeItem, column: int = -1, button_index: int = -1) const 🔗
Повернення прямокутника за вказаною TreeItem. Якщо пам'ячий стовпчик вказаний, тільки отримайте позицію і розмір цього стовпчика, інакше отримайте прямокутник, що містить всі стовпчики. Якщо вказаний індекс кнопки, буде повернено прямокутник цієї кнопки.
TreeItem get_item_at_position(position: Vector2) const 🔗
Повертає елемент дерева на вказану позицію (відносно до положення походження дерева).
TreeItem get_next_selected(from: TreeItem) 🔗
Повернення наступного вибраного TreeItem після вказаного, або null, якщо кінець досягається.
Якщо from є null, це повертає перший обраний елемент.
int get_pressed_button() const 🔗
Повертає останній індекс натискання кнопки.
Повертає корінь дерева, або null, якщо дерево порожній.
Повертає поточну позицію прокручування.
TreeItem get_selected() const 🔗
Повертає поточний сфокусований елемент, або null, якщо жоден елемент не в фокусі.
У режимах SELECT_ROW і SELECT_SINGLE, сфокусований елемент той же, що й обраний. У режимі SELECT_MULTI фокусований елемент є елементом під курсором фокусу, ане обов'язково вибраний.
Щоб отримати поточні вибрані елементи, скористайтеся get_next_selected().
int get_selected_column() const 🔗
Повертає в даний час зосереджений стовп, або -1, якщо не фокусується стовпчик.
У режимі SELECT_SINGLE фокусований стовпчик обраний стовпчик. У режимі SELECT_ROW фокусований стовпчик завжди 0, якщо обраний елемент. У режимі SELECT_MULTI зосереджений стовпчик - стовпець під курсор фокусу, і не обов'язково підбирається будь-який стовпчик.
Щоб розповісти, чи вибрано стовпчик пункту, скористайтеся TreeItem.is_selected().
bool is_column_clipping_content(column: int) const 🔗
Повертає true, якщо стовпчик ввімкнув кліпінг (див. set_column_clip_content()).
bool is_column_expanding(column: int) const 🔗
Повертає true, якщо стовпчик увімкнено розширення (див. set_column_expand()).
void scroll_to_item(item: TreeItem, center_on_item: bool = false) 🔗
Причини Tree стрибати вказаний TreeItem.
void set_column_clip_content(column: int, enable: bool) 🔗
Дозволяє увімкнути затискання для вмісту стовпця, що робить вміст ігнорувати.
void set_column_custom_minimum_width(column: int, min_width: int) 🔗
Надійшла розрахована мінімальна ширина стовпчика. Ви можете встановити до 0 для відновлення поведінки за замовчуванням. Колонки, які мають прапор "Expand" будуть використовувати їх "min_width" в аналогічній моді Control.size_flags_stretch_ratio.
void set_column_expand(column: int, expand: bool) 🔗
Якщо true, стовпчик буде мати прапор "Expand" Control. Колонки, які мають прапор "Expand" будуть використовувати їх розширення співвідношення в аналогічній моді до Control.size_flags_stretch_ratio (див. set_column_expand_ratio()).
void set_column_expand_ratio(column: int, ratio: int) 🔗
Встановлює відносне розширення співвідношення для стовпця. Подивитися set_column_expand().
void set_column_title(column: int, title: String) 🔗
Встановлює назву стовпчика.
void set_column_title_alignment(column: int, title_alignment: HorizontalAlignment) 🔗
Встановлює вирівнювання стовпця. Зверніть увагу, що @GlobalScope.HORIZONTAL_ALIGNMENT_FILL не підтримується для назв стовпців.
void set_column_title_direction(column: int, direction: TextDirection) 🔗
Встановлює напрямок написання стовпців.
void set_column_title_language(column: int, language: String) 🔗
Налаштовує мовний код заголовка стовпців, що використовується для алгоритмів формування рядків та тексту, якщо використовується лівий порожній струм.
void set_selected(item: TreeItem, column: int) 🔗
Виберіть вказаний TreeItem і стовпчик.
Описи тематичної нерухомості
Color children_hl_line_color = Color(0.27, 0.27, 0.27, 1) 🔗
Color ліній зв'язків між вибраними TreeItem та його дітьми.
Color custom_button_font_highlight = Color(0.95, 0.95, 0.95, 1) 🔗
Текст Color для TreeItem.CELL_MODE_CUSTOM модна клітинка, коли вона переповнена.
Color drop_position_color = Color(1, 1, 1, 1) 🔗
Color використовується для визначення можливих скиданнях. Див. DropModeFlags константи для подальшого опису місць крапель.
Color font_color = Color(0.7, 0.7, 0.7, 1) 🔗
Текст за замовчуванням Color пункту.
Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5) 🔗
Текст Color для TreeItem.CELL_MODE_CHECK модна клітинка, коли вона не видається (див. TreeItem.set_editable()).
Color font_hovered_color = Color(0.95, 0.95, 0.95, 1) 🔗
Текст Color використовується, коли елемент передається і не вибрано ще.
Color font_hovered_dimmed_color = Color(0.875, 0.875, 0.875, 1) 🔗
Color тексту, який використовується під час наведення курсора на елемент, у той час як кнопка того самого елемента наводиться одночасно.
Color font_hovered_selected_color = Color(1, 1, 1, 1) 🔗
Color тексту, що використовується, коли елемент наведено та вибрано.
Color font_outline_color = Color(0, 0, 0, 1) 🔗
Вміст текстового контуру виробу.
Color font_selected_color = Color(1, 1, 1, 1) 🔗
Текст Color використовується при вибраному пункті.
Color guide_color = Color(0.7, 0.7, 0.7, 0.25) 🔗
Color цієї інструкції.
Color parent_hl_line_color = Color(0.27, 0.27, 0.27, 1) 🔗
Color ліній зв'язків між вибраними TreeItem та його батьками.
Color relationship_line_color = Color(0.27, 0.27, 0.27, 1) 🔗
За замовчуванням Color ліній зв'язку.
Color title_button_color = Color(0.875, 0.875, 0.875, 1) 🔗
Текст за замовчуванням Color кнопки заголовка.
Горизонтальний простір між кожним гудзиком в комірці.
int children_hl_line_width = 1 🔗
Ширина ліній зв'язку між обраними TreeItem і його дітьми.
Налаштовує вказівки, якщо не нуль, це виступає болеан. Дирекція - горизонтальна лінія, що наноситься внизу кожного виробу.
int draw_relationship_lines = 0 🔗
Намальовує лінії зв'язку, якщо не нуль, це виступає болеан. Відповідні лінії мальуються на старті дитячих предметів, щоб показати ієрархію.
Горизонтальний простір між клітинами. Це також використовується як запас при старті елемента при складанні вимкнено.
Максимальна допустима ширина ікони в клітинах елемента. Цей ліміт наноситься зверху за замовчуванням, розмір іконки, але перед значенням, встановленим TreeItem.set_icon_max_width(). Висота регульована відповідно до співвідношення ікони.
int inner_item_margin_bottom = 0 🔗
Внутрішній нижній запас комірки.
int inner_item_margin_left = 0 🔗
Внутрішній лівий запас комірки.
int inner_item_margin_right = 0 🔗
Внутрішній правий запас комірки.
int inner_item_margin_top = 0 🔗
Внутрішній верхній запас комірки.
Горизонтальний запас при старті виробу. Це використовується при складанні включений до пункту.
Розмір контуру тексту.
Примітка. Якщо використовується шрифт із увімкненим FontFile.multichannel_signed_distance_field, для його FontFile.msdf_pixel_range має бути принаймні вдвічі значення outline_size щоб рендеринг контуру виглядав правильно. Інакше контур може здатися обрізаним раніше, ніж передбачалося.
int parent_hl_line_margin = 0 🔗
Простір між материнськими лініями зв'язку для обраного TreeItem та лініями зв'язку до своїх дробів, які не вибрані.
int parent_hl_line_width = 1 🔗
Ширина ліній зв'язку між вибраними TreeItem і батьками.
int relationship_line_width = 1 🔗
Ширина за замовчуванням ліній зв'язку.
Максимальна відстань між курсором мишки і кордоном керування, щоб викликати прокручування кордону при перетягування.
Швидкість прокручування кордону.
int scrollbar_h_separation = 4 🔗
Горизонтальне розділення вмісту дерева та прокрутки.
int scrollbar_margin_bottom = -1 🔗
Нижня маржа прокруток. При негативному використанні panel нижній запас.
int scrollbar_margin_left = -1 🔗
Лівий запас горизонтальної прокрутки. При негативному використанні panel лівий запас.
int scrollbar_margin_right = -1 🔗
Правова маржа прокруток. Коли негативно використовується panel правий запас.
int scrollbar_margin_top = -1 🔗
Верхній запас вертикальної прокрутки. При негативному використанні panel верхнього запасу.
int scrollbar_v_separation = 4 🔗
Вертикальне розділення вмісту дерева та прокрутки.
Вертикальний наповнювач всередині кожного елемента, тобто відстань між змістом елемента та верхнім бордюром.
Font тексту елемента.
Font тексту заголовка.
Розмір шрифту тексту.
Розмір шрифту тексту за назвою.
Ікона стріли використовується при складному елементі не згортається.
Ікона стріли, що використовується при складному елементі, згортається (для лівих макетів).
Texture2D arrow_collapsed_mirrored 🔗
Ікона стріли, що використовується при складному елементі, згортається (для правого розташування макетів).
Перевірити іконку для відображення при TreeItem.CELL_MODE_CHECK модна клітинка перевіряється і редагується (див. TreeItem.set_editable()).
Перевірити іконку для відображення при TreeItem.CELL_MODE_CHECK модна клітинка перевіряється і невиліковна (див. TreeItem.set_editable()).
Перевірити іконку для відображення при TreeItem.CELL_MODE_CHECK в режимі клітинки неглибока і відредагована (див. TreeItem.set_editable()).
Texture2D indeterminate_disabled 🔗
Перевірити іконку для відображення при TreeItem.CELL_MODE_CHECK в режимі клітинки неглибока і невиліковна (див. TreeItem.set_editable()).
Ікона стріли для відображення TreeItem.CELL_MODE_RANGE.
Перевірити іконку для відображення при TreeItem.CELL_MODE_CHECK модна клітинка очищається і редагується (див. TreeItem.set_editable()).
Texture2D unchecked_disabled 🔗
Перевірити іконку для відображення при TreeItem.CELL_MODE_CHECK модна клітина очищається і невиліковна (див. TreeItem.set_editable()).
Підсумок стріли для відображення TreeItem.CELL_MODE_RANGE в режимі комірки.
StyleBox використовується при наведенні курсора на кнопку в дереві.
StyleBox використовується при натисканні кнопки в дерево.
StyleBox використовується для курсора, коли фокусується Tree.
StyleBox використовується для курсора, коли Tree не фокусується.
За замовчуванням StyleBox для TreeItem.CELL_MODE_CUSTOM модна клітинка при включенні кнопки з TreeItem.set_custom_as_button().
StyleBox custom_button_hover 🔗
StyleBox для TreeItem.CELL_MODE_CUSTOM режим кнопка комірки, коли він переповнений.
StyleBox custom_button_pressed 🔗
StyleBox для TreeItem.CELL_MODE_CUSTOM режим кнопка комірки при натисканні.
Сфокусований стиль Tree, намальований на вершині всього.
StyleBox для елемента, на який наведено курсор, але він не вибраний.
StyleBox для елемента, на який наводиться курсор, тоді як кнопка того самого елемента наводиться одночасно.
StyleBox для елементів, на які наведено курсор, та вибраних елементів, використовується, коли Tree не перебуває у фокусі.
StyleBox hovered_selected_focus 🔗
StyleBox для елементів, на які наведено курсор, та вибраних елементів, використовується, коли фокусується Tree.
Стиль фону для Tree.
StyleBox для вибраних елементів, використовуваних при Tree, не фокусується.
StyleBox для вибраних елементів, які використовуються при фокусі Tree.
StyleBox використовується при натисканні назви.
StyleBox title_button_normal 🔗
За замовчуванням StyleBox для кнопки title.
StyleBox title_button_pressed 🔗
StyleBox використовується при натисканні назви кнопки.