godot/doc/classes/Tree.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Tree" inherits="Control" version="3.2">
	<brief_description>
		Control to show a tree of items.
	</brief_description>
	<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.
		[codeblock]
		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")
		[/codeblock]
		To iterate over all the [TreeItem] objects in a [Tree] object, use [method TreeItem.get_next] and [method TreeItem.get_children] after getting the root through [method get_root]. You can use [method Object.free] on a [TreeItem] to remove it from the [Tree].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="are_column_titles_visible" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the column titles are being shown.
			</description>
		</method>
		<method name="clear">
			<return type="void">
			</return>
			<description>
				Clears the tree. This removes all items.
			</description>
		</method>
		<method name="create_item">
			<return type="TreeItem">
			</return>
			<argument index="0" name="parent" type="Object" default="null">
			</argument>
			<argument index="1" name="idx" type="int" default="-1">
			</argument>
			<description>
				Creates an item in the tree and adds it as a child of [code]parent[/code].
				If [code]parent[/code] is [code]null[/code], 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 the [code]idx[/code]th child of parent, or it will be the last child if there are not enough siblings.
			</description>
		</method>
		<method name="edit_selected">
			<return type="bool">
			</return>
			<description>
				Edits the selected tree item as if it was clicked. The item must be set editable with [method TreeItem.set_editable]. Returns [code]true[/code] if the item could be edited. Fails if no item is selected.
			</description>
		</method>
		<method name="ensure_cursor_is_visible">
			<return type="void">
			</return>
			<description>
				Makes the currently focused cell visible.
				This will scroll the tree if necessary. In [constant SELECT_ROW] mode, this will not do horizontal scrolling, as all the cells in the selected row is focused logically.
				[b]Note:[/b] Despite the name of this method, the focus cursor itself is only visible in [constant SELECT_MULTI] mode.
			</description>
		</method>
		<method name="get_column_at_position" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="position" type="Vector2">
			</argument>
			<description>
				Returns the column index at [code]position[/code], or -1 if no item is there.
			</description>
		</method>
		<method name="get_column_title" qualifiers="const">
			<return type="String">
			</return>
			<argument index="0" name="column" type="int">
			</argument>
			<description>
				Returns the column's title.
			</description>
		</method>
		<method name="get_column_width" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="column" type="int">
			</argument>
			<description>
				Returns the column's width in pixels.
			</description>
		</method>
		<method name="get_custom_popup_rect" qualifiers="const">
			<return type="Rect2">
			</return>
			<description>
				Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode].
			</description>
		</method>
		<method name="get_drop_section_at_position" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="position" type="Vector2">
			</argument>
			<description>
				Returns the drop section at [code]position[/code], 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. See [enum DropModeFlags] for a description of each drop section.
				To get the item which the returned drop section is relative to, use [method get_item_at_position].
			</description>
		</method>
		<method name="get_edited" qualifiers="const">
			<return type="TreeItem">
			</return>
			<description>
				Returns the currently edited item. Can be used with [signal item_edited] to get the item that was modified.
				[codeblock]
				func _ready():
				    $Tree.item_edited.connect(on_Tree_item_edited)

				func on_Tree_item_edited():
				    print($Tree.get_edited()) # This item just got edited (e.g. checked).
				[/codeblock]
			</description>
		</method>
		<method name="get_edited_column" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the column for the currently edited item.
			</description>
		</method>
		<method name="get_item_area_rect" qualifiers="const">
			<return type="Rect2">
			</return>
			<argument index="0" name="item" type="Object">
			</argument>
			<argument index="1" name="column" type="int" default="-1">
			</argument>
			<description>
				Returns the rectangle area for the specified item. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns.
			</description>
		</method>
		<method name="get_item_at_position" qualifiers="const">
			<return type="TreeItem">
			</return>
			<argument index="0" name="position" type="Vector2">
			</argument>
			<description>
				Returns the tree item at the specified position (relative to the tree origin position).
			</description>
		</method>
		<method name="get_next_selected">
			<return type="TreeItem">
			</return>
			<argument index="0" name="from" type="Object">
			</argument>
			<description>
				Returns the next selected item after the given one, or [code]null[/code] if the end is reached.
				If [code]from[/code] is [code]null[/code], this returns the first selected item.
			</description>
		</method>
		<method name="get_pressed_button" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the last pressed button's index.
			</description>
		</method>
		<method name="get_root">
			<return type="TreeItem">
			</return>
			<description>
				Returns the tree's root item, or [code]null[/code] if the tree is empty.
			</description>
		</method>
		<method name="get_scroll" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Returns the current scrolling position.
			</description>
		</method>
		<method name="get_selected" qualifiers="const">
			<return type="TreeItem">
			</return>
			<description>
				Returns the currently focused item, or [code]null[/code] if no item is focused.
				In [constant SELECT_ROW] and [constant SELECT_SINGLE] modes, the focused item is same as the selected item. In [constant SELECT_MULTI] mode, the focused item is the item under the focus cursor, not necessarily selected.
				To get the currently selected item(s), use [method get_next_selected].
			</description>
		</method>
		<method name="get_selected_column" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the currently focused column, or -1 if no column is focused.
				In [constant SELECT_SINGLE] mode, the focused column is the selected column. In [constant SELECT_ROW] mode, the focused column is always 0 if any item is selected. In [constant SELECT_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, use [method TreeItem.is_selected].
			</description>
		</method>
		<method name="scroll_to_item">
			<return type="void">
			</return>
			<argument index="0" name="item" type="Object">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_column_expand">
			<return type="void">
			</return>
			<argument index="0" name="column" type="int">
			</argument>
			<argument index="1" name="expand" type="bool">
			</argument>
			<description>
				If [code]true[/code], 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 [member Control.size_flags_stretch_ratio].
			</description>
		</method>
		<method name="set_column_min_width">
			<return type="void">
			</return>
			<argument index="0" name="column" type="int">
			</argument>
			<argument index="1" name="min_width" type="int">
			</argument>
			<description>
				Sets the minimum width of a column. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio].
			</description>
		</method>
		<method name="set_column_title">
			<return type="void">
			</return>
			<argument index="0" name="column" type="int">
			</argument>
			<argument index="1" name="title" type="String">
			</argument>
			<description>
				Sets the title of a column.
			</description>
		</method>
		<method name="set_column_titles_visible">
			<return type="void">
			</return>
			<argument index="0" name="visible" type="bool">
			</argument>
			<description>
				If [code]true[/code], column titles are visible.
			</description>
		</method>
	</methods>
	<members>
		<member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect" default="false">
			If [code]true[/code], the currently selected cell may be selected again.
		</member>
		<member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select" default="false">
			If [code]true[/code], a right mouse button click can select items.
		</member>
		<member name="columns" type="int" setter="set_columns" getter="get_columns" default="1">
			The number of columns.
		</member>
		<member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags" default="0">
			The drop mode as an OR combination of flags. See [enum DropModeFlags] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control.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.
		</member>
		<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" />
		<member name="hide_folding" type="bool" setter="set_hide_folding" getter="is_folding_hidden" default="false">
			If [code]true[/code], the folding arrow is hidden.
		</member>
		<member name="hide_root" type="bool" setter="set_hide_root" getter="is_root_hidden" default="false">
			If [code]true[/code], the tree's root is hidden.
		</member>
		<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" />
		<member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode" default="0">
			Allows single or multiple selection. See the [enum SelectMode] constants.
		</member>
	</members>
	<signals>
		<signal name="button_pressed">
			<argument index="0" name="item" type="TreeItem">
			</argument>
			<argument index="1" name="column" type="int">
			</argument>
			<argument index="2" name="id" type="int">
			</argument>
			<description>
				Emitted when a button on the tree was pressed (see [method TreeItem.add_button]).
			</description>
		</signal>
		<signal name="cell_selected">
			<description>
				Emitted when a cell is selected.
			</description>
		</signal>
		<signal name="column_title_pressed">
			<argument index="0" name="column" type="int">
			</argument>
			<description>
				Emitted when a column's title is pressed.
			</description>
		</signal>
		<signal name="custom_popup_edited">
			<argument index="0" name="arrow_clicked" type="bool">
			</argument>
			<description>
				Emitted when a cell with the [constant TreeItem.CELL_MODE_CUSTOM] is clicked to be edited.
			</description>
		</signal>
		<signal name="empty_rmb">
			<argument index="0" name="position" type="Vector2">
			</argument>
			<description>
				Emitted when the right mouse button is pressed in the empty space of the tree.
			</description>
		</signal>
		<signal name="empty_tree_rmb_selected">
			<argument index="0" name="position" type="Vector2">
			</argument>
			<description>
				Emitted when the right mouse button is pressed if right mouse button selection is active and the tree is empty.
			</description>
		</signal>
		<signal name="item_activated">
			<description>
				Emitted when an item's label is double-clicked.
			</description>
		</signal>
		<signal name="item_collapsed">
			<argument index="0" name="item" type="TreeItem">
			</argument>
			<description>
				Emitted when an item is collapsed by a click on the folding arrow.
			</description>
		</signal>
		<signal name="item_custom_button_pressed">
			<description>
				Emitted when a custom button is pressed (i.e. in a [constant TreeItem.CELL_MODE_CUSTOM] mode cell).
			</description>
		</signal>
		<signal name="item_double_clicked">
			<description>
				Emitted when an item's icon is double-clicked.
			</description>
		</signal>
		<signal name="item_edited">
			<description>
				Emitted when an item is edited.
			</description>
		</signal>
		<signal name="item_rmb_edited">
			<description>
				Emitted when an item is edited using the right mouse button.
			</description>
		</signal>
		<signal name="item_rmb_selected">
			<argument index="0" name="position" type="Vector2">
			</argument>
			<description>
				Emitted when an item is selected with the right mouse button.
			</description>
		</signal>
		<signal name="item_selected">
			<description>
				Emitted when an item is selected.
			</description>
		</signal>
		<signal name="multi_selected">
			<argument index="0" name="item" type="TreeItem">
			</argument>
			<argument index="1" name="column" type="int">
			</argument>
			<argument index="2" name="selected" type="bool">
			</argument>
			<description>
				Emitted instead of [code]item_selected[/code] if [code]select_mode[/code] is [constant SELECT_MULTI].
			</description>
		</signal>
		<signal name="nothing_selected">
			<description>
				Emitted when a left mouse button click does not select any item.
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="SELECT_SINGLE" value="0" enum="SelectMode">
			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.
		</constant>
		<constant name="SELECT_ROW" value="1" enum="SelectMode">
			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.
		</constant>
		<constant name="SELECT_MULTI" value="2" enum="SelectMode">
			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.
		</constant>
		<constant name="DROP_MODE_DISABLED" value="0" enum="DropModeFlags">
			Disables all drop sections, but still allows to detect the "on item" drop section by [method get_drop_section_at_position].
			[b]Note:[/b] This is the default flag, it has no effect when combined with other flags.
		</constant>
		<constant name="DROP_MODE_ON_ITEM" value="1" enum="DropModeFlags">
			Enables the "on item" drop section. This drop section covers the entire item.
			When combined with [constant DROP_MODE_INBETWEEN], this drop section halves the height and stays centered vertically.
		</constant>
		<constant name="DROP_MODE_INBETWEEN" value="2" enum="DropModeFlags">
			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 with [constant DROP_MODE_ON_ITEM], these drop sections halves the height and stays on top / bottom accordingly.
		</constant>
	</constants>
	<theme_items>
		<theme_item name="arrow" type="Texture">
			The arrow icon used when a foldable item is not collapsed.
		</theme_item>
		<theme_item name="arrow_collapsed" type="Texture">
			The arrow icon used when a foldable item is collapsed.
		</theme_item>
		<theme_item name="bg" type="StyleBox">
			Default [StyleBox] for the [Tree], i.e. used when the control is not being focused.
		</theme_item>
		<theme_item name="bg_focus" type="StyleBox">
			[StyleBox] used when the [Tree] is being focused.
		</theme_item>
		<theme_item name="button_margin" type="int" default="4">
			The horizontal space between each button in a cell.
		</theme_item>
		<theme_item name="button_pressed" type="StyleBox">
			[StyleBox] used when a button in the tree is pressed.
		</theme_item>
		<theme_item name="checked" type="Texture">
			The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is checked.
		</theme_item>
		<theme_item name="cursor" type="StyleBox">
			[StyleBox] used for the cursor, when the [Tree] is being focused.
		</theme_item>
		<theme_item name="cursor_unfocused" type="StyleBox">
			[StyleBox] used for the cursor, when the [Tree] is not being focused.
		</theme_item>
		<theme_item name="custom_button" type="StyleBox">
			Default [StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell.
		</theme_item>
		<theme_item name="custom_button_font_highlight" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
			Text [Color] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's hovered.
		</theme_item>
		<theme_item name="custom_button_hover" type="StyleBox">
			[StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's hovered.
		</theme_item>
		<theme_item name="custom_button_pressed" type="StyleBox">
			[StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's pressed.
		</theme_item>
		<theme_item name="draw_guides" type="int" default="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.
		</theme_item>
		<theme_item name="draw_relationship_lines" type="int" default="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.
		</theme_item>
		<theme_item name="drop_position_color" type="Color" default="Color( 1, 0.3, 0.2, 1 )">
			[Color] used to draw possible drop locations. See [enum DropModeFlags] constants for further description of drop locations.
		</theme_item>
		<theme_item name="font" type="Font">
			[Font] of the item's text.
		</theme_item>
		<theme_item name="font_color" type="Color" default="Color( 0.69, 0.69, 0.69, 1 )">
			Default text [Color] of the item.
		</theme_item>
		<theme_item name="font_color_selected" type="Color" default="Color( 1, 1, 1, 1 )">
			Text [Color] used when the item is selected.
		</theme_item>
		<theme_item name="guide_color" type="Color" default="Color( 0, 0, 0, 0.1 )">
			[Color] of the guideline.
		</theme_item>
		<theme_item name="hseparation" type="int" default="4">
			The horizontal space between item cells. This is also used as the margin at the start of an item when folding is disabled.
		</theme_item>
		<theme_item name="item_margin" type="int" default="12">
			The horizontal margin at the start of an item. This is used when folding is enabled for the item.
		</theme_item>
		<theme_item name="relationship_line_color" type="Color" default="Color( 0.27, 0.27, 0.27, 1 )">
			[Color] of the relationship lines.
		</theme_item>
		<theme_item name="scroll_border" type="int" default="4">
			The maximum distance between the mouse cursor and the control's border to trigger border scrolling when dragging.
		</theme_item>
		<theme_item name="scroll_speed" type="int" default="12">
			The speed of border scrolling.
		</theme_item>
		<theme_item name="select_arrow" type="Texture">
			The arrow icon to display for the [constant TreeItem.CELL_MODE_RANGE] mode cell.
		</theme_item>
		<theme_item name="selected" type="StyleBox">
			[StyleBox] for the selected items, used when the [Tree] is not being focused.
		</theme_item>
		<theme_item name="selected_focus" type="StyleBox">
			[StyleBox] for the selected items, used when the [Tree] is being focused.
		</theme_item>
		<theme_item name="title_button_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
			Default text [Color] of the title button.
		</theme_item>
		<theme_item name="title_button_font" type="Font">
			[Font] of the title button's text.
		</theme_item>
		<theme_item name="title_button_hover" type="StyleBox">
			[StyleBox] used when the title button is being hovered.
		</theme_item>
		<theme_item name="title_button_normal" type="StyleBox">
			Default [StyleBox] for the title button.
		</theme_item>
		<theme_item name="title_button_pressed" type="StyleBox">
			[StyleBox] used when the title button is being pressed.
		</theme_item>
		<theme_item name="unchecked" type="Texture">
			The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is unchecked.
		</theme_item>
		<theme_item name="updown" type="Texture">
			The updown arrow icon to display for the [constant TreeItem.CELL_MODE_RANGE] mode cell.
		</theme_item>
		<theme_item name="vseparation" type="int" default="4">
			The vertical padding inside each item, i.e. the distance between the item's content and top/bottom border.
		</theme_item>
	</theme_items>
</class>