godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.2
godot-docs/classes/class_treeitem.rst
Godot Organization 77af6c9b61 classref: Sync with current 4.2 branch (f9d101d)
2024-05-07 11:26:31 +00:00

1626 lines
102 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TreeItem.xml.
.. _class_TreeItem:
TreeItem
========
**Inherits:** :ref:`Object<class_Object>`
An internal control for a single item inside :ref:`Tree<class_Tree>`.
.. rst-class:: classref-introduction-group
Description
-----------
A single item of a :ref:`Tree<class_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 :ref:`Node<class_Node>`, it is internal to the :ref:`Tree<class_Tree>`.
To create a **TreeItem**, use :ref:`Tree.create_item<class_Tree_method_create_item>` or :ref:`create_child<class_TreeItem_method_create_child>`. To remove a **TreeItem**, use :ref:`Object.free<class_Object_method_free>`.
\ **Note:** The ID values used for buttons are 32-bit, unlike :ref:`int<class_int>` which is always 64-bit. They go from ``-2147483648`` to ``2147483647``.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`collapsed<class_TreeItem_property_collapsed>` |
+-------------------------+-----------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`custom_minimum_height<class_TreeItem_property_custom_minimum_height>` |
+-------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disable_folding<class_TreeItem_property_disable_folding>` |
+-------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`visible<class_TreeItem_property_visible>` |
+-------------------------+-----------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_button<class_TreeItem_method_add_button>` **(** :ref:`int<class_int>` column, :ref:`Texture2D<class_Texture2D>` button, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` disabled=false, :ref:`String<class_String>` tooltip_text="" **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_child<class_TreeItem_method_add_child>` **(** :ref:`TreeItem<class_TreeItem>` child **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`call_recursive<class_TreeItem_method_call_recursive>` **(** :ref:`StringName<class_StringName>` method, ... **)** |vararg| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_custom_bg_color<class_TreeItem_method_clear_custom_bg_color>` **(** :ref:`int<class_int>` column **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_custom_color<class_TreeItem_method_clear_custom_color>` **(** :ref:`int<class_int>` column **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`create_child<class_TreeItem_method_create_child>` **(** :ref:`int<class_int>` index=-1 **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`deselect<class_TreeItem_method_deselect>` **(** :ref:`int<class_int>` column **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_button<class_TreeItem_method_erase_button>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` | :ref:`get_autowrap_mode<class_TreeItem_method_get_autowrap_mode>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_button<class_TreeItem_method_get_button>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_by_id<class_TreeItem_method_get_button_by_id>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` id **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_count<class_TreeItem_method_get_button_count>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_id<class_TreeItem_method_get_button_id>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_button_tooltip_text<class_TreeItem_method_get_button_tooltip_text>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` | :ref:`get_cell_mode<class_TreeItem_method_get_cell_mode>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_child<class_TreeItem_method_get_child>` **(** :ref:`int<class_int>` index **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_child_count<class_TreeItem_method_get_child_count>` **(** **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem[]<class_TreeItem>` | :ref:`get_children<class_TreeItem_method_get_children>` **(** **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`get_custom_bg_color<class_TreeItem_method_get_custom_bg_color>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`get_custom_color<class_TreeItem_method_get_custom_color>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Font<class_Font>` | :ref:`get_custom_font<class_TreeItem_method_get_custom_font>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_custom_font_size<class_TreeItem_method_get_custom_font_size>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_expand_right<class_TreeItem_method_get_expand_right>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_first_child<class_TreeItem_method_get_first_child>` **(** **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_icon<class_TreeItem_method_get_icon>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_icon_max_width<class_TreeItem_method_get_icon_max_width>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`get_icon_modulate<class_TreeItem_method_get_icon_modulate>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`get_icon_region<class_TreeItem_method_get_icon_region>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_index<class_TreeItem_method_get_index>` **(** **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_language<class_TreeItem_method_get_language>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_metadata<class_TreeItem_method_get_metadata>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_next<class_TreeItem_method_get_next>` **(** **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_next_in_tree<class_TreeItem_method_get_next_in_tree>` **(** :ref:`bool<class_bool>` wrap=false **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_next_visible<class_TreeItem_method_get_next_visible>` **(** :ref:`bool<class_bool>` wrap=false **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_parent<class_TreeItem_method_get_parent>` **(** **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_prev<class_TreeItem_method_get_prev>` **(** **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_prev_in_tree<class_TreeItem_method_get_prev_in_tree>` **(** :ref:`bool<class_bool>` wrap=false **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_prev_visible<class_TreeItem_method_get_prev_visible>` **(** :ref:`bool<class_bool>` wrap=false **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_range<class_TreeItem_method_get_range>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_range_config<class_TreeItem_method_get_range_config>` **(** :ref:`int<class_int>` column **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` | :ref:`get_structured_text_bidi_override<class_TreeItem_method_get_structured_text_bidi_override>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_structured_text_bidi_override_options<class_TreeItem_method_get_structured_text_bidi_override_options>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_suffix<class_TreeItem_method_get_suffix>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_text<class_TreeItem_method_get_text>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` | :ref:`get_text_alignment<class_TreeItem_method_get_text_alignment>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`get_text_direction<class_TreeItem_method_get_text_direction>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` | :ref:`get_text_overrun_behavior<class_TreeItem_method_get_text_overrun_behavior>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_tooltip_text<class_TreeItem_method_get_tooltip_text>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Tree<class_Tree>` | :ref:`get_tree<class_TreeItem_method_get_tree>` **(** **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_any_collapsed<class_TreeItem_method_is_any_collapsed>` **(** :ref:`bool<class_bool>` only_visible=false **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_button_disabled<class_TreeItem_method_is_button_disabled>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_checked<class_TreeItem_method_is_checked>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_custom_set_as_button<class_TreeItem_method_is_custom_set_as_button>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_edit_multiline<class_TreeItem_method_is_edit_multiline>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editable<class_TreeItem_method_is_editable>` **(** :ref:`int<class_int>` column **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_indeterminate<class_TreeItem_method_is_indeterminate>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selectable<class_TreeItem_method_is_selectable>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selected<class_TreeItem_method_is_selected>` **(** :ref:`int<class_int>` column **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_after<class_TreeItem_method_move_after>` **(** :ref:`TreeItem<class_TreeItem>` item **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_before<class_TreeItem_method_move_before>` **(** :ref:`TreeItem<class_TreeItem>` item **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`propagate_check<class_TreeItem_method_propagate_check>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` emit_signal=true **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_child<class_TreeItem_method_remove_child>` **(** :ref:`TreeItem<class_TreeItem>` child **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select<class_TreeItem_method_select>` **(** :ref:`int<class_int>` column **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autowrap_mode<class_TreeItem_method_set_autowrap_mode>` **(** :ref:`int<class_int>` column, :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` autowrap_mode **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button<class_TreeItem_method_set_button>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index, :ref:`Texture2D<class_Texture2D>` button **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_color<class_TreeItem_method_set_button_color>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index, :ref:`Color<class_Color>` color **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_disabled<class_TreeItem_method_set_button_disabled>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index, :ref:`bool<class_bool>` disabled **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_tooltip_text<class_TreeItem_method_set_button_tooltip_text>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index, :ref:`String<class_String>` tooltip **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_mode<class_TreeItem_method_set_cell_mode>` **(** :ref:`int<class_int>` column, :ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` mode **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_checked<class_TreeItem_method_set_checked>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` checked **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collapsed_recursive<class_TreeItem_method_set_collapsed_recursive>` **(** :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_as_button<class_TreeItem_method_set_custom_as_button>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_bg_color<class_TreeItem_method_set_custom_bg_color>` **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` just_outline=false **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_color<class_TreeItem_method_set_custom_color>` **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` color **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_draw<class_TreeItem_method_set_custom_draw>` **(** :ref:`int<class_int>` column, :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` callback **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_font<class_TreeItem_method_set_custom_font>` **(** :ref:`int<class_int>` column, :ref:`Font<class_Font>` font **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_font_size<class_TreeItem_method_set_custom_font_size>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` font_size **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_multiline<class_TreeItem_method_set_edit_multiline>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` multiline **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_editable<class_TreeItem_method_set_editable>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_expand_right<class_TreeItem_method_set_expand_right>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon<class_TreeItem_method_set_icon>` **(** :ref:`int<class_int>` column, :ref:`Texture2D<class_Texture2D>` texture **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon_max_width<class_TreeItem_method_set_icon_max_width>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` width **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon_modulate<class_TreeItem_method_set_icon_modulate>` **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` modulate **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon_region<class_TreeItem_method_set_icon_region>` **(** :ref:`int<class_int>` column, :ref:`Rect2<class_Rect2>` region **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_indeterminate<class_TreeItem_method_set_indeterminate>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` indeterminate **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_language<class_TreeItem_method_set_language>` **(** :ref:`int<class_int>` column, :ref:`String<class_String>` language **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_metadata<class_TreeItem_method_set_metadata>` **(** :ref:`int<class_int>` column, :ref:`Variant<class_Variant>` meta **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_range<class_TreeItem_method_set_range>` **(** :ref:`int<class_int>` column, :ref:`float<class_float>` value **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_range_config<class_TreeItem_method_set_range_config>` **(** :ref:`int<class_int>` column, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` step, :ref:`bool<class_bool>` expr=false **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selectable<class_TreeItem_method_set_selectable>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` selectable **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_structured_text_bidi_override<class_TreeItem_method_set_structured_text_bidi_override>` **(** :ref:`int<class_int>` column, :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_structured_text_bidi_override_options<class_TreeItem_method_set_structured_text_bidi_override_options>` **(** :ref:`int<class_int>` column, :ref:`Array<class_Array>` args **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_suffix<class_TreeItem_method_set_suffix>` **(** :ref:`int<class_int>` column, :ref:`String<class_String>` text **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_TreeItem_method_set_text>` **(** :ref:`int<class_int>` column, :ref:`String<class_String>` text **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text_alignment<class_TreeItem_method_set_text_alignment>` **(** :ref:`int<class_int>` column, :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` text_alignment **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text_direction<class_TreeItem_method_set_text_direction>` **(** :ref:`int<class_int>` column, :ref:`TextDirection<enum_Control_TextDirection>` direction **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text_overrun_behavior<class_TreeItem_method_set_text_overrun_behavior>` **(** :ref:`int<class_int>` column, :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` overrun_behavior **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tooltip_text<class_TreeItem_method_set_tooltip_text>` **(** :ref:`int<class_int>` column, :ref:`String<class_String>` tooltip **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`uncollapse_tree<class_TreeItem_method_uncollapse_tree>` **(** **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_TreeItem_TreeCellMode:
.. rst-class:: classref-enumeration
enum **TreeCellMode**:
.. _class_TreeItem_constant_CELL_MODE_STRING:
.. rst-class:: classref-enumeration-constant
:ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` **CELL_MODE_STRING** = ``0``
Cell contains a string.
.. _class_TreeItem_constant_CELL_MODE_CHECK:
.. rst-class:: classref-enumeration-constant
:ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` **CELL_MODE_CHECK** = ``1``
Cell contains a checkbox.
.. _class_TreeItem_constant_CELL_MODE_RANGE:
.. rst-class:: classref-enumeration-constant
:ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` **CELL_MODE_RANGE** = ``2``
Cell contains a range.
.. _class_TreeItem_constant_CELL_MODE_ICON:
.. rst-class:: classref-enumeration-constant
:ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` **CELL_MODE_ICON** = ``3``
Cell contains an icon.
.. _class_TreeItem_constant_CELL_MODE_CUSTOM:
.. rst-class:: classref-enumeration-constant
:ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` **CELL_MODE_CUSTOM** = ``4``
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_TreeItem_property_collapsed:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **collapsed**
.. rst-class:: classref-property-setget
- void **set_collapsed** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_collapsed** **(** **)**
If ``true``, the TreeItem is collapsed.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_property_custom_minimum_height:
.. rst-class:: classref-property
:ref:`int<class_int>` **custom_minimum_height**
.. rst-class:: classref-property-setget
- void **set_custom_minimum_height** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_custom_minimum_height** **(** **)**
The custom minimum height.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_property_disable_folding:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **disable_folding**
.. rst-class:: classref-property-setget
- void **set_disable_folding** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_folding_disabled** **(** **)**
If ``true``, folding is disabled for this TreeItem.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_property_visible:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **visible**
.. rst-class:: classref-property-setget
- void **set_visible** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_visible** **(** **)**
If ``true``, the **TreeItem** is visible (default).
Note that if a **TreeItem** is set to not be visible, none of its children will be visible either.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_TreeItem_method_add_button:
.. rst-class:: classref-method
void **add_button** **(** :ref:`int<class_int>` column, :ref:`Texture2D<class_Texture2D>` button, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` disabled=false, :ref:`String<class_String>` tooltip_text="" **)**
Adds a button with :ref:`Texture2D<class_Texture2D>` ``button`` at column ``column``. The ``id`` is used to identify the button in the according :ref:`Tree.button_clicked<class_Tree_signal_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 :ref:`get_button_count<class_TreeItem_method_get_button_count>` immediately before this method. Optionally, the button can be ``disabled`` and have a ``tooltip_text``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_add_child:
.. rst-class:: classref-method
void **add_child** **(** :ref:`TreeItem<class_TreeItem>` child **)**
Adds a previously unparented **TreeItem** as a direct child of this one. The ``child`` item must not be a part of any :ref:`Tree<class_Tree>` or parented to any **TreeItem**. See also :ref:`remove_child<class_TreeItem_method_remove_child>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_call_recursive:
.. rst-class:: classref-method
void **call_recursive** **(** :ref:`StringName<class_StringName>` method, ... **)** |vararg|
Calls the ``method`` on the actual TreeItem and its children recursively. Pass parameters as a comma separated list.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_clear_custom_bg_color:
.. rst-class:: classref-method
void **clear_custom_bg_color** **(** :ref:`int<class_int>` column **)**
Resets the background color for the given column to default.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_clear_custom_color:
.. rst-class:: classref-method
void **clear_custom_color** **(** :ref:`int<class_int>` column **)**
Resets the color for the given column to default.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_create_child:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **create_child** **(** :ref:`int<class_int>` index=-1 **)**
Creates an item and adds it as a child.
The new item will be inserted as position ``index`` (the default value ``-1`` means the last position), or it will be the last child if ``index`` is higher than the child count.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_deselect:
.. rst-class:: classref-method
void **deselect** **(** :ref:`int<class_int>` column **)**
Deselects the given column.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_erase_button:
.. rst-class:: classref-method
void **erase_button** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)**
Removes the button at index ``button_index`` in column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_autowrap_mode:
.. rst-class:: classref-method
:ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **get_autowrap_mode** **(** :ref:`int<class_int>` column **)** |const|
Returns the text autowrap mode in the given ``column``. By default it is :ref:`TextServer.AUTOWRAP_OFF<class_TextServer_constant_AUTOWRAP_OFF>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_button:
.. rst-class:: classref-method
:ref:`Texture2D<class_Texture2D>` **get_button** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |const|
Returns the :ref:`Texture2D<class_Texture2D>` of the button at index ``button_index`` in column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_button_by_id:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_button_by_id** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` id **)** |const|
Returns the button index if there is a button with ID ``id`` in column ``column``, otherwise returns -1.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_button_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_button_count** **(** :ref:`int<class_int>` column **)** |const|
Returns the number of buttons in column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_button_id:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_button_id** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |const|
Returns the ID for the button at index ``button_index`` in column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_button_tooltip_text:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_button_tooltip_text** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |const|
Returns the tooltip text for the button at index ``button_index`` in column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_cell_mode:
.. rst-class:: classref-method
:ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` **get_cell_mode** **(** :ref:`int<class_int>` column **)** |const|
Returns the column's cell mode.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_child:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_child** **(** :ref:`int<class_int>` index **)**
Returns a child item by its ``index`` (see :ref:`get_child_count<class_TreeItem_method_get_child_count>`). This method is often used for iterating all children of an item.
Negative indices access the children from the last one.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_child_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_child_count** **(** **)**
Returns the number of child items.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_children:
.. rst-class:: classref-method
:ref:`TreeItem[]<class_TreeItem>` **get_children** **(** **)**
Returns an array of references to the item's children.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_custom_bg_color:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **get_custom_bg_color** **(** :ref:`int<class_int>` column **)** |const|
Returns the custom background color of column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_custom_color:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **get_custom_color** **(** :ref:`int<class_int>` column **)** |const|
Returns the custom color of column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_custom_font:
.. rst-class:: classref-method
:ref:`Font<class_Font>` **get_custom_font** **(** :ref:`int<class_int>` column **)** |const|
Returns custom font used to draw text in the column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_custom_font_size:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_custom_font_size** **(** :ref:`int<class_int>` column **)** |const|
Returns custom font size used to draw text in the column ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_expand_right:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **get_expand_right** **(** :ref:`int<class_int>` column **)** |const|
Returns ``true`` if ``expand_right`` is set.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_first_child:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_first_child** **(** **)** |const|
Returns the TreeItem's first child.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_icon:
.. rst-class:: classref-method
:ref:`Texture2D<class_Texture2D>` **get_icon** **(** :ref:`int<class_int>` column **)** |const|
Returns the given column's icon :ref:`Texture2D<class_Texture2D>`. Error if no icon is set.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_icon_max_width:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_icon_max_width** **(** :ref:`int<class_int>` column **)** |const|
Returns the maximum allowed width of the icon in the given ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_icon_modulate:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **get_icon_modulate** **(** :ref:`int<class_int>` column **)** |const|
Returns the :ref:`Color<class_Color>` modulating the column's icon.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_icon_region:
.. rst-class:: classref-method
:ref:`Rect2<class_Rect2>` **get_icon_region** **(** :ref:`int<class_int>` column **)** |const|
Returns the icon :ref:`Texture2D<class_Texture2D>` region as :ref:`Rect2<class_Rect2>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_index:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_index** **(** **)**
Returns the node's order in the tree. For example, if called on the first child item the position is ``0``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_language:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_language** **(** :ref:`int<class_int>` column **)** |const|
Returns item's text language code.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_metadata:
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` **get_metadata** **(** :ref:`int<class_int>` column **)** |const|
Returns the metadata value that was set for the given column using :ref:`set_metadata<class_TreeItem_method_set_metadata>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_next:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_next** **(** **)** |const|
Returns the next sibling TreeItem in the tree or a null object if there is none.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_next_in_tree:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_next_in_tree** **(** :ref:`bool<class_bool>` wrap=false **)**
Returns the next TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none.
If ``wrap`` is enabled, the method will wrap around to the first element in the tree when called on the last element, otherwise it returns ``null``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_next_visible:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_next_visible** **(** :ref:`bool<class_bool>` wrap=false **)**
Returns the next visible TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none.
If ``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 ``null``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_parent:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_parent** **(** **)** |const|
Returns the parent TreeItem or a null object if there is none.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_prev:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_prev** **(** **)**
Returns the previous sibling TreeItem in the tree or a null object if there is none.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_prev_in_tree:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_prev_in_tree** **(** :ref:`bool<class_bool>` wrap=false **)**
Returns the previous TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none.
If ``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 ``null``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_prev_visible:
.. rst-class:: classref-method
:ref:`TreeItem<class_TreeItem>` **get_prev_visible** **(** :ref:`bool<class_bool>` wrap=false **)**
Returns the previous visible sibling TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none.
If ``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 ``null``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_range:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_range** **(** :ref:`int<class_int>` column **)** |const|
Returns the value of a :ref:`CELL_MODE_RANGE<class_TreeItem_constant_CELL_MODE_RANGE>` column.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_range_config:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_range_config** **(** :ref:`int<class_int>` column **)**
Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr".
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_structured_text_bidi_override:
.. rst-class:: classref-method
:ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **get_structured_text_bidi_override** **(** :ref:`int<class_int>` column **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_structured_text_bidi_override_options:
.. rst-class:: classref-method
:ref:`Array<class_Array>` **get_structured_text_bidi_override_options** **(** :ref:`int<class_int>` column **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_suffix:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_suffix** **(** :ref:`int<class_int>` column **)** |const|
Gets the suffix string shown after the column value.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_text:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_text** **(** :ref:`int<class_int>` column **)** |const|
Returns the given column's text.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_text_alignment:
.. rst-class:: classref-method
:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **get_text_alignment** **(** :ref:`int<class_int>` column **)** |const|
Returns the given column's text alignment.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_text_direction:
.. rst-class:: classref-method
:ref:`TextDirection<enum_Control_TextDirection>` **get_text_direction** **(** :ref:`int<class_int>` column **)** |const|
Returns item's text base writing direction.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_text_overrun_behavior:
.. rst-class:: classref-method
:ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **get_text_overrun_behavior** **(** :ref:`int<class_int>` column **)** |const|
Returns the clipping behavior when the text exceeds the item's bounding rectangle in the given ``column``. By default it is :ref:`TextServer.OVERRUN_TRIM_ELLIPSIS<class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_tooltip_text:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_tooltip_text** **(** :ref:`int<class_int>` column **)** |const|
Returns the given column's tooltip text.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_tree:
.. rst-class:: classref-method
:ref:`Tree<class_Tree>` **get_tree** **(** **)** |const|
Returns the :ref:`Tree<class_Tree>` that owns this TreeItem.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_any_collapsed:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_any_collapsed** **(** :ref:`bool<class_bool>` only_visible=false **)**
Returns ``true`` if this **TreeItem**, or any of its descendants, is collapsed.
If ``only_visible`` is ``true`` it ignores non-visible **TreeItem**\ s.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_button_disabled:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_button_disabled** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index **)** |const|
Returns ``true`` if the button at index ``button_index`` for the given ``column`` is disabled.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_checked:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_checked** **(** :ref:`int<class_int>` column **)** |const|
Returns ``true`` if the given ``column`` is checked.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_custom_set_as_button:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_custom_set_as_button** **(** :ref:`int<class_int>` column **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_edit_multiline:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_edit_multiline** **(** :ref:`int<class_int>` column **)** |const|
Returns ``true`` if the given ``column`` is multiline editable.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_editable:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_editable** **(** :ref:`int<class_int>` column **)**
Returns ``true`` if the given ``column`` is editable.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_indeterminate:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_indeterminate** **(** :ref:`int<class_int>` column **)** |const|
Returns ``true`` if the given ``column`` is indeterminate.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_selectable:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_selectable** **(** :ref:`int<class_int>` column **)** |const|
Returns ``true`` if the given ``column`` is selectable.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_is_selected:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_selected** **(** :ref:`int<class_int>` column **)**
Returns ``true`` if the given ``column`` is selected.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_move_after:
.. rst-class:: classref-method
void **move_after** **(** :ref:`TreeItem<class_TreeItem>` item **)**
Moves this TreeItem right after the given ``item``.
\ **Note:** You can't move to the root or move the root.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_move_before:
.. rst-class:: classref-method
void **move_before** **(** :ref:`TreeItem<class_TreeItem>` item **)**
Moves this TreeItem right before the given ``item``.
\ **Note:** You can't move to the root or move the root.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_propagate_check:
.. rst-class:: classref-method
void **propagate_check** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` emit_signal=true **)**
Propagates this item's checked status to its children and parents for the given ``column``. It is possible to process the items affected by this method call by connecting to :ref:`Tree.check_propagated_to_item<class_Tree_signal_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 ``emit_signal`` is ``false``, then :ref:`Tree.check_propagated_to_item<class_Tree_signal_check_propagated_to_item>` will not be emitted.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_remove_child:
.. rst-class:: classref-method
void **remove_child** **(** :ref:`TreeItem<class_TreeItem>` child **)**
Removes the given child **TreeItem** and all its children from the :ref:`Tree<class_Tree>`. Note that it doesn't free the item from memory, so it can be reused later (see :ref:`add_child<class_TreeItem_method_add_child>`). To completely remove a **TreeItem** use :ref:`Object.free<class_Object_method_free>`.
\ **Note:** If you want to move a child from one :ref:`Tree<class_Tree>` to another, then instead of removing and adding it manually you can use :ref:`move_before<class_TreeItem_method_move_before>` or :ref:`move_after<class_TreeItem_method_move_after>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_select:
.. rst-class:: classref-method
void **select** **(** :ref:`int<class_int>` column **)**
Selects the given ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_autowrap_mode:
.. rst-class:: classref-method
void **set_autowrap_mode** **(** :ref:`int<class_int>` column, :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` autowrap_mode **)**
Sets the autowrap mode in the given ``column``. If set to something other than :ref:`TextServer.AUTOWRAP_OFF<class_TextServer_constant_AUTOWRAP_OFF>`, the text gets wrapped inside the cell's bounding rectangle.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_button:
.. rst-class:: classref-method
void **set_button** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index, :ref:`Texture2D<class_Texture2D>` button **)**
Sets the given column's button :ref:`Texture2D<class_Texture2D>` at index ``button_index`` to ``button``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_button_color:
.. rst-class:: classref-method
void **set_button_color** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index, :ref:`Color<class_Color>` color **)**
Sets the given column's button color at index ``button_index`` to ``color``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_button_disabled:
.. rst-class:: classref-method
void **set_button_disabled** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index, :ref:`bool<class_bool>` disabled **)**
If ``true``, disables the button at index ``button_index`` in the given ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_button_tooltip_text:
.. rst-class:: classref-method
void **set_button_tooltip_text** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_index, :ref:`String<class_String>` tooltip **)**
Sets the tooltip text for the button at index ``button_index`` in the given ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_cell_mode:
.. rst-class:: classref-method
void **set_cell_mode** **(** :ref:`int<class_int>` column, :ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` mode **)**
Sets the given column's cell mode to ``mode``. See :ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` constants.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_checked:
.. rst-class:: classref-method
void **set_checked** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` checked **)**
If ``checked`` is ``true``, the given ``column`` is checked. Clears column's indeterminate status.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_collapsed_recursive:
.. rst-class:: classref-method
void **set_collapsed_recursive** **(** :ref:`bool<class_bool>` enable **)**
Collapses or uncollapses this **TreeItem** and all the descendants of this item.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_custom_as_button:
.. rst-class:: classref-method
void **set_custom_as_button** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_custom_bg_color:
.. rst-class:: classref-method
void **set_custom_bg_color** **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` just_outline=false **)**
Sets the given column's custom background color and whether to just use it as an outline.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_custom_color:
.. rst-class:: classref-method
void **set_custom_color** **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` color **)**
Sets the given column's custom color.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_custom_draw:
.. rst-class:: classref-method
void **set_custom_draw** **(** :ref:`int<class_int>` column, :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` callback **)**
Sets the given column's custom draw callback to ``callback`` method on ``object``.
The ``callback`` should accept two arguments: the **TreeItem** that is drawn and its position and size as a :ref:`Rect2<class_Rect2>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_custom_font:
.. rst-class:: classref-method
void **set_custom_font** **(** :ref:`int<class_int>` column, :ref:`Font<class_Font>` font **)**
Sets custom font used to draw text in the given ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_custom_font_size:
.. rst-class:: classref-method
void **set_custom_font_size** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` font_size **)**
Sets custom font size used to draw text in the given ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_edit_multiline:
.. rst-class:: classref-method
void **set_edit_multiline** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` multiline **)**
If ``multiline`` is ``true``, the given ``column`` is multiline editable.
\ **Note:** This option only affects the type of control (:ref:`LineEdit<class_LineEdit>` or :ref:`TextEdit<class_TextEdit>`) that appears when editing the column. You can set multiline values with :ref:`set_text<class_TreeItem_method_set_text>` even if the column is not multiline editable.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_editable:
.. rst-class:: classref-method
void **set_editable** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled **)**
If ``enabled`` is ``true``, the given ``column`` is editable.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_expand_right:
.. rst-class:: classref-method
void **set_expand_right** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)**
If ``enable`` is ``true``, the given ``column`` is expanded to the right.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_icon:
.. rst-class:: classref-method
void **set_icon** **(** :ref:`int<class_int>` column, :ref:`Texture2D<class_Texture2D>` texture **)**
Sets the given column's icon :ref:`Texture2D<class_Texture2D>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_icon_max_width:
.. rst-class:: classref-method
void **set_icon_max_width** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` width **)**
Sets the maximum allowed width of the icon in the given ``column``. This limit is applied on top of the default size of the icon and on top of :ref:`Tree.icon_max_width<class_Tree_theme_constant_icon_max_width>`. The height is adjusted according to the icon's ratio.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_icon_modulate:
.. rst-class:: classref-method
void **set_icon_modulate** **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` modulate **)**
Modulates the given column's icon with ``modulate``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_icon_region:
.. rst-class:: classref-method
void **set_icon_region** **(** :ref:`int<class_int>` column, :ref:`Rect2<class_Rect2>` region **)**
Sets the given column's icon's texture region.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_indeterminate:
.. rst-class:: classref-method
void **set_indeterminate** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` indeterminate **)**
If ``indeterminate`` is ``true``, the given ``column`` is marked indeterminate.
\ **Note:** If set ``true`` from ``false``, then column is cleared of checked status.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_language:
.. rst-class:: classref-method
void **set_language** **(** :ref:`int<class_int>` column, :ref:`String<class_String>` language **)**
Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_metadata:
.. rst-class:: classref-method
void **set_metadata** **(** :ref:`int<class_int>` column, :ref:`Variant<class_Variant>` meta **)**
Sets the metadata value for the given column, which can be retrieved later using :ref:`get_metadata<class_TreeItem_method_get_metadata>`. This can be used, for example, to store a reference to the original data.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_range:
.. rst-class:: classref-method
void **set_range** **(** :ref:`int<class_int>` column, :ref:`float<class_float>` value **)**
Sets the value of a :ref:`CELL_MODE_RANGE<class_TreeItem_constant_CELL_MODE_RANGE>` column.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_range_config:
.. rst-class:: classref-method
void **set_range_config** **(** :ref:`int<class_int>` column, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` step, :ref:`bool<class_bool>` expr=false **)**
Sets the range of accepted values for a column. The column must be in the :ref:`CELL_MODE_RANGE<class_TreeItem_constant_CELL_MODE_RANGE>` mode.
If ``expr`` is ``true``, the edit mode slider will use an exponential scale as with :ref:`Range.exp_edit<class_Range_property_exp_edit>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_selectable:
.. rst-class:: classref-method
void **set_selectable** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` selectable **)**
If ``selectable`` is ``true``, the given ``column`` is selectable.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_structured_text_bidi_override:
.. rst-class:: classref-method
void **set_structured_text_bidi_override** **(** :ref:`int<class_int>` column, :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_structured_text_bidi_override_options:
.. rst-class:: classref-method
void **set_structured_text_bidi_override_options** **(** :ref:`int<class_int>` column, :ref:`Array<class_Array>` args **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_suffix:
.. rst-class:: classref-method
void **set_suffix** **(** :ref:`int<class_int>` column, :ref:`String<class_String>` text **)**
Sets a string to be shown after a column's value (for example, a unit abbreviation).
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_text:
.. rst-class:: classref-method
void **set_text** **(** :ref:`int<class_int>` column, :ref:`String<class_String>` text **)**
Sets the given column's text value.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_text_alignment:
.. rst-class:: classref-method
void **set_text_alignment** **(** :ref:`int<class_int>` column, :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` text_alignment **)**
Sets the given column's text alignment. See :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` for possible values.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_text_direction:
.. rst-class:: classref-method
void **set_text_direction** **(** :ref:`int<class_int>` column, :ref:`TextDirection<enum_Control_TextDirection>` direction **)**
Sets item's text base writing direction.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_text_overrun_behavior:
.. rst-class:: classref-method
void **set_text_overrun_behavior** **(** :ref:`int<class_int>` column, :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` overrun_behavior **)**
Sets the clipping behavior when the text exceeds the item's bounding rectangle in the given ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_tooltip_text:
.. rst-class:: classref-method
void **set_tooltip_text** **(** :ref:`int<class_int>` column, :ref:`String<class_String>` tooltip **)**
Sets the given column's tooltip text.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_uncollapse_tree:
.. rst-class:: classref-method
void **uncollapse_tree** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
Reference in New Issue View Git Blame Copy Permalink