Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: def522830a
Branches Tags
godot-docs
/
classes
/
class_treeitem.rst

class_treeitem.rst 47 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the TreeItem.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_TreeItem:
    8. 

  8. 

  9. TreeItem
    10. 

  10. ========
    11. 

  11. 

  12. **Inherits:** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

  17. -----------------
    18. 

  18. 

  19. Control for a single item inside a :ref:`Tree<class_Tree>`.
    20. 

  20. 

  21. Properties
    22. 

  22. ----------
    23. 

  23. 

  24. +-------------------------+-----------------------------------------------------------------------------+
    25. 

  25. | :ref:`bool<class_bool>` | :ref:`collapsed<class_TreeItem_property_collapsed>`                         |
    26. 

  26. +-------------------------+-----------------------------------------------------------------------------+
    27. 

  27. | :ref:`int<class_int>`   | :ref:`custom_minimum_height<class_TreeItem_property_custom_minimum_height>` |
    28. 

  28. +-------------------------+-----------------------------------------------------------------------------+
    29. 

  29. | :ref:`bool<class_bool>` | :ref:`disable_folding<class_TreeItem_property_disable_folding>`             |
    30. 

  30. +-------------------------+-----------------------------------------------------------------------------+
    31. 

  31. 

  32. Methods
    33. 

  33. -------
    34. 

  34. 

  35. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | void                                            | :ref:`add_button<class_TreeItem_method_add_button>` **(** :ref:`int<class_int>` column, :ref:`Texture<class_Texture>` button, :ref:`int<class_int>` button_idx=-1, :ref:`bool<class_bool>` disabled=false, :ref:`String<class_String>` tooltip="" **)** |
    37. 

  37. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | void                                            | :ref:`clear_custom_bg_color<class_TreeItem_method_clear_custom_bg_color>` **(** :ref:`int<class_int>` column **)**                                                                                                                                      |
    39. 

  39. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | void                                            | :ref:`clear_custom_color<class_TreeItem_method_clear_custom_color>` **(** :ref:`int<class_int>` column **)**                                                                                                                                            |
    41. 

  41. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                                            | :ref:`deselect<class_TreeItem_method_deselect>` **(** :ref:`int<class_int>` column **)**                                                                                                                                                                |
    43. 

  43. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                                            | :ref:`erase_button<class_TreeItem_method_erase_button>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)**                                                                                                                      |
    45. 

  45. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`Texture<class_Texture>`                   | :ref:`get_button<class_TreeItem_method_get_button>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)** const                                                                                                                    |
    47. 

  47. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`int<class_int>`                           | :ref:`get_button_count<class_TreeItem_method_get_button_count>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                          |
    49. 

  49. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` | :ref:`get_cell_mode<class_TreeItem_method_get_cell_mode>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                                |
    51. 

  51. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`TreeItem<class_TreeItem>`                 | :ref:`get_children<class_TreeItem_method_get_children>` **(** **)**                                                                                                                                                                                     |
    53. 

  53. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`Color<class_Color>`                       | :ref:`get_custom_bg_color<class_TreeItem_method_get_custom_bg_color>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                    |
    55. 

  55. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | :ref:`bool<class_bool>`                         | :ref:`get_expand_right<class_TreeItem_method_get_expand_right>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                          |
    57. 

  57. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | :ref:`Texture<class_Texture>`                   | :ref:`get_icon<class_TreeItem_method_get_icon>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                                          |
    59. 

  59. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | :ref:`int<class_int>`                           | :ref:`get_icon_max_width<class_TreeItem_method_get_icon_max_width>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                      |
    61. 

  61. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | :ref:`Rect2<class_Rect2>`                       | :ref:`get_icon_region<class_TreeItem_method_get_icon_region>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                            |
    63. 

  63. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | :ref:`Variant<class_Variant>`                   | :ref:`get_metadata<class_TreeItem_method_get_metadata>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                                  |
    65. 

  65. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`TreeItem<class_TreeItem>`                 | :ref:`get_next<class_TreeItem_method_get_next>` **(** **)**                                                                                                                                                                                             |
    67. 

  67. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | :ref:`TreeItem<class_TreeItem>`                 | :ref:`get_next_visible<class_TreeItem_method_get_next_visible>` **(** :ref:`bool<class_bool>` wrap=false **)**                                                                                                                                          |
    69. 

  69. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | :ref:`TreeItem<class_TreeItem>`                 | :ref:`get_parent<class_TreeItem_method_get_parent>` **(** **)**                                                                                                                                                                                         |
    71. 

  71. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | :ref:`TreeItem<class_TreeItem>`                 | :ref:`get_prev<class_TreeItem_method_get_prev>` **(** **)**                                                                                                                                                                                             |
    73. 

  73. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | :ref:`TreeItem<class_TreeItem>`                 | :ref:`get_prev_visible<class_TreeItem_method_get_prev_visible>` **(** :ref:`bool<class_bool>` wrap=false **)**                                                                                                                                          |
    75. 

  75. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | :ref:`float<class_float>`                       | :ref:`get_range<class_TreeItem_method_get_range>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                                        |
    77. 

  77. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | :ref:`Dictionary<class_Dictionary>`             | :ref:`get_range_config<class_TreeItem_method_get_range_config>` **(** :ref:`int<class_int>` column **)**                                                                                                                                                |
    79. 

  79. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | :ref:`String<class_String>`                     | :ref:`get_text<class_TreeItem_method_get_text>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                                          |
    81. 

  81. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    82. 

  82. | :ref:`TextAlign<enum_TreeItem_TextAlign>`       | :ref:`get_text_align<class_TreeItem_method_get_text_align>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                              |
    83. 

  83. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    84. 

  84. | :ref:`String<class_String>`                     | :ref:`get_tooltip<class_TreeItem_method_get_tooltip>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                                    |
    85. 

  85. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    86. 

  86. | :ref:`bool<class_bool>`                         | :ref:`is_button_disabled<class_TreeItem_method_is_button_disabled>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)** const                                                                                                    |
    87. 

  87. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    88. 

  88. | :ref:`bool<class_bool>`                         | :ref:`is_checked<class_TreeItem_method_is_checked>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                                      |
    89. 

  89. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    90. 

  90. | :ref:`bool<class_bool>`                         | :ref:`is_custom_set_as_button<class_TreeItem_method_is_custom_set_as_button>` **(** :ref:`int<class_int>` column **)** const                                                                                                                            |
    91. 

  91. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    92. 

  92. | :ref:`bool<class_bool>`                         | :ref:`is_editable<class_TreeItem_method_is_editable>` **(** :ref:`int<class_int>` column **)**                                                                                                                                                          |
    93. 

  93. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94. | :ref:`bool<class_bool>`                         | :ref:`is_selectable<class_TreeItem_method_is_selectable>` **(** :ref:`int<class_int>` column **)** const                                                                                                                                                |
    95. 

  95. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    96. 

  96. | :ref:`bool<class_bool>`                         | :ref:`is_selected<class_TreeItem_method_is_selected>` **(** :ref:`int<class_int>` column **)**                                                                                                                                                          |
    97. 

  97. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    98. 

  98. | void                                            | :ref:`move_to_bottom<class_TreeItem_method_move_to_bottom>` **(** **)**                                                                                                                                                                                 |
    99. 

  99. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    100. 

  100. | void                                            | :ref:`move_to_top<class_TreeItem_method_move_to_top>` **(** **)**                                                                                                                                                                                       |
    101. 

  101. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    102. 

  102. | void                                            | :ref:`remove_child<class_TreeItem_method_remove_child>` **(** :ref:`Object<class_Object>` child **)**                                                                                                                                                   |
    103. 

  103. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    104. 

  104. | void                                            | :ref:`select<class_TreeItem_method_select>` **(** :ref:`int<class_int>` column **)**                                                                                                                                                                    |
    105. 

  105. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    106. 

  106. | void                                            | :ref:`set_button<class_TreeItem_method_set_button>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx, :ref:`Texture<class_Texture>` button **)**                                                                                    |
    107. 

  107. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    108. 

  108. | void                                            | :ref:`set_button_disabled<class_TreeItem_method_set_button_disabled>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx, :ref:`bool<class_bool>` disabled **)**                                                                      |
    109. 

  109. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    110. 

  110. | void                                            | :ref:`set_cell_mode<class_TreeItem_method_set_cell_mode>` **(** :ref:`int<class_int>` column, :ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` mode **)**                                                                                                |
    111. 

  111. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    112. 

  112. | void                                            | :ref:`set_checked<class_TreeItem_method_set_checked>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` checked **)**                                                                                                                         |
    113. 

  113. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    114. 

  114. | void                                            | :ref:`set_custom_as_button<class_TreeItem_method_set_custom_as_button>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)**                                                                                                        |
    115. 

  115. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    116. 

  116. | void                                            | :ref:`set_custom_bg_color<class_TreeItem_method_set_custom_bg_color>` **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` just_outline=false **)**                                                             |
    117. 

  117. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    118. 

  118. | void                                            | :ref:`set_custom_color<class_TreeItem_method_set_custom_color>` **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` color **)**                                                                                                               |
    119. 

  119. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    120. 

  120. | void                                            | :ref:`set_custom_draw<class_TreeItem_method_set_custom_draw>` **(** :ref:`int<class_int>` column, :ref:`Object<class_Object>` object, :ref:`String<class_String>` callback **)**                                                                        |
    121. 

  121. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    122. 

  122. | void                                            | :ref:`set_editable<class_TreeItem_method_set_editable>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled **)**                                                                                                                       |
    123. 

  123. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    124. 

  124. | void                                            | :ref:`set_expand_right<class_TreeItem_method_set_expand_right>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)**                                                                                                                |
    125. 

  125. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    126. 

  126. | void                                            | :ref:`set_icon<class_TreeItem_method_set_icon>` **(** :ref:`int<class_int>` column, :ref:`Texture<class_Texture>` texture **)**                                                                                                                         |
    127. 

  127. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    128. 

  128. | void                                            | :ref:`set_icon_max_width<class_TreeItem_method_set_icon_max_width>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` width **)**                                                                                                               |
    129. 

  129. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    130. 

  130. | void                                            | :ref:`set_icon_region<class_TreeItem_method_set_icon_region>` **(** :ref:`int<class_int>` column, :ref:`Rect2<class_Rect2>` region **)**                                                                                                                |
    131. 

  131. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    132. 

  132. | void                                            | :ref:`set_metadata<class_TreeItem_method_set_metadata>` **(** :ref:`int<class_int>` column, :ref:`Variant<class_Variant>` meta **)**                                                                                                                    |
    133. 

  133. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    134. 

  134. | void                                            | :ref:`set_range<class_TreeItem_method_set_range>` **(** :ref:`int<class_int>` column, :ref:`float<class_float>` value **)**                                                                                                                             |
    135. 

  135. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    136. 

  136. | void                                            | :ref:`set_range_config<class_TreeItem_method_set_range_config>` **(** :ref:`int<class_int>` column, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` step, :ref:`bool<class_bool>` expr=false **)**              |
    137. 

  137. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    138. 

  138. | void                                            | :ref:`set_selectable<class_TreeItem_method_set_selectable>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` selectable **)**                                                                                                                |
    139. 

  139. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    140. 

  140. | void                                            | :ref:`set_text<class_TreeItem_method_set_text>` **(** :ref:`int<class_int>` column, :ref:`String<class_String>` text **)**                                                                                                                              |
    141. 

  141. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    142. 

  142. | void                                            | :ref:`set_text_align<class_TreeItem_method_set_text_align>` **(** :ref:`int<class_int>` column, :ref:`TextAlign<enum_TreeItem_TextAlign>` text_align **)**                                                                                              |
    143. 

  143. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    144. 

  144. | void                                            | :ref:`set_tooltip<class_TreeItem_method_set_tooltip>` **(** :ref:`int<class_int>` column, :ref:`String<class_String>` tooltip **)**                                                                                                                     |
    145. 

  145. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    146. 

  146. 

  147. Enumerations
    148. 

  148. ------------
    149. 

  149. 

  150. .. _enum_TreeItem_TreeCellMode:
    151. 

  151. 

  152. .. _class_TreeItem_constant_CELL_MODE_STRING:
    153. 

  153. 

  154. .. _class_TreeItem_constant_CELL_MODE_CHECK:
    155. 

  155. 

  156. .. _class_TreeItem_constant_CELL_MODE_RANGE:
    157. 

  157. 

  158. .. _class_TreeItem_constant_CELL_MODE_ICON:
    159. 

  159. 

  160. .. _class_TreeItem_constant_CELL_MODE_CUSTOM:
    161. 

  161. 

  162. enum **TreeCellMode**:
    163. 

  163. 

  164. - **CELL_MODE_STRING** = **0** --- Cell contains a string.
    165. 

  165. 

  166. - **CELL_MODE_CHECK** = **1** --- Cell can be checked.
    167. 

  167. 

  168. - **CELL_MODE_RANGE** = **2** --- Cell contains a range.
    169. 

  169. 

  170. - **CELL_MODE_ICON** = **3** --- Cell contains an icon.
    171. 

  171. 

  172. - **CELL_MODE_CUSTOM** = **4**
    173. 

  173. 

  174. .. _enum_TreeItem_TextAlign:
    175. 

  175. 

  176. .. _class_TreeItem_constant_ALIGN_LEFT:
    177. 

  177. 

  178. .. _class_TreeItem_constant_ALIGN_CENTER:
    179. 

  179. 

  180. .. _class_TreeItem_constant_ALIGN_RIGHT:
    181. 

  181. 

  182. enum **TextAlign**:
    183. 

  183. 

  184. - **ALIGN_LEFT** = **0** --- Align text to the left. See ``set_text_align()``.
    185. 

  185. 

  186. - **ALIGN_CENTER** = **1** --- Center text. See ``set_text_align()``.
    187. 

  187. 

  188. - **ALIGN_RIGHT** = **2** --- Align text to the right. See ``set_text_align()``.
    189. 

  189. 

  190. Description
    191. 

  191. -----------
    192. 

  192. 

  193. Control for a single item inside a :ref:`Tree<class_Tree>`. May have child ``TreeItem``\ s and be styled as well as contain buttons.
    194. 

  194. 

  195. Property Descriptions
    196. 

  196. ---------------------
    197. 

  197. 

  198. .. _class_TreeItem_property_collapsed:
    199. 

  199. 

  200. - :ref:`bool<class_bool>` **collapsed**
    201. 

  201. 

  202. +----------+----------------------+
    203. 

  203. | *Setter* | set_collapsed(value) |
    204. 

  204. +----------+----------------------+
    205. 

  205. | *Getter* | is_collapsed()       |
    206. 

  206. +----------+----------------------+
    207. 

  207. 

  208. If ``true``, the TreeItem is collapsed.
    209. 

  209. 

  210. .. _class_TreeItem_property_custom_minimum_height:
    211. 

  211. 

  212. - :ref:`int<class_int>` **custom_minimum_height**
    213. 

  213. 

  214. +----------+----------------------------------+
    215. 

  215. | *Setter* | set_custom_minimum_height(value) |
    216. 

  216. +----------+----------------------------------+
    217. 

  217. | *Getter* | get_custom_minimum_height()      |
    218. 

  218. +----------+----------------------------------+
    219. 

  219. 

  220. The custom minimum height.
    221. 

  221. 

  222. .. _class_TreeItem_property_disable_folding:
    223. 

  223. 

  224. - :ref:`bool<class_bool>` **disable_folding**
    225. 

  225. 

  226. +----------+----------------------------+
    227. 

  227. | *Setter* | set_disable_folding(value) |
    228. 

  228. +----------+----------------------------+
    229. 

  229. | *Getter* | is_folding_disabled()      |
    230. 

  230. +----------+----------------------------+
    231. 

  231. 

  232. If ``true``, folding is disabled for this TreeItem.
    233. 

  233. 

  234. Method Descriptions
    235. 

  235. -------------------
    236. 

  236. 

  237. .. _class_TreeItem_method_add_button:
    238. 

  238. 

  239. - void **add_button** **(** :ref:`int<class_int>` column, :ref:`Texture<class_Texture>` button, :ref:`int<class_int>` button_idx=-1, :ref:`bool<class_bool>` disabled=false, :ref:`String<class_String>` tooltip="" **)**
    240. 

  240. 

  241. Adds a button with :ref:`Texture<class_Texture>` ``button`` at column ``column``. The ``button_idx`` index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count<class_TreeItem_method_get_button_count>` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``.
    242. 

  242. 

  243. .. _class_TreeItem_method_clear_custom_bg_color:
    244. 

  244. 

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

  246. 

  247. Resets the background color for the given column to default.
    248. 

  248. 

  249. .. _class_TreeItem_method_clear_custom_color:
    250. 

  250. 

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

  252. 

  253. Resets the color for the given column to default.
    254. 

  254. 

  255. .. _class_TreeItem_method_deselect:
    256. 

  256. 

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

  258. 

  259. Deselects the given column.
    260. 

  260. 

  261. .. _class_TreeItem_method_erase_button:
    262. 

  262. 

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

  264. 

  265. Removes the button at index ``button_idx`` in column ``column``.
    266. 

  266. 

  267. .. _class_TreeItem_method_get_button:
    268. 

  268. 

  269. - :ref:`Texture<class_Texture>` **get_button** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx **)** const
    270. 

  270. 

  271. Returns the :ref:`Texture<class_Texture>` of the button at index ``button_idx`` in column ``column``.
    272. 

  272. 

  273. .. _class_TreeItem_method_get_button_count:
    274. 

  274. 

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

  276. 

  277. Returns the number of buttons in column ``column``. May be used to get the most recently added button's index, if no index was specified.
    278. 

  278. 

  279. .. _class_TreeItem_method_get_cell_mode:
    280. 

  280. 

  281. - :ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` **get_cell_mode** **(** :ref:`int<class_int>` column **)** const
    282. 

  282. 

  283. Returns the column's cell mode.
    284. 

  284. 

  285. .. _class_TreeItem_method_get_children:
    286. 

  286. 

  287. - :ref:`TreeItem<class_TreeItem>` **get_children** **(** **)**
    288. 

  288. 

  289. Returns the TreeItem's child items.
    290. 

  290. 

  291. .. _class_TreeItem_method_get_custom_bg_color:
    292. 

  292. 

  293. - :ref:`Color<class_Color>` **get_custom_bg_color** **(** :ref:`int<class_int>` column **)** const
    294. 

  294. 

  295. Returns the custom background color of column ``column``.
    296. 

  296. 

  297. .. _class_TreeItem_method_get_expand_right:
    298. 

  298. 

  299. - :ref:`bool<class_bool>` **get_expand_right** **(** :ref:`int<class_int>` column **)** const
    300. 

  300. 

  301. Returns ``true`` if ``expand_right`` is set.
    302. 

  302. 

  303. .. _class_TreeItem_method_get_icon:
    304. 

  304. 

  305. - :ref:`Texture<class_Texture>` **get_icon** **(** :ref:`int<class_int>` column **)** const
    306. 

  306. 

  307. Returns the given column's icon :ref:`Texture<class_Texture>`. Error if no icon is set.
    308. 

  308. 

  309. .. _class_TreeItem_method_get_icon_max_width:
    310. 

  310. 

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

  312. 

  313. Returns the column's icon's maximum width.
    314. 

  314. 

  315. .. _class_TreeItem_method_get_icon_region:
    316. 

  316. 

  317. - :ref:`Rect2<class_Rect2>` **get_icon_region** **(** :ref:`int<class_int>` column **)** const
    318. 

  318. 

  319. Returns the icon :ref:`Texture<class_Texture>` region as :ref:`Rect2<class_Rect2>`.
    320. 

  320. 

  321. .. _class_TreeItem_method_get_metadata:
    322. 

  322. 

  323. - :ref:`Variant<class_Variant>` **get_metadata** **(** :ref:`int<class_int>` column **)** const
    324. 

  324. 

  325. .. _class_TreeItem_method_get_next:
    326. 

  326. 

  327. - :ref:`TreeItem<class_TreeItem>` **get_next** **(** **)**
    328. 

  328. 

  329. Returns the next TreeItem in the tree.
    330. 

  330. 

  331. .. _class_TreeItem_method_get_next_visible:
    332. 

  332. 

  333. - :ref:`TreeItem<class_TreeItem>` **get_next_visible** **(** :ref:`bool<class_bool>` wrap=false **)**
    334. 

  334. 

  335. Returns the next visible TreeItem in the tree.
    336. 

  336. 

  337. 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``.
    338. 

  338. 

  339. .. _class_TreeItem_method_get_parent:
    340. 

  340. 

  341. - :ref:`TreeItem<class_TreeItem>` **get_parent** **(** **)**
    342. 

  342. 

  343. Returns the parent TreeItem.
    344. 

  344. 

  345. .. _class_TreeItem_method_get_prev:
    346. 

  346. 

  347. - :ref:`TreeItem<class_TreeItem>` **get_prev** **(** **)**
    348. 

  348. 

  349. Returns the previous TreeItem in the tree.
    350. 

  350. 

  351. .. _class_TreeItem_method_get_prev_visible:
    352. 

  352. 

  353. - :ref:`TreeItem<class_TreeItem>` **get_prev_visible** **(** :ref:`bool<class_bool>` wrap=false **)**
    354. 

  354. 

  355. Returns the previous visible TreeItem in the tree.
    356. 

  356. 

  357. 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``.
    358. 

  358. 

  359. .. _class_TreeItem_method_get_range:
    360. 

  360. 

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

  362. 

  363. .. _class_TreeItem_method_get_range_config:
    364. 

  364. 

  365. - :ref:`Dictionary<class_Dictionary>` **get_range_config** **(** :ref:`int<class_int>` column **)**
    366. 

  366. 

  367. .. _class_TreeItem_method_get_text:
    368. 

  368. 

  369. - :ref:`String<class_String>` **get_text** **(** :ref:`int<class_int>` column **)** const
    370. 

  370. 

  371. Returns the given column's text.
    372. 

  372. 

  373. .. _class_TreeItem_method_get_text_align:
    374. 

  374. 

  375. - :ref:`TextAlign<enum_TreeItem_TextAlign>` **get_text_align** **(** :ref:`int<class_int>` column **)** const
    376. 

  376. 

  377. Returns the given column's text alignment.
    378. 

  378. 

  379. .. _class_TreeItem_method_get_tooltip:
    380. 

  380. 

  381. - :ref:`String<class_String>` **get_tooltip** **(** :ref:`int<class_int>` column **)** const
    382. 

  382. 

  383. Returns the given column's tooltip.
    384. 

  384. 

  385. .. _class_TreeItem_method_is_button_disabled:
    386. 

  386. 

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

  388. 

  389. Returns ``true`` if the button at index ``button_idx`` for the given column is disabled.
    390. 

  390. 

  391. .. _class_TreeItem_method_is_checked:
    392. 

  392. 

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

  394. 

  395. Returns ``true`` if the given column is checked.
    396. 

  396. 

  397. .. _class_TreeItem_method_is_custom_set_as_button:
    398. 

  398. 

  399. - :ref:`bool<class_bool>` **is_custom_set_as_button** **(** :ref:`int<class_int>` column **)** const
    400. 

  400. 

  401. .. _class_TreeItem_method_is_editable:
    402. 

  402. 

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

  404. 

  405. Returns ``true`` if column ``column`` is editable.
    406. 

  406. 

  407. .. _class_TreeItem_method_is_selectable:
    408. 

  408. 

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

  410. 

  411. Returns ``true`` if column ``column`` is selectable.
    412. 

  412. 

  413. .. _class_TreeItem_method_is_selected:
    414. 

  414. 

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

  416. 

  417. Returns ``true`` if column ``column`` is selected.
    418. 

  418. 

  419. .. _class_TreeItem_method_move_to_bottom:
    420. 

  420. 

  421. - void **move_to_bottom** **(** **)**
    422. 

  422. 

  423. Moves this TreeItem to the bottom in the :ref:`Tree<class_Tree>` hierarchy.
    424. 

  424. 

  425. .. _class_TreeItem_method_move_to_top:
    426. 

  426. 

  427. - void **move_to_top** **(** **)**
    428. 

  428. 

  429. Moves this TreeItem to the top in the :ref:`Tree<class_Tree>` hierarchy.
    430. 

  430. 

  431. .. _class_TreeItem_method_remove_child:
    432. 

  432. 

  433. - void **remove_child** **(** :ref:`Object<class_Object>` child **)**
    434. 

  434. 

  435. Removes the given child TreeItem.
    436. 

  436. 

  437. .. _class_TreeItem_method_select:
    438. 

  438. 

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

  440. 

  441. Selects the column ``column``.
    442. 

  442. 

  443. .. _class_TreeItem_method_set_button:
    444. 

  444. 

  445. - void **set_button** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx, :ref:`Texture<class_Texture>` button **)**
    446. 

  446. 

  447. Sets the given column's button :ref:`Texture<class_Texture>` at index ``button_idx`` to ``button``.
    448. 

  448. 

  449. .. _class_TreeItem_method_set_button_disabled:
    450. 

  450. 

  451. - void **set_button_disabled** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` button_idx, :ref:`bool<class_bool>` disabled **)**
    452. 

  452. 

  453. If ``true``, disables the button at index ``button_idx`` in column ``column``.
    454. 

  454. 

  455. .. _class_TreeItem_method_set_cell_mode:
    456. 

  456. 

  457. - void **set_cell_mode** **(** :ref:`int<class_int>` column, :ref:`TreeCellMode<enum_TreeItem_TreeCellMode>` mode **)**
    458. 

  458. 

  459. Sets the given column's cell mode to ``mode``. See ``CELL_MODE_*`` constants.
    460. 

  460. 

  461. .. _class_TreeItem_method_set_checked:
    462. 

  462. 

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

  464. 

  465. If ``true``, the column ``column`` is checked.
    466. 

  466. 

  467. .. _class_TreeItem_method_set_custom_as_button:
    468. 

  468. 

  469. - void **set_custom_as_button** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)**
    470. 

  470. 

  471. .. _class_TreeItem_method_set_custom_bg_color:
    472. 

  472. 

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

  474. 

  475. Sets the given column's custom background color and whether to just use it as an outline.
    476. 

  476. 

  477. .. _class_TreeItem_method_set_custom_color:
    478. 

  478. 

  479. - void **set_custom_color** **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` color **)**
    480. 

  480. 

  481. Sets the given column's custom color.
    482. 

  482. 

  483. .. _class_TreeItem_method_set_custom_draw:
    484. 

  484. 

  485. - void **set_custom_draw** **(** :ref:`int<class_int>` column, :ref:`Object<class_Object>` object, :ref:`String<class_String>` callback **)**
    486. 

  486. 

  487. Sets the given column's custom draw callback to ``callback`` method on ``object``.
    488. 

  488. 

  489. The ``callback`` should accept two arguments: the ``TreeItem`` that is drawn and its position and size as a :ref:`Rect2<class_Rect2>`.
    490. 

  490. 

  491. .. _class_TreeItem_method_set_editable:
    492. 

  492. 

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

  494. 

  495. If ``true``, column ``column`` is editable.
    496. 

  496. 

  497. .. _class_TreeItem_method_set_expand_right:
    498. 

  498. 

  499. - void **set_expand_right** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)**
    500. 

  500. 

  501. If ``true``, column ``column`` is expanded to the right.
    502. 

  502. 

  503. .. _class_TreeItem_method_set_icon:
    504. 

  504. 

  505. - void **set_icon** **(** :ref:`int<class_int>` column, :ref:`Texture<class_Texture>` texture **)**
    506. 

  506. 

  507. Sets the given column's icon :ref:`Texture<class_Texture>`.
    508. 

  508. 

  509. .. _class_TreeItem_method_set_icon_max_width:
    510. 

  510. 

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

  512. 

  513. Sets the given column's icon's maximum width.
    514. 

  514. 

  515. .. _class_TreeItem_method_set_icon_region:
    516. 

  516. 

  517. - void **set_icon_region** **(** :ref:`int<class_int>` column, :ref:`Rect2<class_Rect2>` region **)**
    518. 

  518. 

  519. Sets the given column's icon's texture region.
    520. 

  520. 

  521. .. _class_TreeItem_method_set_metadata:
    522. 

  522. 

  523. - void **set_metadata** **(** :ref:`int<class_int>` column, :ref:`Variant<class_Variant>` meta **)**
    524. 

  524. 

  525. .. _class_TreeItem_method_set_range:
    526. 

  526. 

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

  528. 

  529. .. _class_TreeItem_method_set_range_config:
    530. 

  530. 

  531. - 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 **)**
    532. 

  532. 

  533. .. _class_TreeItem_method_set_selectable:
    534. 

  534. 

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

  536. 

  537. If ``true``, the given column is selectable.
    538. 

  538. 

  539. .. _class_TreeItem_method_set_text:
    540. 

  540. 

  541. - void **set_text** **(** :ref:`int<class_int>` column, :ref:`String<class_String>` text **)**
    542. 

  542. 

  543. .. _class_TreeItem_method_set_text_align:
    544. 

  544. 

  545. - void **set_text_align** **(** :ref:`int<class_int>` column, :ref:`TextAlign<enum_TreeItem_TextAlign>` text_align **)**
    546. 

  546. 

  547. Sets the given column's text alignment. See :ref:`TextAlign<enum_TreeItem_TextAlign>` for possible values.
    548. 

  548. 

  549. .. _class_TreeItem_method_set_tooltip:
    550. 

  550. 

  551. - void **set_tooltip** **(** :ref:`int<class_int>` column, :ref:`String<class_String>` tooltip **)**
    552. 

  552. 

  553. Sets the given column's tooltip text.
    554. 

  554.