godot-docs/classes/class_treeitem.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_TreeItem:

TreeItem
========

**Inherits:** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Functions
----------------

+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`add_button<class_TreeItem_add_button>`  **(** :ref:`int<class_int>` column, :ref:`Texture<class_texture>` button, :ref:`int<class_int>` button_idx=-1, :ref:`bool<class_bool>` disabled=false, :ref:`String<class_string>` tooltip=""  **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`clear_custom_bg_color<class_TreeItem_clear_custom_bg_color>`  **(** :ref:`int<class_int>` column  **)**                                                                                                                                      |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`clear_custom_color<class_TreeItem_clear_custom_color>`  **(** :ref:`int<class_int>` column  **)**                                                                                                                                            |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`deselect<class_TreeItem_deselect>`  **(** :ref:`int<class_int>` column  **)**                                                                                                                                                                |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`erase_button<class_TreeItem_erase_button>`  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx  **)**                                                                                                                      |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`        | :ref:`get_button<class_TreeItem_get_button>`  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx  **)** const                                                                                                                    |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                | :ref:`get_button_count<class_TreeItem_get_button_count>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                          |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                | :ref:`get_cell_mode<class_TreeItem_get_cell_mode>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                                |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>`      | :ref:`get_children<class_TreeItem_get_children>`  **(** **)**                                                                                                                                                                                      |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`            | :ref:`get_custom_bg_color<class_TreeItem_get_custom_bg_color>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                    |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`        | :ref:`get_icon<class_TreeItem_get_icon>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                                          |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                | :ref:`get_icon_max_width<class_TreeItem_get_icon_max_width>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                      |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>`            | :ref:`get_icon_region<class_TreeItem_get_icon_region>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                            |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`get_metadata<class_TreeItem_get_metadata>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                                  |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>`      | :ref:`get_next<class_TreeItem_get_next>`  **(** **)**                                                                                                                                                                                              |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>`      | :ref:`get_next_visible<class_TreeItem_get_next_visible>`  **(** **)**                                                                                                                                                                              |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>`      | :ref:`get_parent<class_TreeItem_get_parent>`  **(** **)**                                                                                                                                                                                          |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>`      | :ref:`get_prev<class_TreeItem_get_prev>`  **(** **)**                                                                                                                                                                                              |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>`      | :ref:`get_prev_visible<class_TreeItem_get_prev_visible>`  **(** **)**                                                                                                                                                                              |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`            | :ref:`get_range<class_TreeItem_get_range>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                                        |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>`  | :ref:`get_range_config<class_TreeItem_get_range_config>`  **(** :ref:`int<class_int>` column  **)**                                                                                                                                                |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`          | :ref:`get_text<class_TreeItem_get_text>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                                          |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`          | :ref:`get_tooltip<class_TreeItem_get_tooltip>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                                    |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`              | :ref:`is_button_disabled<class_TreeItem_is_button_disabled>`  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx  **)** const                                                                                                    |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`              | :ref:`is_checked<class_TreeItem_is_checked>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                                      |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`              | :ref:`is_collapsed<class_TreeItem_is_collapsed>`  **(** **)**                                                                                                                                                                                      |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`              | :ref:`is_editable<class_TreeItem_is_editable>`  **(** :ref:`int<class_int>` column  **)**                                                                                                                                                          |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`              | :ref:`is_selectable<class_TreeItem_is_selectable>`  **(** :ref:`int<class_int>` column  **)** const                                                                                                                                                |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`              | :ref:`is_selected<class_TreeItem_is_selected>`  **(** :ref:`int<class_int>` column  **)**                                                                                                                                                          |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`move_to_bottom<class_TreeItem_move_to_bottom>`  **(** **)**                                                                                                                                                                                  |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`move_to_top<class_TreeItem_move_to_top>`  **(** **)**                                                                                                                                                                                        |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>`      | :ref:`remove_child<class_TreeItem_remove_child>`  **(** :ref:`Object<class_object>` child  **)**                                                                                                                                                   |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`select<class_TreeItem_select>`  **(** :ref:`int<class_int>` column  **)**                                                                                                                                                                    |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_button<class_TreeItem_set_button>`  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` button  **)**                                                                                    |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_cell_mode<class_TreeItem_set_cell_mode>`  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` mode  **)**                                                                                                                          |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_checked<class_TreeItem_set_checked>`  **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` checked  **)**                                                                                                                         |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_collapsed<class_TreeItem_set_collapsed>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                                                    |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_custom_bg_color<class_TreeItem_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_set_custom_color>`  **(** :ref:`int<class_int>` column, :ref:`Color<class_color>` color  **)**                                                                                                               |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_custom_draw<class_TreeItem_set_custom_draw>`  **(** :ref:`int<class_int>` column, :ref:`Object<class_object>` object, :ref:`String<class_string>` callback  **)**                                                                        |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_editable<class_TreeItem_set_editable>`  **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled  **)**                                                                                                                       |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_icon<class_TreeItem_set_icon>`  **(** :ref:`int<class_int>` column, :ref:`Texture<class_texture>` texture  **)**                                                                                                                         |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_icon_max_width<class_TreeItem_set_icon_max_width>`  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` width  **)**                                                                                                               |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_icon_region<class_TreeItem_set_icon_region>`  **(** :ref:`int<class_int>` column, :ref:`Rect2<class_rect2>` region  **)**                                                                                                                |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_metadata<class_TreeItem_set_metadata>`  **(** :ref:`int<class_int>` column, :ref:`Variant<class_variant>` meta  **)**                                                                                                                    |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_range<class_TreeItem_set_range>`  **(** :ref:`int<class_int>` column, :ref:`float<class_float>` value  **)**                                                                                                                             |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_range_config<class_TreeItem_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_set_selectable>`  **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` selectable  **)**                                                                                                                |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_text<class_TreeItem_set_text>`  **(** :ref:`int<class_int>` column, :ref:`String<class_string>` text  **)**                                                                                                                              |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                 | :ref:`set_tooltip<class_TreeItem_set_tooltip>`  **(** :ref:`int<class_int>` column, :ref:`String<class_string>` tooltip  **)**                                                                                                                     |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Numeric Constants
-----------------

