Description

A control used to show a set of internalTreeItems in a hierarchical structure. The tree items can be selected, expanded and collapsed. The tree can have multiple columns with custom controls likeLineEdits, buttons and popups. It can be useful for structured displays and interactions.

Trees are built via code, usingTreeItem objects to create the structure. They have a single root, but multiple roots can be simulated withhide_root:

func_ready():vartree=Tree.new()varroot=tree.create_item()tree.hide_root=truevarchild1=tree.create_item(root)varchild2=tree.create_item(root)varsubchild1=tree.create_item(child1)subchild1.set_text(0,"Subchild1")

publicoverridevoid_Ready(){vartree=newTree();TreeItemroot=tree.CreateItem();tree.HideRoot=true;TreeItemchild1=tree.CreateItem(root);TreeItemchild2=tree.CreateItem(root);TreeItemsubchild1=tree.CreateItem(child1);subchild1.SetText(0,"Subchild1");}

To iterate over all theTreeItem objects in aTree object, useTreeItem.get_next() andTreeItem.get_first_child() after getting the root throughget_root(). You can useObject.free() on aTreeItem to remove it from theTree.

Incremental search: LikeItemList andPopupMenu,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 changingProjectSettings.gui/timers/incremental_search_max_interval_msec.

Properties

Methods

Theme Properties

Signals

button_clicked(item:TreeItem, column:int, id:int, mouse_button_index:int)🔗

Emitted when a button on the tree was pressed (seeTreeItem.add_button()).

cell_selected()🔗

Emitted when a cell is selected.

check_propagated_to_item(item:TreeItem, column:int)🔗

Emitted whenTreeItem.propagate_check() is called. Connect to this signal to process the items that are affected whenTreeItem.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(column:int, mouse_button_index:int)🔗

Emitted when a column's title is clicked with either@GlobalScope.MOUSE_BUTTON_LEFT or@GlobalScope.MOUSE_BUTTON_RIGHT.

custom_item_clicked(mouse_button_index:int)🔗

Emitted when an item withTreeItem.CELL_MODE_CUSTOM is clicked with a mouse button.

custom_popup_edited(arrow_clicked:bool)🔗

Emitted when a cell with theTreeItem.CELL_MODE_CUSTOM is clicked to be edited.

empty_clicked(click_position:Vector2, mouse_button_index:int)🔗

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 aui_accept input event (e.g. usingEnter orSpace on the keyboard).

item_collapsed(item:TreeItem)🔗

Emitted when an item is expanded or collapsed by clicking on the folding arrow or through code.

Note: Despite its name, this signal is also emitted when an item is expanded.

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, seeitem_activated.

item_mouse_selected(mouse_position:Vector2, mouse_button_index:int)🔗

Emitted when an item is selected with a mouse button.

item_selected()🔗

Emitted when an item is selected.

multi_selected(item:TreeItem, column:int, selected:bool)🔗

Emitted instead ofitem_selected ifselect_mode is set toSELECT_MULTI.

nothing_selected()🔗

Emitted when a left mouse button click does not select any item.

Enumerations

enumSelectMode:🔗

SelectModeSELECT_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.

SelectModeSELECT_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.

SelectModeSELECT_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.

enumDropModeFlags:🔗

DropModeFlagsDROP_MODE_DISABLED =0

Disables all drop sections, but still allows to detect the "on item" drop section byget_drop_section_at_position().

Note: This is the default flag, it has no effect when combined with other flags.

DropModeFlagsDROP_MODE_ON_ITEM =1

Enables the "on item" drop section. This drop section covers the entire item.

When combined withDROP_MODE_INBETWEEN, this drop section halves the height and stays centered vertically.

DropModeFlagsDROP_MODE_INBETWEEN =2

Enables "above item" and "below item" drop sections. The "above item" drop section covers the top half of the item, and the "below item" drop section covers the bottom half.

When combined withDROP_MODE_ON_ITEM, these drop sections halves the height and stays on top / bottom accordingly.

Property Descriptions

boolallow_reselect =false🔗

• voidset_allow_reselect(value:bool)

• boolget_allow_reselect()

Iftrue, the currently selected cell may be selected again.

boolallow_rmb_select =false🔗

