Up to date
This page is up to date for Godot 4.1.
If you still find outdated information, please open an issue.
Tree¶
Inherits: Control < CanvasItem < Node < Object
A control used to show a set of internal TreeItems in a hierarchical structure.
Description¶
A control used to show a set of internal TreeItems in a hierarchical structure. The tree items can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like LineEdits, buttons and popups. It can be useful for structured displays and interactions.
Trees are built via code, using TreeItem objects to create the structure. They have a single root, but multiple roots can be simulated with hide_root:
func _ready():
var tree = Tree.new()
var root = tree.create_item()
tree.hide_root = true
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 root = tree.CreateItem();
tree.HideRoot = true;
TreeItem child1 = tree.CreateItem(root);
TreeItem child2 = tree.CreateItem(root);
TreeItem subchild1 = tree.CreateItem(child1);
subchild1.SetText(0, "Subchild1");
}
To iterate over all the TreeItem objects in a Tree object, use TreeItem.get_next and TreeItem.get_first_child after getting the root through get_root. You can use Object.free on a TreeItem to remove it from the Tree.
Incremental search: Like ItemList and PopupMenu, Tree supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing ProjectSettings.gui/timers/incremental_search_max_interval_msec.
Properties¶
|
||
|
||
|
||
clip_contents |
|
|
|
||
|
||
|
||
|
||
focus_mode |
|
|
|
||
|
||
|
||
|
||
|
Methods¶
Theme Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Signals¶
button_clicked ( TreeItem item, int column, int id, int mouse_button_index )
Emitted when a button on the tree was pressed (see TreeItem.add_button).
cell_selected ( )
Emitted when a cell is selected.
check_propagated_to_item ( TreeItem item, int column )
Emitted when TreeItem.propagate_check is called. Connect to this signal to process the items that are affected when TreeItem.propagate_check is invoked. The order that the items affected will be processed is as follows: the item that invoked the method, children of that item, and finally parents of that item.
column_title_clicked ( int column, int mouse_button_index )
Emitted when a column's title is clicked with either @GlobalScope.MOUSE_BUTTON_LEFT or @GlobalScope.MOUSE_BUTTON_RIGHT.
custom_item_clicked ( int mouse_button_index )
Emitted when an item with TreeItem.CELL_MODE_CUSTOM is clicked with a mouse button.
custom_popup_edited ( bool arrow_clicked )
Emitted when a cell with the TreeItem.CELL_MODE_CUSTOM is clicked to be edited.
empty_clicked ( Vector2 position, int mouse_button_index )
Emitted when a mouse button is clicked in the empty space of the tree.
item_activated ( )
Emitted when an item is double-clicked, or selected with a ui_accept input event (e.g. using Enter or Space on the keyboard).
item_collapsed ( TreeItem item )
Emitted when an item is collapsed by a click on the folding arrow.
item_edited ( )
Emitted when an item is edited.
item_icon_double_clicked ( )
Emitted when an item's icon is double-clicked. For a signal that emits when any part of the item is double-clicked, see item_activated.
item_mouse_selected ( Vector2 position, int mouse_button_index )
Emitted when an item is selected with a mouse button.
item_selected ( )
Emitted when an item is selected.
multi_selected ( TreeItem item, int column, bool selected )
Emitted instead of item_selected if select_mode is SELECT_MULTI.
nothing_selected ( )
Emitted when a left mouse button click does not select any item.
Enumerations¶
enum SelectMode:
SelectMode SELECT_SINGLE = 0
Allows selection of a single cell at a time. From the perspective of items, only a single item is allowed to be selected. And there is only one column selected in the selected item.
The focus cursor is always hidden in this mode, but it is positioned at the current selection, making the currently selected item the currently focused item.
SelectMode SELECT_ROW = 1
Allows selection of a single row at a time. From the perspective of items, only a single items is allowed to be selected. And all the columns are selected in the selected item.
The focus cursor is always hidden in this mode, but it is positioned at the first column of the current selection, making the currently selected item the currently focused item.
SelectMode SELECT_MULTI = 2
Allows selection of multiple cells at the same time. From the perspective of items, multiple items are allowed to be selected. And there can be multiple columns selected in each selected item.
The focus cursor is visible in this mode, the item or column under the cursor is not necessarily selected.
enum DropModeFlags:
DropModeFlags DROP_MODE_DISABLED = 0
Disables all drop sections, but still allows to detect the "on item" drop section by get_drop_section_at_position.
Note: This is the default flag, it has no effect when combined with other flags.
DropModeFlags DROP_MODE_ON_ITEM = 1
Enables the "on item" drop section. This drop section covers the entire item.
When combined with DROP_MODE_INBETWEEN, this drop section halves the height