Tree

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Control to show a tree of items.

Properties

Methods

Theme Properties

Signals

• button_pressed ( TreeItem item, int column, int id )

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

• cell_selected ( )

Emitted when a cell is selected.

• column_title_pressed ( int column )

Emitted when a column’s title is pressed.

• custom_popup_edited ( bool arrow_clicked )

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

• empty_tree_rmb_selected ( Vector2 position )

Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty.

• item_activated ( )

Emitted when an item’s label is double-clicked.

• item_collapsed ( TreeItem item )

Emitted when an item is collapsed by a click on the folding arrow.

• item_custom_button_pressed ( )

• item_double_clicked ( )

Emitted when an item’s icon is double-clicked.

• item_edited ( )

Emitted when an item is edited.

• item_rmb_edited ( )

Emitted when an item is edited using the right mouse button.

• item_rmb_selected ( Vector2 position )

Emitted when an item is selected with the right mouse button.

• item_selected ( )

Emitted when an item is selected.

• multi_selected ( TreeItem item, int column, bool selected )

Emitted instead of item_selected when select_mode is SELECT_MULTI.

• nothing_selected ( )

Enumerations

enum SelectMode:

• SELECT_SINGLE = 0 — Allow selection of a single item at a time.
• SELECT_ROW = 1
• SELECT_MULTI = 2 — Allow selection of multiple items at the same time.

enum DropModeFlags:

• DROP_MODE_DISABLED = 0
• DROP_MODE_ON_ITEM = 1
• DROP_MODE_INBETWEEN = 2

Description

This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, 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 if a dummy hidden root is added.

func _ready():
    var tree = Tree.new()
    var root = tree.create_item()
    tree.set_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")

Property Descriptions

• bool allow_reselect

If true, the currently selected cell may be selected again.

• bool allow_rmb_select

If true, a right mouse button click can select items.

• int columns

The amount of columns.

• int drop_mode_flags

The drop mode as an OR combination of flags. See DROP_MODE_* constants. Once dropping is done, reverts to DROP_MODE_DISABLED. Setting this during Control.can_drop_data is recommended.

• bool hide_folding

If true, the folding arrow is hidden.

• bool hide_root

If true, the tree’s root is hidden.

• SelectMode select_mode

Allow single or multiple selection. See the SELECT_* constants.

Method Descriptions

• bool are_column_titles_visible ( ) const

Returns true if the column titles are being shown.

• void clear ( )

Clears the tree. This removes all items.

• TreeItem create_item ( Object parent=null, int idx=-1 )

Create an item in the tree and add it as the last child of parent. If parent is not given, it will be added as the root’s last child, or it’ll the be the root itself if the tree is empty.

• void ensure_cursor_is_visible ( )

Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible.

• int get_column_at_position ( Vector2 position ) const

Returns the column index under the given point.

• String get_column_title ( int column ) const

Returns the column’s title.

• int get_column_width ( int column ) const

Returns the column’s width in pixels.

• Rect2 get_custom_popup_rect ( ) const

Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See TreeItem.set_cell_mode.

• int get_drop_section_at_position ( Vector2 position ) const

If drop_mode_flags includes DROP_MODE_INBETWEEN, returns -1 if position is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if drop_mode_flags includes DROP_MODE_ON_ITEM.

Otherwise, returns 0. If there are no tree item at position, returns -100.

• TreeItem get_edited ( ) const

Returns the currently edited item. This is only available for custom cell mode.

• int get_edited_column ( ) const

Returns the column for the currently edited item. This is only available for custom cell mode.

• Rect2 get_item_area_rect ( Object item, int column=-1 ) const

Returns the rectangle area for the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns.

• TreeItem get_item_at_position ( Vector2 position ) const

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

• TreeItem get_next_selected ( Object from )

Returns the next selected item after the given one.

• int get_pressed_button ( ) const

Returns the last pressed button’s index.

• TreeItem get_root ( )

Returns the tree’s root item.

• Vector2 get_scroll ( ) const

Returns the current scrolling position.

• TreeItem get_selected ( ) const

Returns the currently selected item.

• int get_selected_column ( ) const

Returns the current selection’s column.

• void set_column_expand ( int column, bool expand )

If true, the column will have the “Expand” flag of Control. Columns that have the “Expand” flag will use their “min_width” in a similar fashion to Control.size_flags_stretch_ratio.

• void set_column_min_width ( int column, int min_width )

Sets the minimum width of a column. Columns that have the “Expand” flag will use their “min_width” in a similar fashion to Control.size_flags_stretch_ratio.

• void set_column_title ( int column, String title )

Set the title of a column.

• void set_column_titles_visible ( bool visible )

If true, column titles are visible.