godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
fa00c829f02c31f07aa983c81a2811f4e577b834
godot-docs/classes/class_treeitem.rst
Rémi Verschelde fa00c829f0 Add inheritance path 
Also fix parsing of [method (Class.)name]
2016-02-08 18:31:35 +01:00

327 lines
33 KiB
ReStructuredText
Raw Blame History

.. _class_TreeItem:
TreeItem
========
**Inherits:** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_mode<class_TreeItem_set_cell_mode>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` mode **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_mode<class_TreeItem_get_cell_mode>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_checked<class_TreeItem_set_checked>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` checked **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_checked<class_TreeItem_is_checked>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_TreeItem_set_text>` **(** :ref:`int<class_int>` column, :ref:`String<class_string>` text **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_text<class_TreeItem_get_text>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon<class_TreeItem_set_icon>` **(** :ref:`int<class_int>` column, :ref:`Texture<class_texture>` texture **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_icon<class_TreeItem_get_icon>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon_region<class_TreeItem_set_icon_region>` **(** :ref:`int<class_int>` column, :ref:`Rect2<class_rect2>` region **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_icon_region<class_TreeItem_get_icon_region>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon_max_width<class_TreeItem_set_icon_max_width>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` width **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_icon_max_width<class_TreeItem_get_icon_max_width>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_range<class_TreeItem_set_range>` **(** :ref:`int<class_int>` column, :ref:`float<class_float>` value **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_range<class_TreeItem_get_range>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_range_config<class_TreeItem_set_range_config>` **(** :ref:`int<class_int>` column, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` step, :ref:`bool<class_bool>` expr=false **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_range_config<class_TreeItem_get_range_config>` **(** :ref:`int<class_int>` column **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_metadata<class_TreeItem_set_metadata>` **(** :ref:`int<class_int>` column, var meta **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_metadata<class_TreeItem_get_metadata>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_draw<class_TreeItem_set_custom_draw>` **(** :ref:`int<class_int>` column, :ref:`Object<class_object>` object, :ref:`String<class_string>` callback **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collapsed<class_TreeItem_set_collapsed>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_collapsed<class_TreeItem_is_collapsed>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>` | :ref:`get_next<class_TreeItem_get_next>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>` | :ref:`get_prev<class_TreeItem_get_prev>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>` | :ref:`get_parent<class_TreeItem_get_parent>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>` | :ref:`get_children<class_TreeItem_get_children>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>` | :ref:`get_next_visible<class_TreeItem_get_next_visible>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>` | :ref:`get_prev_visible<class_TreeItem_get_prev_visible>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>` | :ref:`remove_child<class_TreeItem_remove_child>` **(** :ref:`Object<class_object>` child **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selectable<class_TreeItem_set_selectable>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` selectable **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selectable<class_TreeItem_is_selectable>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selected<class_TreeItem_is_selected>` **(** :ref:`int<class_int>` column **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select<class_TreeItem_select>` **(** :ref:`int<class_int>` column **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`deselect<class_TreeItem_deselect>` **(** :ref:`int<class_int>` column **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_editable<class_TreeItem_set_editable>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editable<class_TreeItem_is_editable>` **(** :ref:`int<class_int>` column **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_color<class_TreeItem_set_custom_color>` **(** :ref:`int<class_int>` column, :ref:`Color<class_color>` color **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_custom_color<class_TreeItem_clear_custom_color>` **(** :ref:`int<class_int>` column **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_bg_color<class_TreeItem_set_custom_bg_color>` **(** :ref:`int<class_int>` column, :ref:`Color<class_color>` color **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_custom_bg_color<class_TreeItem_clear_custom_bg_color>` **(** :ref:`int<class_int>` column **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_custom_bg_color<class_TreeItem_get_custom_bg_color>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_button<class_TreeItem_add_button>` **(** :ref:`int<class_int>` column, :ref:`Texture<class_texture>` button, :ref:`int<class_int>` button_idx=-1, :ref:`bool<class_bool>` disabled=false **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_count<class_TreeItem_get_button_count>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_button<class_TreeItem_get_button>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_button<class_TreeItem_erase_button>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_button_disabled<class_TreeItem_is_button_disabled>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tooltip<class_TreeItem_set_tooltip>` **(** :ref:`int<class_int>` column, :ref:`String<class_string>` tooltip **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_tooltip<class_TreeItem_get_tooltip>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_to_top<class_TreeItem_move_to_top>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_to_bottom<class_TreeItem_move_to_bottom>` **(** **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **CELL_MODE_STRING** = **0**
- **CELL_MODE_CHECK** = **1**
- **CELL_MODE_RANGE** = **2**
- **CELL_MODE_ICON** = **3**
- **CELL_MODE_CUSTOM** = **4**
Member Function Description
---------------------------
.. _class_TreeItem_set_cell_mode:
- void **set_cell_mode** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` mode **)**
.. _class_TreeItem_get_cell_mode:
- :ref:`int<class_int>` **get_cell_mode** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_set_checked:
- void **set_checked** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` checked **)**
.. _class_TreeItem_is_checked:
- :ref:`bool<class_bool>` **is_checked** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_set_text:
- void **set_text** **(** :ref:`int<class_int>` column, :ref:`String<class_string>` text **)**
.. _class_TreeItem_get_text:
- :ref:`String<class_string>` **get_text** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_set_icon:
- void **set_icon** **(** :ref:`int<class_int>` column, :ref:`Texture<class_texture>` texture **)**
.. _class_TreeItem_get_icon:
- :ref:`Texture<class_texture>` **get_icon** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_set_icon_region:
- void **set_icon_region** **(** :ref:`int<class_int>` column, :ref:`Rect2<class_rect2>` region **)**
.. _class_TreeItem_get_icon_region:
- :ref:`Rect2<class_rect2>` **get_icon_region** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_set_icon_max_width:
- void **set_icon_max_width** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` width **)**
.. _class_TreeItem_get_icon_max_width:
- :ref:`int<class_int>` **get_icon_max_width** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_set_range:
- void **set_range** **(** :ref:`int<class_int>` column, :ref:`float<class_float>` value **)**
.. _class_TreeItem_get_range:
- :ref:`float<class_float>` **get_range** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_set_range_config:
- void **set_range_config** **(** :ref:`int<class_int>` column, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` step, :ref:`bool<class_bool>` expr=false **)**
.. _class_TreeItem_get_range_config:
- :ref:`Dictionary<class_dictionary>` **get_range_config** **(** :ref:`int<class_int>` column **)**
.. _class_TreeItem_set_metadata:
- void **set_metadata** **(** :ref:`int<class_int>` column, var meta **)**
.. _class_TreeItem_get_metadata:
- void **get_metadata** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_set_custom_draw:
- void **set_custom_draw** **(** :ref:`int<class_int>` column, :ref:`Object<class_object>` object, :ref:`String<class_string>` callback **)**
.. _class_TreeItem_set_collapsed:
- void **set_collapsed** **(** :ref:`bool<class_bool>` enable **)**
.. _class_TreeItem_is_collapsed:
- :ref:`bool<class_bool>` **is_collapsed** **(** **)**
.. _class_TreeItem_get_next:
- :ref:`TreeItem<class_treeitem>` **get_next** **(** **)**
.. _class_TreeItem_get_prev:
- :ref:`TreeItem<class_treeitem>` **get_prev** **(** **)**
.. _class_TreeItem_get_parent:
- :ref:`TreeItem<class_treeitem>` **get_parent** **(** **)**
.. _class_TreeItem_get_children:
- :ref:`TreeItem<class_treeitem>` **get_children** **(** **)**
.. _class_TreeItem_get_next_visible:
- :ref:`TreeItem<class_treeitem>` **get_next_visible** **(** **)**
.. _class_TreeItem_get_prev_visible:
- :ref:`TreeItem<class_treeitem>` **get_prev_visible** **(** **)**
.. _class_TreeItem_remove_child:
- :ref:`TreeItem<class_treeitem>` **remove_child** **(** :ref:`Object<class_object>` child **)**
.. _class_TreeItem_set_selectable:
- void **set_selectable** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` selectable **)**
.. _class_TreeItem_is_selectable:
- :ref:`bool<class_bool>` **is_selectable** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_is_selected:
- :ref:`bool<class_bool>` **is_selected** **(** :ref:`int<class_int>` column **)**
.. _class_TreeItem_select:
- void **select** **(** :ref:`int<class_int>` column **)**
.. _class_TreeItem_deselect:
- void **deselect** **(** :ref:`int<class_int>` column **)**
.. _class_TreeItem_set_editable:
- void **set_editable** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled **)**
.. _class_TreeItem_is_editable:
- :ref:`bool<class_bool>` **is_editable** **(** :ref:`int<class_int>` column **)**
.. _class_TreeItem_set_custom_color:
- void **set_custom_color** **(** :ref:`int<class_int>` column, :ref:`Color<class_color>` color **)**
.. _class_TreeItem_clear_custom_color:
- void **clear_custom_color** **(** :ref:`int<class_int>` column **)**
.. _class_TreeItem_set_custom_bg_color:
- void **set_custom_bg_color** **(** :ref:`int<class_int>` column, :ref:`Color<class_color>` color **)**
.. _class_TreeItem_clear_custom_bg_color:
- void **clear_custom_bg_color** **(** :ref:`int<class_int>` column **)**
.. _class_TreeItem_get_custom_bg_color:
- :ref:`Color<class_color>` **get_custom_bg_color** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_add_button:
- void **add_button** **(** :ref:`int<class_int>` column, :ref:`Texture<class_texture>` button, :ref:`int<class_int>` button_idx=-1, :ref:`bool<class_bool>` disabled=false **)**
.. _class_TreeItem_get_button_count:
- :ref:`int<class_int>` **get_button_count** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_get_button:
- :ref:`Texture<class_texture>` **get_button** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)** const
.. _class_TreeItem_erase_button:
- void **erase_button** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)**
.. _class_TreeItem_is_button_disabled:
- :ref:`bool<class_bool>` **is_button_disabled** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)** const
.. _class_TreeItem_set_tooltip:
- void **set_tooltip** **(** :ref:`int<class_int>` column, :ref:`String<class_string>` tooltip **)**
.. _class_TreeItem_get_tooltip:
- :ref:`String<class_string>` **get_tooltip** **(** :ref:`int<class_int>` column **)** const
.. _class_TreeItem_move_to_top:
- void **move_to_top** **(** **)**
.. _class_TreeItem_move_to_bottom:
- void **move_to_bottom** **(** **)**
Reference in New Issue View Git Blame Copy Permalink