2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 08:08:05 +00:00
<class name= "TreeItem" inherits= "Object" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 20:42:36 +00:00
<brief_description >
2023-04-30 14:26:09 +00:00
An internal control for a single item inside [Tree].
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2023-04-30 14:26:09 +00:00
A single item of a [Tree] control. It can contain other [TreeItem]s as children, which allows it to create a hierarchy. It can also contain text and buttons. [TreeItem] is not a [Node], it is internal to the [Tree].
To create a [TreeItem], use [method Tree.create_item] or [method TreeItem.create_child]. To remove a [TreeItem], use [method Object.free].
[b]Note:[/b] The ID values used for buttons are 32-bit, unlike [int] which is always 64-bit. They go from [code]-2147483648[/code] to [code]2147483647[/code].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_button" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "button" type= "Texture2D" />
<param index= "2" name= "id" type= "int" default= "-1" />
<param index= "3" name= "disabled" type= "bool" default= "false" />
2022-08-29 13:55:49 +00:00
<param index= "4" name= "tooltip_text" type= "String" default= """" />
2017-09-12 20:42:36 +00:00
<description >
2024-09-07 00:37:11 +00:00
Adds a button with [Texture2D] [param button] to the end of the cell at column [param column]. The [param id] is used to identify the button in the according [signal Tree.button_clicked] signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling [method get_button_count] immediately before this method. Optionally, the button can be [param disabled] and have a [param tooltip_text].
2017-09-12 20:42:36 +00:00
</description>
</method>
2023-05-31 09:31:43 +00:00
<method name= "add_child" >
<return type= "void" />
<param index= "0" name= "child" type= "TreeItem" />
<description >
Adds a previously unparented [TreeItem] as a direct child of this one. The [param child] item must not be a part of any [Tree] or parented to any [TreeItem]. See also [method remove_child].
</description>
</method>
2019-10-11 06:45:03 +00:00
<method name= "call_recursive" qualifiers= "vararg" >
2022-02-22 11:15:43 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "method" type= "StringName" />
2019-10-11 06:45:03 +00:00
<description >
2022-08-09 15:19:47 +00:00
Calls the [param method] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list.
2019-10-11 06:45:03 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "clear_custom_bg_color" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Resets the background color for the given column to default.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "clear_custom_color" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Resets the color for the given column to default.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-03-07 20:07:30 +00:00
<method name= "create_child" >
2021-07-30 13:28:05 +00:00
<return type= "TreeItem" />
2022-12-22 07:05:04 +00:00
<param index= "0" name= "index" type= "int" default= "-1" />
2021-03-07 20:07:30 +00:00
<description >
Creates an item and adds it as a child.
2022-12-22 07:05:04 +00:00
The new item will be inserted as position [param index] (the default value [code]-1[/code] means the last position), or it will be the last child if [param index] is higher than the child count.
2021-03-07 20:07:30 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "deselect" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Deselects the given column.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "erase_button" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2022-12-22 07:05:04 +00:00
<param index= "1" name= "button_index" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-12-22 07:05:04 +00:00
Removes the button at index [param button_index] in column [param column].
2017-09-12 20:42:36 +00:00
</description>
</method>
2023-06-03 12:17:35 +00:00
<method name= "get_autowrap_mode" qualifiers= "const" >
<return type= "int" enum= "TextServer.AutowrapMode" />
<param index= "0" name= "column" type= "int" />
<description >
Returns the text autowrap mode in the given [param column]. By default it is [constant TextServer.AUTOWRAP_OFF].
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_button" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Texture2D" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2022-12-22 07:05:04 +00:00
<param index= "1" name= "button_index" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-12-22 07:05:04 +00:00
Returns the [Texture2D] of the button at index [param button_index] in column [param column].
2017-09-12 20:42:36 +00:00
</description>
</method>
2022-02-08 15:56:13 +00:00
<method name= "get_button_by_id" qualifiers= "const" >
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "id" type= "int" />
2022-02-08 15:56:13 +00:00
<description >
2022-12-08 01:40:49 +00:00
Returns the button index if there is a button with ID [param id] in column [param column], otherwise returns -1.
2022-02-08 15:56:13 +00:00
</description>
</method>
2024-01-28 19:55:48 +00:00
<method name= "get_button_color" qualifiers= "const" >
<return type= "Color" />
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "id" type= "int" />
<description >
Returns the color of the button with ID [param id] in column [param column]. If the specified button does not exist, returns [constant Color.BLACK].
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_button_count" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns the number of buttons in column [param column].
2017-09-12 20:42:36 +00:00
</description>
</method>
2022-02-08 15:56:13 +00:00
<method name= "get_button_id" qualifiers= "const" >
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2022-12-22 07:05:04 +00:00
<param index= "1" name= "button_index" type= "int" />
2022-02-08 15:56:13 +00:00
<description >
2022-12-22 07:05:04 +00:00
Returns the ID for the button at index [param button_index] in column [param column].
2022-02-08 15:56:13 +00:00
</description>
</method>
2022-08-29 13:55:49 +00:00
<method name= "get_button_tooltip_text" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2022-12-22 07:05:04 +00:00
<param index= "1" name= "button_index" type= "int" />
2019-09-04 14:47:47 +00:00
<description >
2022-12-22 07:05:04 +00:00
Returns the tooltip text for the button at index [param button_index] in column [param column].
2019-09-04 14:47:47 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_cell_mode" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "TreeItem.TreeCellMode" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2019-06-21 23:04:47 +00:00
Returns the column's cell mode.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-03-07 20:07:30 +00:00
<method name= "get_child" >
2021-07-30 13:28:05 +00:00
<return type= "TreeItem" />
2022-12-22 07:05:04 +00:00
<param index= "0" name= "index" type= "int" />
2021-03-07 20:07:30 +00:00
<description >
2022-12-22 07:05:04 +00:00
Returns a child item by its [param index] (see [method get_child_count]). This method is often used for iterating all children of an item.
2021-03-07 20:07:30 +00:00
Negative indices access the children from the last one.
</description>
</method>
<method name= "get_child_count" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2021-03-07 20:07:30 +00:00
Returns the number of child items.
</description>
</method>
<method name= "get_children" >
2022-08-07 22:52:20 +00:00
<return type= "TreeItem[]" />
2021-03-07 20:07:30 +00:00
<description >
Returns an array of references to the item's children.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_custom_bg_color" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Color" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns the custom background color of column [param column].
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-10-06 20:07:50 +00:00
<method name= "get_custom_color" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Color" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2019-10-06 20:07:50 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns the custom color of column [param column].
2019-10-06 20:07:50 +00:00
</description>
</method>
2024-01-20 16:55:34 +00:00
<method name= "get_custom_draw_callback" qualifiers= "const" >
<return type= "Callable" />
<param index= "0" name= "column" type= "int" />
<description >
Returns the custom callback of column [param column].
</description>
</method>
2021-05-27 15:32:30 +00:00
<method name= "get_custom_font" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Font" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2021-05-27 15:32:30 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns custom font used to draw text in the column [param column].
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name= "get_custom_font_size" qualifiers= "const" >
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns custom font size used to draw text in the column [param column].
2021-05-27 15:32:30 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_expand_right" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Returns [code]true[/code] if [code]expand_right[/code] is set.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-06-28 13:40:56 +00:00
<method name= "get_first_child" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "TreeItem" />
2021-03-07 20:07:30 +00:00
<description >
Returns the TreeItem's first child.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_icon" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Texture2D" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2020-02-12 08:59:06 +00:00
Returns the given column's icon [Texture2D]. Error if no icon is set.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_icon_max_width" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2023-03-31 19:17:59 +00:00
Returns the maximum allowed width of the icon in the given [param column].
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-08-24 15:13:48 +00:00
<method name= "get_icon_modulate" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Color" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2019-08-24 15:13:48 +00:00
<description >
Returns the [Color] modulating the column's icon.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_icon_region" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Rect2" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2020-02-12 08:59:06 +00:00
Returns the icon [Texture2D] region as [Rect2].
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-03-07 20:07:30 +00:00
<method name= "get_index" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
2021-03-07 20:07:30 +00:00
<description >
Returns the node's order in the tree. For example, if called on the first child item the position is [code]0[/code].
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "get_language" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
Returns item's text language code.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_metadata" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Variant" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2021-01-29 04:34:29 +00:00
Returns the metadata value that was set for the given column using [method set_metadata].
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-06-28 13:40:56 +00:00
<method name= "get_next" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "TreeItem" />
2017-09-12 20:42:36 +00:00
<description >
2020-10-10 23:14:17 +00:00
Returns the next sibling TreeItem in the tree or a null object if there is none.
2017-09-12 20:42:36 +00:00
</description>
</method>
2023-05-11 02:17:03 +00:00
<method name= "get_next_in_tree" >
<return type= "TreeItem" />
<param index= "0" name= "wrap" type= "bool" default= "false" />
<description >
Returns the next TreeItem in the tree (in the context of a depth-first search) or a [code]null[/code] object if there is none.
If [param wrap] is enabled, the method will wrap around to the first element in the tree when called on the last element, otherwise it returns [code]null[/code].
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_next_visible" >
2021-07-30 13:28:05 +00:00
<return type= "TreeItem" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "wrap" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2023-05-11 02:17:03 +00:00
Returns the next visible TreeItem in the tree (in the context of a depth-first search) or a [code]null[/code] object if there is none.
2022-08-09 15:19:47 +00:00
If [param wrap] is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns [code]null[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-06-28 13:40:56 +00:00
<method name= "get_parent" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "TreeItem" />
2017-09-12 20:42:36 +00:00
<description >
2020-07-20 12:38:34 +00:00
Returns the parent TreeItem or a null object if there is none.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_prev" >
2021-07-30 13:28:05 +00:00
<return type= "TreeItem" />
2017-09-12 20:42:36 +00:00
<description >
2020-10-10 23:14:17 +00:00
Returns the previous sibling TreeItem in the tree or a null object if there is none.
2017-09-12 20:42:36 +00:00
</description>
</method>
2023-05-11 02:17:03 +00:00
<method name= "get_prev_in_tree" >
<return type= "TreeItem" />
<param index= "0" name= "wrap" type= "bool" default= "false" />
<description >
Returns the previous TreeItem in the tree (in the context of a depth-first search) or a [code]null[/code] object if there is none.
If [param wrap] is enabled, the method will wrap around to the last element in the tree when called on the first visible element, otherwise it returns [code]null[/code].
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_prev_visible" >
2021-07-30 13:28:05 +00:00
<return type= "TreeItem" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "wrap" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2023-05-11 02:17:03 +00:00
Returns the previous visible sibling TreeItem in the tree (in the context of a depth-first search) or a [code]null[/code] object if there is none.
2022-08-09 15:19:47 +00:00
If [param wrap] is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns [code]null[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_range" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2021-01-29 04:34:29 +00:00
Returns the value of a [constant CELL_MODE_RANGE] column.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_range_config" >
2021-07-30 13:28:05 +00:00
<return type= "Dictionary" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2021-01-29 04:34:29 +00:00
Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr".
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "get_structured_text_bidi_override" qualifiers= "const" >
2022-04-19 10:27:18 +00:00
<return type= "int" enum= "TextServer.StructuredTextParser" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2024-05-19 10:37:41 +00:00
Returns the BiDi algorithm override set for this cell.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name= "get_structured_text_bidi_override_options" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Array" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2024-05-19 10:37:41 +00:00
Returns the additional BiDi options set for this cell.
2020-08-12 11:49:10 +00:00
</description>
</method>
2020-05-11 11:23:39 +00:00
<method name= "get_suffix" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2020-05-11 11:23:39 +00:00
<description >
2021-01-29 04:34:29 +00:00
Gets the suffix string shown after the column value.
2020-05-11 11:23:39 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_text" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Returns the given column's text.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-11-25 02:58:47 +00:00
<method name= "get_text_alignment" qualifiers= "const" >
<return type= "int" enum= "HorizontalAlignment" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Returns the given column's text alignment.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "get_text_direction" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "Control.TextDirection" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
Returns item's text base writing direction.
</description>
</method>
2023-06-27 15:22:10 +00:00
<method name= "get_text_overrun_behavior" qualifiers= "const" >
<return type= "int" enum= "TextServer.OverrunBehavior" />
<param index= "0" name= "column" type= "int" />
<description >
Returns the clipping behavior when the text exceeds the item's bounding rectangle in the given [param column]. By default it is [constant TextServer.OVERRUN_TRIM_ELLIPSIS].
</description>
</method>
2022-08-29 13:55:49 +00:00
<method name= "get_tooltip_text" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-29 13:55:49 +00:00
Returns the given column's tooltip text.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-06-28 13:40:56 +00:00
<method name= "get_tree" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Tree" />
2021-03-07 20:07:30 +00:00
<description >
Returns the [Tree] that owns this TreeItem.
</description>
</method>
2022-07-01 13:43:39 +00:00
<method name= "is_any_collapsed" >
<return type= "bool" />
<param index= "0" name= "only_visible" type= "bool" default= "false" />
<description >
Returns [code]true[/code] if this [TreeItem], or any of its descendants, is collapsed.
If [param only_visible] is [code]true[/code] it ignores non-visible [TreeItem]s.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "is_button_disabled" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2022-12-22 07:05:04 +00:00
<param index= "1" name= "button_index" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-12-22 07:05:04 +00:00
Returns [code]true[/code] if the button at index [param button_index] for the given [param column] is disabled.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_checked" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the given [param column] is checked.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_custom_set_as_button" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2024-05-19 10:37:41 +00:00
Returns [code]true[/code] if the cell was made into a button with [method set_custom_as_button].
2017-09-12 20:42:36 +00:00
</description>
</method>
2023-04-25 15:43:26 +00:00
<method name= "is_edit_multiline" qualifiers= "const" >
<return type= "bool" />
<param index= "0" name= "column" type= "int" />
<description >
Returns [code]true[/code] if the given [param column] is multiline editable.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "is_editable" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the given [param column] is editable.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-07-22 20:34:54 +00:00
<method name= "is_indeterminate" qualifiers= "const" >
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2021-07-22 20:34:54 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the given [param column] is indeterminate.
2021-07-22 20:34:54 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "is_selectable" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the given [param column] is selectable.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_selected" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the given [param column] is selected.
2017-09-12 20:42:36 +00:00
</description>
</method>
2024-02-13 21:27:15 +00:00
<method name= "is_visible_in_tree" qualifiers= "const" >
<return type= "bool" />
<description >
Returns [code]true[/code] if [member visible] is [code]true[/code] and all its ancestors are also visible.
</description>
</method>
2021-03-07 20:07:30 +00:00
<method name= "move_after" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "item" type= "TreeItem" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Moves this TreeItem right after the given [param item].
2021-03-07 20:07:30 +00:00
[b]Note:[/b] You can't move to the root or move the root.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-03-07 20:07:30 +00:00
<method name= "move_before" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "item" type= "TreeItem" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Moves this TreeItem right before the given [param item].
2021-03-07 20:07:30 +00:00
[b]Note:[/b] You can't move to the root or move the root.
2017-09-12 20:42:36 +00:00
</description>
2021-09-17 15:50:24 +00:00
</method>
<method name= "propagate_check" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "emit_signal" type= "bool" default= "true" />
2021-09-17 15:50:24 +00:00
<description >
2022-08-09 15:19:47 +00:00
Propagates this item's checked status to its children and parents for the given [param column]. It is possible to process the items affected by this method call by connecting to [signal Tree.check_propagated_to_item]. The order that the items affected will be processed is as follows: the item invoking this method, children of that item, and finally parents of that item. If [param emit_signal] is [code]false[/code], then [signal Tree.check_propagated_to_item] will not be emitted.
2021-09-17 15:50:24 +00:00
</description>
2017-09-12 20:42:36 +00:00
</method>
<method name= "remove_child" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "child" type= "TreeItem" />
2017-09-12 20:42:36 +00:00
<description >
2023-05-31 09:31:43 +00:00
Removes the given child [TreeItem] and all its children from the [Tree]. Note that it doesn't free the item from memory, so it can be reused later (see [method add_child]). To completely remove a [TreeItem] use [method Object.free].
[b]Note:[/b] If you want to move a child from one [Tree] to another, then instead of removing and adding it manually you can use [method move_before] or [method move_after].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "select" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-09 15:19:47 +00:00
Selects the given [param column].
2017-09-12 20:42:36 +00:00
</description>
</method>
2023-06-03 12:17:35 +00:00
<method name= "set_autowrap_mode" >
<return type= "void" />
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "autowrap_mode" type= "int" enum= "TextServer.AutowrapMode" />
<description >
Sets the autowrap mode in the given [param column]. If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the cell's bounding rectangle.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_button" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2022-12-22 07:05:04 +00:00
<param index= "1" name= "button_index" type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "2" name= "button" type= "Texture2D" />
2017-09-12 20:42:36 +00:00
<description >
2022-12-22 07:05:04 +00:00
Sets the given column's button [Texture2D] at index [param button_index] to [param button].
2017-09-12 20:42:36 +00:00
</description>
</method>
2022-10-09 08:29:44 +00:00
<method name= "set_button_color" >
<return type= "void" />
<param index= "0" name= "column" type= "int" />
2022-12-22 07:05:04 +00:00
<param index= "1" name= "button_index" type= "int" />
2022-10-09 08:29:44 +00:00
<param index= "2" name= "color" type= "Color" />
<description >
2022-12-22 07:05:04 +00:00
Sets the given column's button color at index [param button_index] to [param color].
2022-10-09 08:29:44 +00:00
</description>
</method>
2019-07-09 07:13:00 +00:00
<method name= "set_button_disabled" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
2022-12-22 07:05:04 +00:00
<param index= "1" name= "button_index" type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "2" name= "disabled" type= "bool" />
2019-07-09 07:13:00 +00:00
<description >
2022-12-22 07:05:04 +00:00
If [code]true[/code], disables the button at index [param button_index] in the given [param column].
2019-07-09 07:13:00 +00:00
</description>
</method>
2023-06-18 08:51:58 +00:00
<method name= "set_button_tooltip_text" >
<return type= "void" />
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "button_index" type= "int" />
<param index= "2" name= "tooltip" type= "String" />
<description >
Sets the tooltip text for the button at index [param button_index] in the given [param column].
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_cell_mode" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "mode" type= "int" enum= "TreeItem.TreeCellMode" />
2017-09-12 20:42:36 +00:00
<description >
2024-05-19 10:37:41 +00:00
Sets the given column's cell mode to [param mode]. This determines how the cell is displayed and edited. See [enum TreeCellMode] constants for details.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_checked" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "checked" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2023-04-25 15:43:26 +00:00
If [param checked] is [code]true[/code], the given [param column] is checked. Clears column's indeterminate status.
2017-09-12 20:42:36 +00:00
</description>
</method>
2022-07-01 13:43:39 +00:00
<method name= "set_collapsed_recursive" >
<return type= "void" />
<param index= "0" name= "enable" type= "bool" />
<description >
Collapses or uncollapses this [TreeItem] and all the descendants of this item.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_custom_as_button" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "enable" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2024-05-19 10:37:41 +00:00
Makes a cell with [constant CELL_MODE_CUSTOM] display as a non-flat button with a [StyleBox].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_custom_bg_color" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "color" type= "Color" />
<param index= "2" name= "just_outline" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's custom background color and whether to just use it as an outline.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_custom_color" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "color" type= "Color" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's custom color.
2017-09-12 20:42:36 +00:00
</description>
</method>
2024-02-12 13:55:02 +00:00
<method name= "set_custom_draw" deprecated= "Use [method TreeItem.set_custom_draw_callback] instead." >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "object" type= "Object" />
<param index= "2" name= "callback" type= "StringName" />
2017-09-12 20:42:36 +00:00
<description >
2024-02-17 00:06:33 +00:00
Sets the given column's custom draw callback to the [param callback] method on [param object].
The method named [param callback] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2].
2024-01-20 16:55:34 +00:00
</description>
</method>
<method name= "set_custom_draw_callback" >
<return type= "void" />
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "callback" type= "Callable" />
<description >
2024-05-19 10:37:41 +00:00
Sets the given column's custom draw callback. Use an empty [Callable] ([code skip-lint]Callable()[/code]) to clear the custom callback. The cell has to be in [constant CELL_MODE_CUSTOM] to use this feature.
2024-01-20 16:55:34 +00:00
The [param callback] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2].
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-05-27 15:32:30 +00:00
<method name= "set_custom_font" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "font" type= "Font" />
2021-05-27 15:32:30 +00:00
<description >
2022-08-09 15:19:47 +00:00
Sets custom font used to draw text in the given [param column].
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name= "set_custom_font_size" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "font_size" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
2022-08-09 15:19:47 +00:00
Sets custom font size used to draw text in the given [param column].
2021-05-27 15:32:30 +00:00
</description>
</method>
2023-04-25 15:43:26 +00:00
<method name= "set_edit_multiline" >
<return type= "void" />
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "multiline" type= "bool" />
<description >
If [param multiline] is [code]true[/code], the given [param column] is multiline editable.
[b]Note:[/b] This option only affects the type of control ([LineEdit] or [TextEdit]) that appears when editing the column. You can set multiline values with [method set_text] even if the column is not multiline editable.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_editable" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "enabled" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2023-04-25 15:43:26 +00:00
If [param enabled] is [code]true[/code], the given [param column] is editable.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_expand_right" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "enable" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2023-04-25 15:43:26 +00:00
If [param enable] is [code]true[/code], the given [param column] is expanded to the right.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_icon" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "texture" type= "Texture2D" />
2017-09-12 20:42:36 +00:00
<description >
2024-09-07 00:37:11 +00:00
Sets the given cell's icon [Texture2D]. If the cell is in [constant CELL_MODE_ICON] mode, the icon is displayed in the center of the cell. Otherwise, the icon is displayed before the cell's text. [constant CELL_MODE_RANGE] does not display an icon.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_icon_max_width" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "width" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2023-03-31 19:17:59 +00:00
Sets the maximum allowed width of the icon in the given [param column]. This limit is applied on top of the default size of the icon and on top of [theme_item Tree.icon_max_width]. The height is adjusted according to the icon's ratio.
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-08-24 15:13:48 +00:00
<method name= "set_icon_modulate" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "modulate" type= "Color" />
2019-08-24 15:13:48 +00:00
<description >
2022-08-09 15:19:47 +00:00
Modulates the given column's icon with [param modulate].
2019-08-24 15:13:48 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_icon_region" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "region" type= "Rect2" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's icon's texture region.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-07-22 20:34:54 +00:00
<method name= "set_indeterminate" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "indeterminate" type= "bool" />
2021-07-22 20:34:54 +00:00
<description >
2023-04-25 15:43:26 +00:00
If [param indeterminate] is [code]true[/code], the given [param column] is marked indeterminate.
2021-07-22 20:34:54 +00:00
[b]Note:[/b] If set [code]true[/code] from [code]false[/code], then column is cleared of checked status.
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "set_language" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "language" type= "String" />
2020-08-12 11:49:10 +00:00
<description >
Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_metadata" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "meta" type= "Variant" />
2017-09-12 20:42:36 +00:00
<description >
2021-01-29 04:34:29 +00:00
Sets the metadata value for the given column, which can be retrieved later using [method get_metadata]. This can be used, for example, to store a reference to the original data.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_range" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "value" type= "float" />
2017-09-12 20:42:36 +00:00
<description >
2021-01-29 04:34:29 +00:00
Sets the value of a [constant CELL_MODE_RANGE] column.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_range_config" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "min" type= "float" />
<param index= "2" name= "max" type= "float" />
<param index= "3" name= "step" type= "float" />
<param index= "4" name= "expr" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2021-01-29 04:34:29 +00:00
Sets the range of accepted values for a column. The column must be in the [constant CELL_MODE_RANGE] mode.
2022-08-09 15:19:47 +00:00
If [param expr] is [code]true[/code], the edit mode slider will use an exponential scale as with [member Range.exp_edit].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_selectable" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "selectable" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2023-04-25 15:43:26 +00:00
If [param selectable] is [code]true[/code], the given [param column] is selectable.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "set_structured_text_bidi_override" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "parser" type= "int" enum= "TextServer.StructuredTextParser" />
2020-08-12 11:49:10 +00:00
<description >
2024-05-19 10:37:41 +00:00
Set BiDi algorithm override for the structured text. Has effect for cells that display text.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name= "set_structured_text_bidi_override_options" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "args" type= "Array" />
2020-08-12 11:49:10 +00:00
<description >
2024-05-19 10:37:41 +00:00
Set additional options for BiDi override. Has effect for cells that display text.
2020-08-12 11:49:10 +00:00
</description>
</method>
2020-05-11 11:23:39 +00:00
<method name= "set_suffix" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "text" type= "String" />
2020-05-11 11:23:39 +00:00
<description >
2021-01-29 04:34:29 +00:00
Sets a string to be shown after a column's value (for example, a unit abbreviation).
2020-05-11 11:23:39 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_text" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "text" type= "String" />
2017-09-12 20:42:36 +00:00
<description >
2021-01-29 04:34:29 +00:00
Sets the given column's text value.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-11-25 02:58:47 +00:00
<method name= "set_text_alignment" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "text_alignment" type= "int" enum= "HorizontalAlignment" />
2017-09-12 20:42:36 +00:00
<description >
2021-11-25 02:58:47 +00:00
Sets the given column's text alignment. See [enum HorizontalAlignment] for possible values.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "set_text_direction" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "direction" type= "int" enum= "Control.TextDirection" />
2020-08-12 11:49:10 +00:00
<description >
Sets item's text base writing direction.
</description>
</method>
2023-06-27 15:22:10 +00:00
<method name= "set_text_overrun_behavior" >
<return type= "void" />
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "overrun_behavior" type= "int" enum= "TextServer.OverrunBehavior" />
<description >
Sets the clipping behavior when the text exceeds the item's bounding rectangle in the given [param column].
</description>
</method>
2022-08-29 13:55:49 +00:00
<method name= "set_tooltip_text" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "column" type= "int" />
<param index= "1" name= "tooltip" type= "String" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's tooltip text.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-03-25 11:19:51 +00:00
<method name= "uncollapse_tree" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2021-03-25 11:19:51 +00:00
<description >
2023-09-26 14:26:32 +00:00
Uncollapses all [TreeItem]s necessary to reveal this [TreeItem], i.e. all ancestor [TreeItem]s.
2021-03-25 11:19:51 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
2018-01-11 22:38:35 +00:00
<members >
<member name= "collapsed" type= "bool" setter= "set_collapsed" getter= "is_collapsed" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the TreeItem is collapsed.
2018-01-11 22:38:35 +00:00
</member>
<member name= "custom_minimum_height" type= "int" setter= "set_custom_minimum_height" getter= "get_custom_minimum_height" >
The custom minimum height.
</member>
<member name= "disable_folding" type= "bool" setter= "set_disable_folding" getter= "is_folding_disabled" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], folding is disabled for this TreeItem.
2018-01-11 22:38:35 +00:00
</member>
2022-04-03 08:37:08 +00:00
<member name= "visible" type= "bool" setter= "set_visible" getter= "is_visible" >
If [code]true[/code], the [TreeItem] is visible (default).
Note that if a [TreeItem] is set to not be visible, none of its children will be visible either.
</member>
2018-01-11 22:38:35 +00:00
</members>
2017-09-12 20:42:36 +00:00
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "CELL_MODE_STRING" value= "0" enum= "TreeCellMode" >
2024-09-07 00:37:11 +00:00
Cell shows a string label, optionally with an icon. When editable, the text can be edited using a [LineEdit], or a [TextEdit] popup if [method set_edit_multiline] is used.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CELL_MODE_CHECK" value= "1" enum= "TreeCellMode" >
2024-09-07 00:37:11 +00:00
Cell shows a checkbox, optionally with text and an icon. The checkbox can be pressed, released, or indeterminate (via [method set_indeterminate]). The checkbox can't be clicked unless the cell is editable.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CELL_MODE_RANGE" value= "2" enum= "TreeCellMode" >
2024-05-19 10:37:41 +00:00
Cell shows a numeric range. When editable, it can be edited using a range slider. Use [method set_range] to set the value and [method set_range_config] to configure the range.
This cell can also be used in a text dropdown mode when you assign a text with [method set_text]. Separate options with a comma, e.g. [code]"Option1,Option2,Option3"[/code].
2017-09-12 20:42:36 +00:00
</constant>
2018-10-07 13:52:07 +00:00
<constant name= "CELL_MODE_ICON" value= "3" enum= "TreeCellMode" >
2024-09-07 00:37:11 +00:00
Cell shows an icon. It can't be edited nor display text. The icon is always centered within the cell.
2017-09-12 20:42:36 +00:00
</constant>
2018-10-07 13:52:07 +00:00
<constant name= "CELL_MODE_CUSTOM" value= "4" enum= "TreeCellMode" >
2024-05-19 10:37:41 +00:00
Cell shows as a clickable button. It will display an arrow similar to [OptionButton], but doesn't feature a dropdown (for that you can use [constant CELL_MODE_RANGE]). Clicking the button emits the [signal Tree.item_edited] signal. The button is flat by default, you can use [method set_custom_as_button] to display it with a [StyleBox].
This mode also supports custom drawing using [method set_custom_draw_callback].
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>