- **CELL_MODE_STRING** = **0**
- **CELL_MODE_CHECK** = **1**
- **CELL_MODE_RANGE** = **2**
- **CELL_MODE_RANGE_EXPRESSION** = **3**
- **CELL_MODE_ICON** = **4**
- **CELL_MODE_CUSTOM** = **5**

Member Function Description
---------------------------

.. _class_TreeItem_add_button:

- void  **add_button**  **(** :ref:`int<class_int>` column, :ref:`Texture<class_texture>` button, :ref:`int<class_int>` button_idx=-1, :ref:`bool<class_bool>` disabled=false, :ref:`String<class_string>` tooltip=""  **)**

.. _class_TreeItem_clear_custom_bg_color:

- void  **clear_custom_bg_color**  **(** :ref:`int<class_int>` column  **)**

.. _class_TreeItem_clear_custom_color:

- void  **clear_custom_color**  **(** :ref:`int<class_int>` column  **)**

.. _class_TreeItem_deselect:

- void  **deselect**  **(** :ref:`int<class_int>` column  **)**

.. _class_TreeItem_erase_button:

- void  **erase_button**  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx  **)**

.. _class_TreeItem_get_button:

- :ref:`Texture<class_texture>`  **get_button**  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx  **)** const

.. _class_TreeItem_get_button_count:

- :ref:`int<class_int>`  **get_button_count**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_cell_mode:

- :ref:`int<class_int>`  **get_cell_mode**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_children:

- :ref:`TreeItem<class_treeitem>`  **get_children**  **(** **)**

.. _class_TreeItem_get_custom_bg_color:

- :ref:`Color<class_color>`  **get_custom_bg_color**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_icon:

- :ref:`Texture<class_texture>`  **get_icon**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_icon_max_width:

- :ref:`int<class_int>`  **get_icon_max_width**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_icon_region:

- :ref:`Rect2<class_rect2>`  **get_icon_region**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_metadata:

- void  **get_metadata**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_next:

- :ref:`TreeItem<class_treeitem>`  **get_next**  **(** **)**

.. _class_TreeItem_get_next_visible:

- :ref:`TreeItem<class_treeitem>`  **get_next_visible**  **(** **)**

.. _class_TreeItem_get_parent:

- :ref:`TreeItem<class_treeitem>`  **get_parent**  **(** **)**

