2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 10:33:56 +00:00
<class name= "TreeItem" inherits= "Object" category= "Core" version= "3.2" >
2017-09-12 20:42:36 +00:00
<brief_description >
2017-10-07 17:43:24 +00:00
Control for a single item inside a [Tree].
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2019-03-29 22:37:35 +00:00
Control for a single item inside a [Tree]. May have child [TreeItem]s and be styled as well as contain buttons.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_button" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "button" type= "Texture" >
</argument>
<argument index= "2" name= "button_idx" type= "int" default= "-1" >
</argument>
<argument index= "3" name= "disabled" type= "bool" default= "false" >
</argument>
<argument index= "4" name= "tooltip" type= "String" default= """" >
</argument>
<description >
2018-10-13 10:34:57 +00:00
Adds a button with [Texture] [code]button[/code] at column [code]column[/code]. The [code]button_idx[/code] index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling [method get_button_count] immediately after this method. Optionally, the button can be [code]disabled[/code] and have a [code]tooltip[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "clear_custom_bg_color" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<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" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<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>
<method name= "deselect" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<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" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "button_idx" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Removes the button at index [code]button_idx[/code] in column [code]column[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_button" qualifiers= "const" >
<return type= "Texture" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "button_idx" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns the [Texture] of the button at index [code]button_idx[/code] in column [code]column[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_button_count" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns the number of buttons in column [code]column[/code]. May be used to get the most recently added button's index, if no index was specified.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_cell_mode" qualifiers= "const" >
<return type= "int" enum= "TreeItem.TreeCellMode" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<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>
<method name= "get_children" >
<return type= "TreeItem" >
</return>
<description >
2017-10-07 17:43:24 +00:00
Returns the TreeItem's child items.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_custom_bg_color" qualifiers= "const" >
<return type= "Color" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns the custom background color of column [code]column[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_expand_right" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<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>
<method name= "get_icon" qualifiers= "const" >
<return type= "Texture" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns the given column's icon [Texture]. Error if no icon is set.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_icon_max_width" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns the column's icon's maximum width.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_icon_region" qualifiers= "const" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns the icon [Texture] region as [Rect2].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_metadata" qualifiers= "const" >
<return type= "Variant" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "get_next" >
<return type= "TreeItem" >
</return>
<description >
2017-10-07 17:43:24 +00:00
Returns the next TreeItem in the tree.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_next_visible" >
<return type= "TreeItem" >
</return>
2019-06-01 10:34:29 +00:00
<argument index= "0" name= "wrap" type= "bool" default= "false" >
</argument>
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Returns the next visible TreeItem in the tree.
2019-06-01 10:34:29 +00:00
If [code]wrap[/code] 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>
<method name= "get_parent" >
<return type= "TreeItem" >
</return>
<description >
2017-10-07 17:43:24 +00:00
Returns the parent TreeItem.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_prev" >
<return type= "TreeItem" >
</return>
<description >
2017-10-07 17:43:24 +00:00
Returns the previous TreeItem in the tree.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_prev_visible" >
<return type= "TreeItem" >
</return>
2019-06-01 10:34:29 +00:00
<argument index= "0" name= "wrap" type= "bool" default= "false" >
</argument>
2017-09-12 20:42:36 +00:00
<description >
2017-10-07 17:43:24 +00:00
Returns the previous visible TreeItem in the tree.
2019-06-01 10:34:29 +00:00
If [code]wrap[/code] 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" >
<return type= "float" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "get_range_config" >
<return type= "Dictionary" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "get_text" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<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>
<method name= "get_text_align" qualifiers= "const" >
<return type= "int" enum= "TreeItem.TextAlign" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<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>
<method name= "get_tooltip" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns the given column's tooltip.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_button_disabled" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "button_idx" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns [code]true[/code] if the button at index [code]button_idx[/code] for the given column is disabled.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_checked" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns [code]true[/code] if the given column is checked.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_custom_set_as_button" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "is_editable" >
<return type= "bool" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns [code]true[/code] if column [code]column[/code] is editable.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_selectable" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns [code]true[/code] if column [code]column[/code] is selectable.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_selected" >
<return type= "bool" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Returns [code]true[/code] if column [code]column[/code] is selected.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "move_to_bottom" >
<return type= "void" >
</return>
<description >
2017-10-07 17:43:24 +00:00
Moves this TreeItem to the bottom in the [Tree] hierarchy.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "move_to_top" >
<return type= "void" >
</return>
<description >
2017-10-07 17:43:24 +00:00
Moves this TreeItem to the top in the [Tree] hierarchy.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "remove_child" >
<return type= "void" >
</return>
<argument index= "0" name= "child" type= "Object" >
</argument>
<description >
2018-06-18 01:28:26 +00:00
Removes the given child TreeItem.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "select" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Selects the column [code]column[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_button" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "button_idx" type= "int" >
</argument>
<argument index= "2" name= "button" type= "Texture" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's button [Texture] at index [code]button_idx[/code] to [code]button[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_cell_mode" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "mode" type= "int" enum= "TreeItem.TreeCellMode" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's cell mode to [code]mode[/code]. See [code]CELL_MODE_*[/code] constants.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_checked" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "checked" type= "bool" >
</argument>
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the column [code]column[/code] is checked.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_custom_as_button" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
</description>
</method>
<method name= "set_custom_bg_color" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "color" type= "Color" >
</argument>
<argument index= "2" name= "just_outline" type= "bool" default= "false" >
</argument>
<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" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "color" type= "Color" >
</argument>
<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>
<method name= "set_custom_draw" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "object" type= "Object" >
</argument>
<argument index= "2" name= "callback" type= "String" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code].
2018-10-02 16:43:09 +00:00
The [code]callback[/code] 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>
<method name= "set_editable" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "enabled" type= "bool" >
</argument>
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], column [code]column[/code] is editable.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_expand_right" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], column [code]column[/code] is expanded to the right.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_icon" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "texture" type= "Texture" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's icon [Texture].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_icon_max_width" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "width" type= "int" >
</argument>
<description >
2017-10-07 17:43:24 +00:00
Sets the given column's icon's maximum width.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_icon_region" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "region" type= "Rect2" >
</argument>
<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>
<method name= "set_metadata" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "meta" type= "Variant" >
</argument>
<description >
</description>
</method>
<method name= "set_range" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "value" type= "float" >
</argument>
<description >
</description>
</method>
<method name= "set_range_config" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "min" type= "float" >
</argument>
<argument index= "2" name= "max" type= "float" >
</argument>
<argument index= "3" name= "step" type= "float" >
</argument>
<argument index= "4" name= "expr" type= "bool" default= "false" >
</argument>
<description >
</description>
</method>
<method name= "set_selectable" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "selectable" type= "bool" >
</argument>
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the given column is selectable.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_text" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "text" type= "String" >
</argument>
<description >
</description>
</method>
<method name= "set_text_align" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "text_align" type= "int" enum= "TreeItem.TextAlign" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Sets the given column's text alignment. See [enum TextAlign] for possible values.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_tooltip" >
<return type= "void" >
</return>
<argument index= "0" name= "column" type= "int" >
</argument>
<argument index= "1" name= "tooltip" type= "String" >
</argument>
<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>
</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>
</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" >
2017-10-07 17:43:24 +00:00
Cell contains a string.
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" >
2017-10-07 17:43:24 +00:00
Cell can be checked.
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" >
2017-10-07 17:43:24 +00:00
Cell contains a range.
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" >
2017-10-07 17:43:24 +00:00
Cell contains an icon.
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" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_LEFT" value= "0" enum= "TextAlign" >
2017-10-07 17:43:24 +00:00
Align text to the left. See [code]set_text_align()[/code].
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_CENTER" value= "1" enum= "TextAlign" >
2017-10-07 17:43:24 +00:00
Center text. See [code]set_text_align()[/code].
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_RIGHT" value= "2" enum= "TextAlign" >
2017-10-07 17:43:24 +00:00
Align text to the right. See [code]set_text_align()[/code].
2017-09-15 23:46:14 +00:00
</constant>
2017-09-12 20:42:36 +00:00
</constants>
</class>
