:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TreeItem.xml. .. _class_TreeItem: TreeItem ======== **Inherits:** :ref:`Object` An internal control for a single item inside :ref:`Tree`. .. rst-class:: classref-introduction-group Description ----------- A single item of a :ref:`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`, it is internal to the :ref:`Tree`. To create a **TreeItem**, use :ref:`Tree.create_item()` or :ref:`create_child()`. To remove a **TreeItem**, use :ref:`Object.free()`. \ **Note:** The ID values used for buttons are 32-bit, unlike :ref:`int` which is always 64-bit. They go from ``-2147483648`` to ``2147483647``. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------+-----------------------------------------------------------------------------+ | :ref:`bool` | :ref:`collapsed` | +-------------------------+-----------------------------------------------------------------------------+ | :ref:`int` | :ref:`custom_minimum_height` | +-------------------------+-----------------------------------------------------------------------------+ | :ref:`bool` | :ref:`disable_folding` | +-------------------------+-----------------------------------------------------------------------------+ | :ref:`bool` | :ref:`visible` | +-------------------------+-----------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_button`\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = "", description\: :ref:`String` = ""\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_child`\ (\ child\: :ref:`TreeItem`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`call_recursive`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_buttons`\ (\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_custom_bg_color`\ (\ column\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_custom_color`\ (\ column\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`create_child`\ (\ index\: :ref:`int` = -1\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`deselect`\ (\ column\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`erase_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AutoTranslateMode` | :ref:`get_auto_translate_mode`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`get_autowrap_mode`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_button_by_id`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_button_color`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_button_count`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_button_id`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeCellMode` | :ref:`get_cell_mode`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_child`\ (\ index\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_child_count`\ (\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`TreeItem`\] | :ref:`get_children`\ (\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_custom_bg_color`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_custom_color`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Callable` | :ref:`get_custom_draw_callback`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Font` | :ref:`get_custom_font`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_custom_font_size`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_description`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_expand_right`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_first_child`\ (\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_icon`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_icon_max_width`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_icon_modulate`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_icon_overlay`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_icon_region`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_index`\ (\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_language`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_metadata`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_next`\ (\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_next_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_next_visible`\ (\ wrap\: :ref:`bool` = false\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_parent`\ (\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_prev`\ (\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_prev_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_prev_visible`\ (\ wrap\: :ref:`bool` = false\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_range`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_range_config`\ (\ column\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StructuredTextParser` | :ref:`get_structured_text_bidi_override`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_structured_text_bidi_override_options`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_suffix`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_text`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`get_text_alignment`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TextDirection` | :ref:`get_text_direction`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`OverrunBehavior` | :ref:`get_text_overrun_behavior`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tooltip_text`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tree` | :ref:`get_tree`\ (\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_any_collapsed`\ (\ only_visible\: :ref:`bool` = false\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_checked`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_custom_set_as_button`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_edit_multiline`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editable`\ (\ column\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_indeterminate`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selectable`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected`\ (\ column\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`move_after`\ (\ item\: :ref:`TreeItem`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`move_before`\ (\ item\: :ref:`TreeItem`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`propagate_check`\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_child`\ (\ child\: :ref:`TreeItem`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`select`\ (\ column\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_auto_translate_mode`\ (\ column\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_autowrap_mode`\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_button_color`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_button_description`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, description\: :ref:`String`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_cell_mode`\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_checked`\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_collapsed_recursive`\ (\ enable\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_custom_as_button`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_custom_bg_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_custom_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_custom_draw`\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_custom_draw_callback`\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_custom_font`\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_custom_font_size`\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_description`\ (\ column\: :ref:`int`, description\: :ref:`String`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_edit_multiline`\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_editable`\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_expand_right`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_icon`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_icon_max_width`\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_icon_modulate`\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_icon_overlay`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_icon_region`\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_indeterminate`\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_language`\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_metadata`\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_range`\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_range_config`\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_selectable`\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_structured_text_bidi_override`\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_structured_text_bidi_override_options`\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_suffix`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_text`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_text_alignment`\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_text_direction`\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_text_overrun_behavior`\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_tooltip_text`\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`uncollapse_tree`\ (\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_TreeItem_TreeCellMode: .. rst-class:: classref-enumeration enum **TreeCellMode**: :ref:`🔗` .. _class_TreeItem_constant_CELL_MODE_STRING: .. rst-class:: classref-enumeration-constant :ref:`TreeCellMode` **CELL_MODE_STRING** = ``0`` Cell shows a string label, optionally with an icon. When editable, the text can be edited using a :ref:`LineEdit`, or a :ref:`TextEdit` popup if :ref:`set_edit_multiline()` is used. .. _class_TreeItem_constant_CELL_MODE_CHECK: .. rst-class:: classref-enumeration-constant :ref:`TreeCellMode` **CELL_MODE_CHECK** = ``1`` Cell shows a checkbox, optionally with text and an icon. The checkbox can be pressed, released, or indeterminate (via :ref:`set_indeterminate()`). The checkbox can't be clicked unless the cell is editable. .. _class_TreeItem_constant_CELL_MODE_RANGE: .. rst-class:: classref-enumeration-constant :ref:`TreeCellMode` **CELL_MODE_RANGE** = ``2`` Cell shows a numeric range. When editable, it can be edited using a range slider. Use :ref:`set_range()` to set the value and :ref:`set_range_config()` to configure the range. This cell can also be used in a text dropdown mode when you assign a text with :ref:`set_text()`. Separate options with a comma, e.g. ``"Option1,Option2,Option3"``. .. _class_TreeItem_constant_CELL_MODE_ICON: .. rst-class:: classref-enumeration-constant :ref:`TreeCellMode` **CELL_MODE_ICON** = ``3`` Cell shows an icon. It can't be edited nor display text. The icon is always centered within the cell. .. _class_TreeItem_constant_CELL_MODE_CUSTOM: .. rst-class:: classref-enumeration-constant :ref:`TreeCellMode` **CELL_MODE_CUSTOM** = ``4`` Cell shows as a clickable button. It will display an arrow similar to :ref:`OptionButton`, but doesn't feature a dropdown (for that you can use :ref:`CELL_MODE_RANGE`). Clicking the button emits the :ref:`Tree.item_edited` signal. The button is flat by default, you can use :ref:`set_custom_as_button()` to display it with a :ref:`StyleBox`. This mode also supports custom drawing using :ref:`set_custom_draw_callback()`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_TreeItem_property_collapsed: .. rst-class:: classref-property :ref:`bool` **collapsed** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_collapsed**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **custom_minimum_height** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_custom_minimum_height**\ (\ value\: :ref:`int`\ ) - :ref:`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` **disable_folding** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_disable_folding**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **visible** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`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**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = "", description\: :ref:`String` = ""\ ) :ref:`🔗` Adds a button with :ref:`Texture2D` ``button`` to the end of the cell at column ``column``. The ``id`` is used to identify the button in the according :ref:`Tree.button_clicked` signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count()` immediately before this method. Optionally, the button can be ``disabled`` and have a ``tooltip_text``. ``description`` is used as the button description for assistive apps. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_add_child: .. rst-class:: classref-method |void| **add_child**\ (\ child\: :ref:`TreeItem`\ ) :ref:`🔗` Adds a previously unparented **TreeItem** as a direct child of this one. The ``child`` item must not be a part of any :ref:`Tree` or parented to any **TreeItem**. See also :ref:`remove_child()`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_call_recursive: .. rst-class:: classref-method |void| **call_recursive**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| :ref:`🔗` 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_buttons: .. rst-class:: classref-method |void| **clear_buttons**\ (\ ) :ref:`🔗` Removes all buttons from all columns of this item. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_clear_custom_bg_color: .. rst-class:: classref-method |void| **clear_custom_bg_color**\ (\ column\: :ref:`int`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`\ ) :ref:`🔗` 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` **create_child**\ (\ index\: :ref:`int` = -1\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Deselects the given column. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_erase_button: .. rst-class:: classref-method |void| **erase_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) :ref:`🔗` Removes the button at index ``button_index`` in column ``column``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_auto_translate_mode: .. rst-class:: classref-method :ref:`AutoTranslateMode` **get_auto_translate_mode**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the column's auto translate mode. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_autowrap_mode: .. rst-class:: classref-method :ref:`AutowrapMode` **get_autowrap_mode**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the text autowrap mode in the given ``column``. By default it is :ref:`TextServer.AUTOWRAP_OFF`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_button: .. rst-class:: classref-method :ref:`Texture2D` **get_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`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` **get_button_by_id**\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| :ref:`🔗` 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_color: .. rst-class:: classref-method :ref:`Color` **get_button_color**\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the color of the button with ID ``id`` in column ``column``. If the specified button does not exist, returns :ref:`Color.BLACK`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_button_count: .. rst-class:: classref-method :ref:`int` **get_button_count**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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` **get_button_id**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| :ref:`🔗` 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` **get_button_tooltip_text**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| :ref:`🔗` 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` **get_cell_mode**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the column's cell mode. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_child: .. rst-class:: classref-method :ref:`TreeItem` **get_child**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns a child item by its ``index`` (see :ref:`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` **get_child_count**\ (\ ) :ref:`🔗` Returns the number of child items. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_children: .. rst-class:: classref-method :ref:`Array`\[:ref:`TreeItem`\] **get_children**\ (\ ) :ref:`🔗` 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` **get_custom_bg_color**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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` **get_custom_color**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom color of column ``column``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_custom_draw_callback: .. rst-class:: classref-method :ref:`Callable` **get_custom_draw_callback**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the custom callback of column ``column``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_custom_font: .. rst-class:: classref-method :ref:`Font` **get_custom_font**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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` **get_custom_font_size**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns custom font size used to draw text in the column ``column``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_description: .. rst-class:: classref-method :ref:`String` **get_description**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's description for assistive apps. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_expand_right: .. rst-class:: classref-method :ref:`bool` **get_expand_right**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if ``expand_right`` is set. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_first_child: .. rst-class:: classref-method :ref:`TreeItem` **get_first_child**\ (\ ) |const| :ref:`🔗` Returns the TreeItem's first child. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_icon: .. rst-class:: classref-method :ref:`Texture2D` **get_icon**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's icon :ref:`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` **get_icon_max_width**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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` **get_icon_modulate**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Color` modulating the column's icon. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_icon_overlay: .. rst-class:: classref-method :ref:`Texture2D` **get_icon_overlay**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's icon overlay :ref:`Texture2D`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_icon_region: .. rst-class:: classref-method :ref:`Rect2` **get_icon_region**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the icon :ref:`Texture2D` region as :ref:`Rect2`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_index: .. rst-class:: classref-method :ref:`int` **get_index**\ (\ ) :ref:`🔗` 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` **get_language**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns item's text language code. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_metadata: .. rst-class:: classref-method :ref:`Variant` **get_metadata**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the metadata value that was set for the given column using :ref:`set_metadata()`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_next: .. rst-class:: classref-method :ref:`TreeItem` **get_next**\ (\ ) |const| :ref:`🔗` 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` **get_next_in_tree**\ (\ wrap\: :ref:`bool` = false\ ) :ref:`🔗` 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` **get_next_visible**\ (\ wrap\: :ref:`bool` = false\ ) :ref:`🔗` 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` **get_parent**\ (\ ) |const| :ref:`🔗` 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` **get_prev**\ (\ ) :ref:`🔗` 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` **get_prev_in_tree**\ (\ wrap\: :ref:`bool` = false\ ) :ref:`🔗` 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` **get_prev_visible**\ (\ wrap\: :ref:`bool` = false\ ) :ref:`🔗` 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` **get_range**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the value of a :ref:`CELL_MODE_RANGE` column. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_range_config: .. rst-class:: classref-method :ref:`Dictionary` **get_range_config**\ (\ column\: :ref:`int`\ ) :ref:`🔗` 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` **get_structured_text_bidi_override**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the BiDi algorithm override set for this cell. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_structured_text_bidi_override_options: .. rst-class:: classref-method :ref:`Array` **get_structured_text_bidi_override_options**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the additional BiDi options set for this cell. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_suffix: .. rst-class:: classref-method :ref:`String` **get_suffix**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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` **get_text**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's text. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_text_alignment: .. rst-class:: classref-method :ref:`HorizontalAlignment` **get_text_alignment**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's text alignment. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_text_direction: .. rst-class:: classref-method :ref:`TextDirection` **get_text_direction**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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` **get_text_overrun_behavior**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_tooltip_text: .. rst-class:: classref-method :ref:`String` **get_tooltip_text**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns the given column's tooltip text. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_get_tree: .. rst-class:: classref-method :ref:`Tree` **get_tree**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Tree` that owns this TreeItem. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_is_any_collapsed: .. rst-class:: classref-method :ref:`bool` **is_any_collapsed**\ (\ only_visible\: :ref:`bool` = false\ ) :ref:`🔗` 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` **is_button_disabled**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| :ref:`🔗` 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` **is_checked**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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` **is_custom_set_as_button**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the cell was made into a button with :ref:`set_custom_as_button()`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_is_edit_multiline: .. rst-class:: classref-method :ref:`bool` **is_edit_multiline**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` 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` **is_editable**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the given ``column`` is editable. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_is_indeterminate: .. rst-class:: classref-method :ref:`bool` **is_indeterminate**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``column`` is indeterminate. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_is_selectable: .. rst-class:: classref-method :ref:`bool` **is_selectable**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the given ``column`` is selectable. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_is_selected: .. rst-class:: classref-method :ref:`bool` **is_selected**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Returns ``true`` if the given ``column`` is selected. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_is_visible_in_tree: .. rst-class:: classref-method :ref:`bool` **is_visible_in_tree**\ (\ ) |const| :ref:`🔗` Returns ``true`` if :ref:`visible` is ``true`` and all its ancestors are also visible. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_move_after: .. rst-class:: classref-method |void| **move_after**\ (\ item\: :ref:`TreeItem`\ ) :ref:`🔗` 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**\ (\ item\: :ref:`TreeItem`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) :ref:`🔗` 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`. 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` will not be emitted. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_remove_child: .. rst-class:: classref-method |void| **remove_child**\ (\ child\: :ref:`TreeItem`\ ) :ref:`🔗` Removes the given child **TreeItem** and all its children from the :ref:`Tree`. Note that it doesn't free the item from memory, so it can be reused later (see :ref:`add_child()`). To completely remove a **TreeItem** use :ref:`Object.free()`. \ **Note:** If you want to move a child from one :ref:`Tree` to another, then instead of removing and adding it manually you can use :ref:`move_before()` or :ref:`move_after()`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_select: .. rst-class:: classref-method |void| **select**\ (\ column\: :ref:`int`\ ) :ref:`🔗` Selects the given ``column``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_auto_translate_mode: .. rst-class:: classref-method |void| **set_auto_translate_mode**\ (\ column\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) :ref:`🔗` Sets the given column's auto translate mode to ``mode``. All columns use :ref:`Node.AUTO_TRANSLATE_MODE_INHERIT` by default, which uses the same auto translate mode as the :ref:`Tree` itself. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_autowrap_mode: .. rst-class:: classref-method |void| **set_autowrap_mode**\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) :ref:`🔗` Sets the autowrap mode in the given ``column``. If set to something other than :ref:`TextServer.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**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the given column's button :ref:`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**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the given column's button color at index ``button_index`` to ``color``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_button_description: .. rst-class:: classref-method |void| **set_button_description**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, description\: :ref:`String`\ ) :ref:`🔗` Sets the given column's button description at index ``button_index`` for assistive apps. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_button_disabled: .. rst-class:: classref-method |void| **set_button_disabled**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) :ref:`🔗` Sets the given column's cell mode to ``mode``. This determines how the cell is displayed and edited. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_checked: .. rst-class:: classref-method |void| **set_checked**\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) :ref:`🔗` 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**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` Makes a cell with :ref:`CELL_MODE_CUSTOM` display as a non-flat button with a :ref:`StyleBox`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_custom_bg_color: .. rst-class:: classref-method |void| **set_custom_bg_color**\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) :ref:`🔗` **Deprecated:** Use :ref:`set_custom_draw_callback()` instead. Sets the given column's custom draw callback to the ``callback`` method on ``object``. The method named ``callback`` should accept two arguments: the **TreeItem** that is drawn and its position and size as a :ref:`Rect2`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_custom_draw_callback: .. rst-class:: classref-method |void| **set_custom_draw_callback**\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sets the given column's custom draw callback. Use an empty :ref:`Callable` (``Callable()``) to clear the custom callback. The cell has to be in :ref:`CELL_MODE_CUSTOM` to use this feature. The ``callback`` should accept two arguments: the **TreeItem** that is drawn and its position and size as a :ref:`Rect2`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_custom_font: .. rst-class:: classref-method |void| **set_custom_font**\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) :ref:`🔗` Sets custom font size used to draw text in the given ``column``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_description: .. rst-class:: classref-method |void| **set_description**\ (\ column\: :ref:`int`, description\: :ref:`String`\ ) :ref:`🔗` Sets the given column's description for assistive apps. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_edit_multiline: .. rst-class:: classref-method |void| **set_edit_multiline**\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) :ref:`🔗` If ``multiline`` is ``true``, the given ``column`` is multiline editable. \ **Note:** This option only affects the type of control (:ref:`LineEdit` or :ref:`TextEdit`) that appears when editing the column. You can set multiline values with :ref:`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**\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the given cell's icon :ref:`Texture2D`. If the cell is in :ref:`CELL_MODE_ICON` mode, the icon is displayed in the center of the cell. Otherwise, the icon is displayed before the cell's text. :ref:`CELL_MODE_RANGE` does not display an icon. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_icon_max_width: .. rst-class:: classref-method |void| **set_icon_max_width**\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) :ref:`🔗` 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`. 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**\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) :ref:`🔗` Modulates the given column's icon with ``modulate``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_icon_overlay: .. rst-class:: classref-method |void| **set_icon_overlay**\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets the given cell's icon overlay :ref:`Texture2D`. The cell has to be in :ref:`CELL_MODE_ICON` mode, and icon has to be set. Overlay is drawn on top of icon, in the bottom left corner. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_icon_region: .. rst-class:: classref-method |void| **set_icon_region**\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata value for the given column, which can be retrieved later using :ref:`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**\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of a :ref:`CELL_MODE_RANGE` column. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_range_config: .. rst-class:: classref-method |void| **set_range_config**\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) :ref:`🔗` Sets the range of accepted values for a column. The column must be in the :ref:`CELL_MODE_RANGE` mode. If ``expr`` is ``true``, the edit mode slider will use an exponential scale as with :ref:`Range.exp_edit`. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_selectable: .. rst-class:: classref-method |void| **set_selectable**\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) :ref:`🔗` Set BiDi algorithm override for the structured text. Has effect for cells that display text. .. 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**\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) :ref:`🔗` Set additional options for BiDi override. Has effect for cells that display text. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_suffix: .. rst-class:: classref-method |void| **set_suffix**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) :ref:`🔗` Sets the given column's text alignment to ``text_alignment``. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_set_text_direction: .. rst-class:: classref-method |void| **set_text_direction**\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) :ref:`🔗` 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**\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets the given column's tooltip text. .. rst-class:: classref-item-separator ---- .. _class_TreeItem_method_uncollapse_tree: .. rst-class:: classref-method |void| **uncollapse_tree**\ (\ ) :ref:`🔗` Uncollapses all **TreeItem**\ s necessary to reveal this **TreeItem**, i.e. all ancestor **TreeItem**\ s. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |void| replace:: :abbr:`void (No return value.)`