.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_TreeItem: TreeItem ======== **Inherits:** :ref:`Object` **Category:** Core Brief Description ----------------- Member Functions ---------------- +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`deselect` **(** :ref:`int` column **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_children` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`get_metadata` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_next` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_parent` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_prev` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_collapsed` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_to_bottom` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_to_top` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`remove_child` **(** :ref:`Object` child **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` column **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- - **CELL_MODE_STRING** = **0** - **CELL_MODE_CHECK** = **1** - **CELL_MODE_RANGE** = **2** - **CELL_MODE_RANGE_EXPRESSION** = **3** - **CELL_MODE_ICON** = **4** - **CELL_MODE_CUSTOM** = **5** Member Function Description --------------------------- .. _class_TreeItem_add_button: - void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** .. _class_TreeItem_clear_custom_bg_color: - void **clear_custom_bg_color** **(** :ref:`int` column **)** .. _class_TreeItem_clear_custom_color: - void **clear_custom_color** **(** :ref:`int` column **)** .. _class_TreeItem_deselect: - void **deselect** **(** :ref:`int` column **)** .. _class_TreeItem_erase_button: - void **erase_button** **(** :ref:`int` column, :ref:`int` button_idx **)** .. _class_TreeItem_get_button: - :ref:`Texture` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** const .. _class_TreeItem_get_button_count: - :ref:`int` **get_button_count** **(** :ref:`int` column **)** const .. _class_TreeItem_get_cell_mode: - :ref:`int` **get_cell_mode** **(** :ref:`int` column **)** const .. _class_TreeItem_get_children: - :ref:`TreeItem` **get_children** **(** **)** .. _class_TreeItem_get_custom_bg_color: - :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const .. _class_TreeItem_get_expand_right: - :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const .. _class_TreeItem_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const .. _class_TreeItem_get_icon_max_width: - :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** const .. _class_TreeItem_get_icon_region: - :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const .. _class_TreeItem_get_metadata: - :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const .. _class_TreeItem_get_next: - :ref:`TreeItem` **get_next** **(** **)** .. _class_TreeItem_get_next_visible: - :ref:`TreeItem` **get_next_visible** **(** **)** .. _class_TreeItem_get_parent: - :ref:`TreeItem` **get_parent** **(** **)** .. _class_TreeItem_get_prev: - :ref:`TreeItem` **get_prev** **(** **)** .. _class_TreeItem_get_prev_visible: - :ref:`TreeItem` **get_prev_visible** **(** **)** .. _class_TreeItem_get_range: - :ref:`float` **get_range** **(** :ref:`int` column **)** const .. _class_TreeItem_get_range_config: - :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** .. _class_TreeItem_get_text: - :ref:`String` **get_text** **(** :ref:`int` column **)** const .. _class_TreeItem_get_text_align: - :ref:`int` **get_text_align** **(** :ref:`int` column **)** const .. _class_TreeItem_get_tooltip: - :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const .. _class_TreeItem_is_button_disabled: - :ref:`bool` **is_button_disabled** **(** :ref:`int` column, :ref:`int` button_idx **)** const .. _class_TreeItem_is_checked: - :ref:`bool` **is_checked** **(** :ref:`int` column **)** const .. _class_TreeItem_is_collapsed: - :ref:`bool` **is_collapsed** **(** **)** .. _class_TreeItem_is_custom_set_as_button: - :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const .. _class_TreeItem_is_editable: - :ref:`bool` **is_editable** **(** :ref:`int` column **)** .. _class_TreeItem_is_folding_disabled: - :ref:`bool` **is_folding_disabled** **(** **)** const .. _class_TreeItem_is_selectable: - :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const .. _class_TreeItem_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` column **)** .. _class_TreeItem_move_to_bottom: - void **move_to_bottom** **(** **)** .. _class_TreeItem_move_to_top: - void **move_to_top** **(** **)** .. _class_TreeItem_remove_child: - void **remove_child** **(** :ref:`Object` child **)** .. _class_TreeItem_select: - void **select** **(** :ref:`int` column **)** .. _class_TreeItem_set_button: - void **set_button** **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** .. _class_TreeItem_set_cell_mode: - void **set_cell_mode** **(** :ref:`int` column, :ref:`int` mode **)** .. _class_TreeItem_set_checked: - void **set_checked** **(** :ref:`int` column, :ref:`bool` checked **)** .. _class_TreeItem_set_collapsed: - void **set_collapsed** **(** :ref:`bool` enable **)** .. _class_TreeItem_set_custom_as_button: - void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** .. _class_TreeItem_set_custom_bg_color: - void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=null **)** .. _class_TreeItem_set_custom_color: - void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** .. _class_TreeItem_set_custom_draw: - void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** .. _class_TreeItem_set_disable_folding: - void **set_disable_folding** **(** :ref:`bool` disable **)** .. _class_TreeItem_set_editable: - void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** .. _class_TreeItem_set_expand_right: - void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** .. _class_TreeItem_set_icon: - void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** .. _class_TreeItem_set_icon_max_width: - void **set_icon_max_width** **(** :ref:`int` column, :ref:`int` width **)** .. _class_TreeItem_set_icon_region: - void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** .. _class_TreeItem_set_metadata: - void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** .. _class_TreeItem_set_range: - void **set_range** **(** :ref:`int` column, :ref:`float` value **)** .. _class_TreeItem_set_range_config: - void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=null **)** .. _class_TreeItem_set_selectable: - void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** .. _class_TreeItem_set_text: - void **set_text** **(** :ref:`int` column, :ref:`String` text **)** .. _class_TreeItem_set_text_align: - void **set_text_align** **(** :ref:`int` column, :ref:`int` text_align **)** .. _class_TreeItem_set_tooltip: - void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)**