.. _class_TreeItem_get_prev:

- :ref:`TreeItem<class_treeitem>`  **get_prev**  **(** **)**

.. _class_TreeItem_get_prev_visible:

- :ref:`TreeItem<class_treeitem>`  **get_prev_visible**  **(** **)**

.. _class_TreeItem_get_range:

- :ref:`float<class_float>`  **get_range**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_range_config:

- :ref:`Dictionary<class_dictionary>`  **get_range_config**  **(** :ref:`int<class_int>` column  **)**

.. _class_TreeItem_get_text:

- :ref:`String<class_string>`  **get_text**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_get_tooltip:

- :ref:`String<class_string>`  **get_tooltip**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_is_button_disabled:

- :ref:`bool<class_bool>`  **is_button_disabled**  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx  **)** const

.. _class_TreeItem_is_checked:

- :ref:`bool<class_bool>`  **is_checked**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_is_collapsed:

- :ref:`bool<class_bool>`  **is_collapsed**  **(** **)**

.. _class_TreeItem_is_editable:

- :ref:`bool<class_bool>`  **is_editable**  **(** :ref:`int<class_int>` column  **)**

.. _class_TreeItem_is_selectable:

- :ref:`bool<class_bool>`  **is_selectable**  **(** :ref:`int<class_int>` column  **)** const

.. _class_TreeItem_is_selected:

- :ref:`bool<class_bool>`  **is_selected**  **(** :ref:`int<class_int>` column  **)**

.. _class_TreeItem_move_to_bottom:

- void  **move_to_bottom**  **(** **)**

.. _class_TreeItem_move_to_top:

- void  **move_to_top**  **(** **)**

.. _class_TreeItem_remove_child:

- :ref:`TreeItem<class_treeitem>`  **remove_child**  **(** :ref:`Object<class_object>` child  **)**

.. _class_TreeItem_select:

- void  **select**  **(** :ref:`int<class_int>` column  **)**

.. _class_TreeItem_set_button:

- void  **set_button**  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` button  **)**

.. _class_TreeItem_set_cell_mode:

- void  **set_cell_mode**  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` mode  **)**

.. _class_TreeItem_set_checked:

- void  **set_checked**  **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` checked  **)**

.. _class_TreeItem_set_collapsed:

- void  **set_collapsed**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_TreeItem_set_custom_bg_color:

- void  **set_custom_bg_color**  **(** :ref:`int<class_int>` column, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` just_outline=false  **)**

.. _class_TreeItem_set_custom_color:

- void  **set_custom_color**  **(** :ref:`int<class_int>` column, :ref:`Color<class_color>` color  **)**

.. _class_TreeItem_set_custom_draw:

- void  **set_custom_draw**  **(** :ref:`int<class_int>` column, :ref:`Object<class_object>` object, :ref:`String<class_string>` callback  **)**

.. _class_TreeItem_set_editable:

- void  **set_editable**  **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled  **)**

.. _class_TreeItem_set_icon:

- void  **set_icon**  **(** :ref:`int<class_int>` column, :ref:`Texture<class_texture>` texture  **)**

.. _class_TreeItem_set_icon_max_width:

- void  **set_icon_max_width**  **(** :ref:`int<class_int>` column, :ref:`int<class_int>` width  **)**

.. _class_TreeItem_set_icon_region:

- void  **set_icon_region**  **(** :ref:`int<class_int>` column, :ref:`Rect2<class_rect2>` region  **)**

.. _class_TreeItem_set_metadata:

- void  **set_metadata**  **(** :ref:`int<class_int>` column, :ref:`Variant<class_variant>` meta  **)**

.. _class_TreeItem_set_range:

- void  **set_range**  **(** :ref:`int<class_int>` column, :ref:`float<class_float>` value  **)**

.. _class_TreeItem_set_range_config:

- 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  **)**

.. _class_TreeItem_set_selectable:

- void  **set_selectable**  **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` selectable  **)**

.. _class_TreeItem_set_text:

- void  **set_text**  **(** :ref:`int<class_int>` column, :ref:`String<class_string>` text  **)**

.. _class_TreeItem_set_tooltip:

- void  **set_tooltip**  **(** :ref:`int<class_int>` column, :ref:`String<class_string>` tooltip  **)**