• voidset_allow_rmb_select(value:bool)

• boolget_allow_rmb_select()

Iftrue, a right mouse button click can select items.

boolallow_search =true🔗

• voidset_allow_search(value:bool)

• boolget_allow_search()

Iftrue, allows navigating theTree with letter keys through incremental search.

boolauto_tooltip =true🔗

• voidset_auto_tooltip(value:bool)

• boolis_auto_tooltip_enabled()

Iftrue, tree items with no tooltip assigned display their text as their tooltip. See alsoTreeItem.get_tooltip_text() andTreeItem.get_button_tooltip_text().

boolcolumn_titles_visible =false🔗

• voidset_column_titles_visible(value:bool)

• boolare_column_titles_visible()

Iftrue, column titles are visible.

intcolumns =1🔗

• voidset_columns(value:int)

• intget_columns()

The number of columns.

intdrop_mode_flags =0🔗

• voidset_drop_mode_flags(value:int)

• intget_drop_mode_flags()

The drop mode as an OR combination of flags. SeeDropModeFlags constants. Once dropping is done, reverts toDROP_MODE_DISABLED. Setting this duringControl._can_drop_data() is recommended.

This controls the drop sections, i.e. the decision and drawing of possible drop locations based on the mouse position.

boolenable_recursive_folding =true🔗

• voidset_enable_recursive_folding(value:bool)

• boolis_recursive_folding_enabled()

Iftrue, recursive folding is enabled for thisTree. Holding downShift while clicking the fold arrow or usingui_right/ui_left shortcuts collapses or uncollapses theTreeItem and all its descendants.

boolhide_folding =false🔗

• voidset_hide_folding(value:bool)

• boolis_folding_hidden()

Iftrue, the folding arrow is hidden.

boolhide_root =false🔗

• voidset_hide_root(value:bool)

• boolis_root_hidden()

Iftrue, the tree's root is hidden.

boolscroll_horizontal_enabled =true🔗

• voidset_h_scroll_enabled(value:bool)

• boolis_h_scroll_enabled()

Iftrue, enables horizontal scrolling.

boolscroll_vertical_enabled =true🔗

• voidset_v_scroll_enabled(value:bool)

• boolis_v_scroll_enabled()

Iftrue, enables vertical scrolling.

SelectModeselect_mode =0🔗

• voidset_select_mode(value:SelectMode)

• SelectModeget_select_mode()

Allows single or multiple selection. See theSelectMode constants.

Method Descriptions

voidclear()🔗

Clears the tree. This removes all items.

TreeItemcreate_item(parent:TreeItem = null, index:int = -1)🔗

Creates an item in the tree and adds it as a child ofparent, which can be either a validTreeItem ornull.

Ifparent isnull, the root item will be the parent, or the new item will be the root itself if the tree is empty.

The new item will be theindex-th child of parent, or it will be the last child if there are not enough siblings.

voiddeselect_all()🔗

Deselects all tree items (rows and columns). InSELECT_MULTI mode also removes selection cursor.

booledit_selected(force_edit:bool = false)🔗

Edits the selected tree item as if it was clicked.

Either the item must be set editable withTreeItem.set_editable() orforce_edit must betrue.

Returnstrue if the item could be edited. Fails if no item is selected.

voidensure_cursor_is_visible()🔗

Makes the currently focused cell visible.

This will scroll the tree if necessary. InSELECT_ROW mode, this will not do horizontal scrolling, as all the cells in the selected row is focused logically.

Note: Despite the name of this method, the focus cursor itself is only visible inSELECT_MULTI mode.

intget_button_id_at_position(position:Vector2)const🔗

Returns the button ID atposition, or -1 if no button is there.

intget_column_at_position(position:Vector2)const🔗

Returns the column index atposition, or -1 if no item is there.

intget_column_expand_ratio(column:int)const🔗

Returns the expand ratio assigned to the column.

Stringget_column_title(column:int)const🔗

Returns the column's title.

HorizontalAlignmentget_column_title_alignment(column:int)const🔗

Returns the column title alignment.

TextDirectionget_column_title_direction(column:int)const🔗

Returns column title base writing direction.

Stringget_column_title_language(column:int)const🔗

Returns column title language code.

intget_column_width(column:int)const🔗

Returns the column's width in pixels.

Rect2get_custom_popup_rect()const🔗

Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. SeeTreeItem.set_cell_mode().

intget_drop_section_at_position(position:Vector2)const🔗

Returns the drop section atposition, or -100 if no item is there.

Values -1, 0, or 1 will be returned for the "above item", "on item", and "below item" drop sections, respectively. SeeDropModeFlags for a description of each drop section.

To get the item which the returned drop section is relative to, useget_item_at_position().

TreeItemget_edited()const🔗

Returns the currently edited item. Can be used withitem_edited to get the item that was modified.

func_ready():$Tree.item_edited.connect(on_Tree_item_edited)funcon_Tree_item_edited():print($Tree.get_edited())# This item just got edited (e.g. checked).

publicoverridevoid_Ready(){GetNode<Tree>("Tree").ItemEdited+=OnTreeItemEdited;}publicvoidOnTreeItemEdited(){GD.Print(GetNode<Tree>("Tree").GetEdited());// This item just got edited (e.g. checked).}

intget_edited_column()const🔗

Returns the column for the currently edited item.

Rect2get_item_area_rect(item:TreeItem, column:int = -1, button_index:int = -1)const🔗

Returns the rectangle area for the specifiedTreeItem. Ifcolumn is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. If a button index is specified, the rectangle of that button will be returned.

TreeItemget_item_at_position(position:Vector2)const🔗

Returns the tree item at the specified position (relative to the tree origin position).

TreeItemget_next_selected(from:TreeItem)🔗

Returns the next selectedTreeItem after the given one, ornull if the end is reached.

Iffrom isnull, this returns the first selected item.

intget_pressed_button()const🔗

Returns the last pressed button's index.

TreeItemget_root()const🔗

Returns the tree's root item, ornull if the tree is empty.

Vector2get_scroll()const🔗

Returns the current scrolling position.

TreeItemget_selected()const🔗

Returns the currently focused item, ornull if no item is focused.

InSELECT_ROW andSELECT_SINGLE modes, the focused item is same as the selected item. InSELECT_MULTI mode, the focused item is the item under the focus cursor, not necessarily selected.

To get the currently selected item(s), useget_next_selected().

intget_selected_column()const🔗

Returns the currently focused column, or -1 if no column is focused.

InSELECT_SINGLE mode, the focused column is the selected column. InSELECT_ROW mode, the focused column is always 0 if any item is selected. InSELECT_MULTI mode, the focused column is the column under the focus cursor, and there are not necessarily any column selected.

To tell whether a column of an item is selected, useTreeItem.is_selected().

boolis_column_clipping_content(column:int)const🔗

Returnstrue if the column has enabled clipping (seeset_column_clip_content()).

boolis_column_expanding(column:int)const🔗

Returnstrue if the column has enabled expanding (seeset_column_expand()).

voidscroll_to_item(item:TreeItem, center_on_item:bool = false)🔗

Causes theTree to jump to the specifiedTreeItem.

voidset_column_clip_content(column:int, enable:bool)🔗

Allows to enable clipping for column's content, making the content size ignored.

voidset_column_custom_minimum_width(column:int, min_width:int)🔗

Overrides the calculated minimum width of a column. It can be set to0 to restore the default behavior. Columns that have the "Expand" flag will use their "min_width" in a similar fashion toControl.size_flags_stretch_ratio.

voidset_column_expand(column:int, expand:bool)🔗

Iftrue, the column will have the "Expand" flag ofControl. Columns that have the "Expand" flag will use their expand ratio in a similar fashion toControl.size_flags_stretch_ratio (seeset_column_expand_ratio()).

voidset_column_expand_ratio(column:int, ratio:int)🔗

Sets the relative expand ratio for a column. Seeset_column_expand().

voidset_column_title(column:int, title:String)🔗

Sets the title of a column.

voidset_column_title_alignment(column:int, title_alignment:HorizontalAlignment)🔗

Sets the column title alignment. Note that@GlobalScope.HORIZONTAL_ALIGNMENT_FILL is not supported for column titles.

voidset_column_title_direction(column:int, direction:TextDirection)🔗

Sets column title base writing direction.

voidset_column_title_language(column:int, language:String)🔗

Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead.

voidset_selected(item:TreeItem, column:int)🔗

Selects the specifiedTreeItem and column.

Theme Property Descriptions

Colorchildren_hl_line_color =Color(0.27,0.27,0.27,1)🔗

TheColor of the relationship lines between the selectedTreeItem and its children.

Colorcustom_button_font_highlight =Color(0.95,0.95,0.95,1)🔗

TextColor for aTreeItem.CELL_MODE_CUSTOM mode cell when it's hovered.

Colordrop_position_color =Color(1,1,1,1)🔗

Color used to draw possible drop locations. SeeDropModeFlags constants for further description of drop locations.

Colorfont_color =Color(0.7,0.7,0.7,1)🔗

Default textColor of the item.

Colorfont_disabled_color =Color(0.875,0.875,0.875,0.5)🔗

TextColor for aTreeItem.CELL_MODE_CHECK mode cell when it's non-editable (seeTreeItem.set_editable()).

Colorfont_hovered_color =Color(0.95,0.95,0.95,1)🔗

TextColor used when the item is hovered and not selected yet.

Colorfont_hovered_dimmed_color =Color(0.875,0.875,0.875,1)🔗

TextColor used when the item is hovered, while a button of the same item is hovered as the same time.

Colorfont_hovered_selected_color =Color(1,1,1,1)🔗

TextColor used when the item is hovered and selected.

Colorfont_outline_color =Color(0,0,0,1)🔗

The tint of text outline of the item.

Colorfont_selected_color =Color(1,1,1,1)🔗

TextColor used when the item is selected.

Colorguide_color =Color(0.7,0.7,0.7,0.25)🔗

Color of the guideline.

Colorparent_hl_line_color =Color(0.27,0.27,0.27,1)🔗

TheColor of the relationship lines between the selectedTreeItem and its parents.

Colorrelationship_line_color =Color(0.27,0.27,0.27,1)🔗

The defaultColor of the relationship lines.

Colortitle_button_color =Color(0.875,0.875,0.875,1)🔗

Default textColor of the title button.

intbutton_margin =4🔗

The horizontal space between each button in a cell.

intchildren_hl_line_width =1🔗

The width of the relationship lines between the selectedTreeItem and its children.

intdraw_guides =1🔗

Draws the guidelines if not zero, this acts as a boolean. The guideline is a horizontal line drawn at the bottom of each item.

intdraw_relationship_lines =0🔗

Draws the relationship lines if not zero, this acts as a boolean. Relationship lines are drawn at the start of child items to show hierarchy.

inth_separation =4🔗

The horizontal space between item cells. This is also used as the margin at the start of an item when folding is disabled.

inticon_max_width =0🔗

The maximum allowed width of the icon in item's cells. This limit is applied on top of the default size of the icon, but before the value set withTreeItem.set_icon_max_width(). The height is adjusted according to the icon's ratio.

intinner_item_margin_bottom =0🔗

The inner bottom margin of a cell.

intinner_item_margin_left =0🔗

The inner left margin of a cell.

intinner_item_margin_right =0🔗

The inner right margin of a cell.

intinner_item_margin_top =0🔗

The inner top margin of a cell.

intitem_margin =16🔗

The horizontal margin at the start of an item. This is used when folding is enabled for the item.

intoutline_size =0🔗

The size of the text outline.

Note: If using a font withFontFile.multichannel_signed_distance_field enabled, itsFontFile.msdf_pixel_range must be set to at leasttwice the value ofoutline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.

intparent_hl_line_margin =0🔗

The space between the parent relationship lines for the selectedTreeItem and the relationship lines to its siblings that are not selected.

intparent_hl_line_width =1🔗

The width of the relationship lines between the selectedTreeItem and its parents.

intrelationship_line_width =1🔗

The default width of the relationship lines.

intscroll_border =4🔗

The maximum distance between the mouse cursor and the control's border to trigger border scrolling when dragging.

intscroll_speed =12🔗

The speed of border scrolling.

intscrollbar_h_separation =4🔗

The horizontal separation of tree content and scrollbar.

intscrollbar_margin_bottom =-1🔗

The bottom margin of the scrollbars. When negative, usespanel bottom margin.

intscrollbar_margin_left =-1🔗

The left margin of the horizontal scrollbar. When negative, usespanel left margin.

intscrollbar_margin_right =-1🔗

The right margin of the scrollbars. When negative, usespanel right margin.

intscrollbar_margin_top =-1🔗

The top margin of the vertical scrollbar. When negative, usespanel top margin.

intscrollbar_v_separation =4🔗

The vertical separation of tree content and scrollbar.

intv_separation =4🔗

The vertical padding inside each item, i.e. the distance between the item's content and top/bottom border.

Fontfont🔗

Font of the item's text.

Fonttitle_button_font🔗

Font of the title button's text.

intfont_size🔗

Font size of the item's text.

inttitle_button_font_size🔗

Font size of the title button's text.

Texture2Darrow🔗

The arrow icon used when a foldable item is not collapsed.

Texture2Darrow_collapsed🔗

The arrow icon used when a foldable item is collapsed (for left-to-right layouts).

Texture2Darrow_collapsed_mirrored🔗

The arrow icon used when a foldable item is collapsed (for right-to-left layouts).

Texture2Dchecked🔗

The check icon to display when theTreeItem.CELL_MODE_CHECK mode cell is checked and editable (seeTreeItem.set_editable()).

Texture2Dchecked_disabled🔗

The check icon to display when theTreeItem.CELL_MODE_CHECK mode cell is checked and non-editable (seeTreeItem.set_editable()).

Texture2Dindeterminate🔗

The check icon to display when theTreeItem.CELL_MODE_CHECK mode cell is indeterminate and editable (seeTreeItem.set_editable()).

Texture2Dindeterminate_disabled🔗

The check icon to display when theTreeItem.CELL_MODE_CHECK mode cell is indeterminate and non-editable (seeTreeItem.set_editable()).

Texture2Dselect_arrow🔗

The arrow icon to display for theTreeItem.CELL_MODE_RANGE mode cell.

Texture2Dunchecked🔗

The check icon to display when theTreeItem.CELL_MODE_CHECK mode cell is unchecked and editable (seeTreeItem.set_editable()).

Texture2Dunchecked_disabled🔗

The check icon to display when theTreeItem.CELL_MODE_CHECK mode cell is unchecked and non-editable (seeTreeItem.set_editable()).

Texture2Dupdown🔗

The updown arrow icon to display for theTreeItem.CELL_MODE_RANGE mode cell.

StyleBoxbutton_hover🔗

StyleBox used when a button in the tree is hovered.

StyleBoxbutton_pressed🔗

StyleBox used when a button in the tree is pressed.

StyleBoxcursor🔗

StyleBox used for the cursor, when theTree is being focused.

StyleBoxcursor_unfocused🔗

StyleBox used for the cursor, when theTree is not being focused.

StyleBoxcustom_button🔗

DefaultStyleBox for aTreeItem.CELL_MODE_CUSTOM mode cell when button is enabled withTreeItem.set_custom_as_button().

StyleBoxcustom_button_hover🔗

StyleBox for aTreeItem.CELL_MODE_CUSTOM mode button cell when it's hovered.

StyleBoxcustom_button_pressed🔗

StyleBox for aTreeItem.CELL_MODE_CUSTOM mode button cell when it's pressed.

StyleBoxfocus🔗

The focused style for theTree, drawn on top of everything.

StyleBoxhovered🔗

StyleBox for the item being hovered, but not selected.

StyleBoxhovered_dimmed🔗

StyleBox for the item being hovered, while a button of the same item is hovered as the same time.

StyleBoxhovered_selected🔗

StyleBox for the hovered and selected items, used when theTree is not being focused.

StyleBoxhovered_selected_focus🔗

StyleBox for the hovered and selected items, used when theTree is being focused.

StyleBoxpanel🔗

The background style for theTree.

StyleBoxselected🔗

StyleBox for the selected items, used when theTree is not being focused.

StyleBoxselected_focus🔗

StyleBox for the selected items, used when theTree is being focused.

StyleBoxtitle_button_hover🔗

StyleBox used when the title button is being hovered.

StyleBoxtitle_button_normal🔗

DefaultStyleBox for the title button.

StyleBoxtitle_button_pressed🔗

StyleBox used when the title button is being pressed.