class_foldablecontainer.rst 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603
  1. :github_url: hide
  2. .. meta::
  3. :keywords: expandable, collapsible, collapse
  4. .. DO NOT EDIT THIS FILE!!!
  5. .. Generated automatically from Godot engine sources.
  6. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  7. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FoldableContainer.xml.
  8. .. _class_FoldableContainer:
  9. FoldableContainer
  10. =================
  11. **Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  12. A container that can be expanded/collapsed.
  13. .. rst-class:: classref-introduction-group
  14. Description
  15. -----------
  16. A container that can be expanded/collapsed, with a title that can be filled with controls, such as buttons.
  17. The title can be positioned at the top or bottom of the container.
  18. The container can be expanded or collapsed by clicking the title or by pressing ``ui_accept`` when focused.
  19. Child control nodes are hidden when the container is collapsed. Ignores non-control children.
  20. Can allow grouping with other FoldableContainers, check :ref:`foldable_group<class_FoldableContainer_property_foldable_group>` and :ref:`FoldableGroup<class_FoldableGroup>`.
  21. .. rst-class:: classref-reftable-group
  22. Properties
  23. ----------
  24. .. table::
  25. :widths: auto
  26. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  27. | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
  28. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  29. | :ref:`FoldableGroup<class_FoldableGroup>` | :ref:`foldable_group<class_FoldableContainer_property_foldable_group>` | |
  30. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  31. | :ref:`bool<class_bool>` | :ref:`folded<class_FoldableContainer_property_folded>` | ``false`` |
  32. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  33. | :ref:`String<class_String>` | :ref:`language<class_FoldableContainer_property_language>` | ``""`` |
  34. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  35. | :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | ``0`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
  36. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  37. | :ref:`String<class_String>` | :ref:`title<class_FoldableContainer_property_title>` | ``""`` |
  38. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  39. | :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` | :ref:`title_alignment<class_FoldableContainer_property_title_alignment>` | ``0`` |
  40. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  41. | :ref:`TitlePosition<enum_FoldableContainer_TitlePosition>` | :ref:`title_position<class_FoldableContainer_property_title_position>` | ``0`` |
  42. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  43. | :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`title_text_direction<class_FoldableContainer_property_title_text_direction>` | ``0`` |
  44. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  45. | :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` | :ref:`title_text_overrun_behavior<class_FoldableContainer_property_title_text_overrun_behavior>` | ``0`` |
  46. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
  47. .. rst-class:: classref-reftable-group
  48. Methods
  49. -------
  50. .. table::
  51. :widths: auto
  52. +--------+-----------------------------------------------------------------------------------------------------------------------------------------+
  53. | |void| | :ref:`add_title_bar_control<class_FoldableContainer_method_add_title_bar_control>`\ (\ control\: :ref:`Control<class_Control>`\ ) |
  54. +--------+-----------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`expand<class_FoldableContainer_method_expand>`\ (\ ) |
  56. +--------+-----------------------------------------------------------------------------------------------------------------------------------------+
  57. | |void| | :ref:`fold<class_FoldableContainer_method_fold>`\ (\ ) |
  58. +--------+-----------------------------------------------------------------------------------------------------------------------------------------+
  59. | |void| | :ref:`remove_title_bar_control<class_FoldableContainer_method_remove_title_bar_control>`\ (\ control\: :ref:`Control<class_Control>`\ ) |
  60. +--------+-----------------------------------------------------------------------------------------------------------------------------------------+
  61. .. rst-class:: classref-reftable-group
  62. Theme Properties
  63. ----------------
  64. .. table::
  65. :widths: auto
  66. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  67. | :ref:`Color<class_Color>` | :ref:`collapsed_font_color<class_FoldableContainer_theme_color_collapsed_font_color>` | ``Color(1, 1, 1, 1)`` |
  68. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  69. | :ref:`Color<class_Color>` | :ref:`font_color<class_FoldableContainer_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
  70. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  71. | :ref:`Color<class_Color>` | :ref:`font_outline_color<class_FoldableContainer_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
  72. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  73. | :ref:`Color<class_Color>` | :ref:`hover_font_color<class_FoldableContainer_theme_color_hover_font_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
  74. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  75. | :ref:`int<class_int>` | :ref:`h_separation<class_FoldableContainer_theme_constant_h_separation>` | ``2`` |
  76. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  77. | :ref:`int<class_int>` | :ref:`outline_size<class_FoldableContainer_theme_constant_outline_size>` | ``0`` |
  78. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  79. | :ref:`Font<class_Font>` | :ref:`font<class_FoldableContainer_theme_font_font>` | |
  80. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  81. | :ref:`int<class_int>` | :ref:`font_size<class_FoldableContainer_theme_font_size_font_size>` | |
  82. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  83. | :ref:`Texture2D<class_Texture2D>` | :ref:`expanded_arrow<class_FoldableContainer_theme_icon_expanded_arrow>` | |
  84. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  85. | :ref:`Texture2D<class_Texture2D>` | :ref:`expanded_arrow_mirrored<class_FoldableContainer_theme_icon_expanded_arrow_mirrored>` | |
  86. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  87. | :ref:`Texture2D<class_Texture2D>` | :ref:`folded_arrow<class_FoldableContainer_theme_icon_folded_arrow>` | |
  88. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  89. | :ref:`Texture2D<class_Texture2D>` | :ref:`folded_arrow_mirrored<class_FoldableContainer_theme_icon_folded_arrow_mirrored>` | |
  90. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  91. | :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_FoldableContainer_theme_style_focus>` | |
  92. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  93. | :ref:`StyleBox<class_StyleBox>` | :ref:`panel<class_FoldableContainer_theme_style_panel>` | |
  94. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  95. | :ref:`StyleBox<class_StyleBox>` | :ref:`title_collapsed_hover_panel<class_FoldableContainer_theme_style_title_collapsed_hover_panel>` | |
  96. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  97. | :ref:`StyleBox<class_StyleBox>` | :ref:`title_collapsed_panel<class_FoldableContainer_theme_style_title_collapsed_panel>` | |
  98. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  99. | :ref:`StyleBox<class_StyleBox>` | :ref:`title_hover_panel<class_FoldableContainer_theme_style_title_hover_panel>` | |
  100. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  101. | :ref:`StyleBox<class_StyleBox>` | :ref:`title_panel<class_FoldableContainer_theme_style_title_panel>` | |
  102. +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+
  103. .. rst-class:: classref-section-separator
  104. ----
  105. .. rst-class:: classref-descriptions-group
  106. Signals
  107. -------
  108. .. _class_FoldableContainer_signal_folding_changed:
  109. .. rst-class:: classref-signal
  110. **folding_changed**\ (\ is_folded\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_FoldableContainer_signal_folding_changed>`
  111. Emitted when the container is folded/expanded.
  112. .. rst-class:: classref-section-separator
  113. ----
  114. .. rst-class:: classref-descriptions-group
  115. Enumerations
  116. ------------
  117. .. _enum_FoldableContainer_TitlePosition:
  118. .. rst-class:: classref-enumeration
  119. enum **TitlePosition**: :ref:`🔗<enum_FoldableContainer_TitlePosition>`
  120. .. _class_FoldableContainer_constant_POSITION_TOP:
  121. .. rst-class:: classref-enumeration-constant
  122. :ref:`TitlePosition<enum_FoldableContainer_TitlePosition>` **POSITION_TOP** = ``0``
  123. Makes the title appear at the top of the container.
  124. .. _class_FoldableContainer_constant_POSITION_BOTTOM:
  125. .. rst-class:: classref-enumeration-constant
  126. :ref:`TitlePosition<enum_FoldableContainer_TitlePosition>` **POSITION_BOTTOM** = ``1``
  127. Makes the title appear at the bottom of the container. Also makes all StyleBoxes flipped vertically.
  128. .. rst-class:: classref-section-separator
  129. ----
  130. .. rst-class:: classref-descriptions-group
  131. Property Descriptions
  132. ---------------------
  133. .. _class_FoldableContainer_property_foldable_group:
  134. .. rst-class:: classref-property
  135. :ref:`FoldableGroup<class_FoldableGroup>` **foldable_group** :ref:`🔗<class_FoldableContainer_property_foldable_group>`
  136. .. rst-class:: classref-property-setget
  137. - |void| **set_foldable_group**\ (\ value\: :ref:`FoldableGroup<class_FoldableGroup>`\ )
  138. - :ref:`FoldableGroup<class_FoldableGroup>` **get_foldable_group**\ (\ )
  139. The :ref:`FoldableGroup<class_FoldableGroup>` associated with the container. When multiple **FoldableContainer** nodes share the same group, only one of them is allowed to be unfolded.
  140. .. rst-class:: classref-item-separator
  141. ----
  142. .. _class_FoldableContainer_property_folded:
  143. .. rst-class:: classref-property
  144. :ref:`bool<class_bool>` **folded** = ``false`` :ref:`🔗<class_FoldableContainer_property_folded>`
  145. .. rst-class:: classref-property-setget
  146. - |void| **set_folded**\ (\ value\: :ref:`bool<class_bool>`\ )
  147. - :ref:`bool<class_bool>` **is_folded**\ (\ )
  148. If ``true``, the container will becomes folded and will hide all its children.
  149. .. rst-class:: classref-item-separator
  150. ----
  151. .. _class_FoldableContainer_property_language:
  152. .. rst-class:: classref-property
  153. :ref:`String<class_String>` **language** = ``""`` :ref:`🔗<class_FoldableContainer_property_language>`
  154. .. rst-class:: classref-property-setget
  155. - |void| **set_language**\ (\ value\: :ref:`String<class_String>`\ )
  156. - :ref:`String<class_String>` **get_language**\ (\ )
  157. Language code used for text shaping algorithms. If left empty, current locale is used instead.
  158. .. rst-class:: classref-item-separator
  159. ----
  160. .. _class_FoldableContainer_property_title:
  161. .. rst-class:: classref-property
  162. :ref:`String<class_String>` **title** = ``""`` :ref:`🔗<class_FoldableContainer_property_title>`
  163. .. rst-class:: classref-property-setget
  164. - |void| **set_title**\ (\ value\: :ref:`String<class_String>`\ )
  165. - :ref:`String<class_String>` **get_title**\ (\ )
  166. The container's title text.
  167. .. rst-class:: classref-item-separator
  168. ----
  169. .. _class_FoldableContainer_property_title_alignment:
  170. .. rst-class:: classref-property
  171. :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **title_alignment** = ``0`` :ref:`🔗<class_FoldableContainer_property_title_alignment>`
  172. .. rst-class:: classref-property-setget
  173. - |void| **set_title_alignment**\ (\ value\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>`\ )
  174. - :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **get_title_alignment**\ (\ )
  175. Title's horizontal text alignment.
  176. .. rst-class:: classref-item-separator
  177. ----
  178. .. _class_FoldableContainer_property_title_position:
  179. .. rst-class:: classref-property
  180. :ref:`TitlePosition<enum_FoldableContainer_TitlePosition>` **title_position** = ``0`` :ref:`🔗<class_FoldableContainer_property_title_position>`
  181. .. rst-class:: classref-property-setget
  182. - |void| **set_title_position**\ (\ value\: :ref:`TitlePosition<enum_FoldableContainer_TitlePosition>`\ )
  183. - :ref:`TitlePosition<enum_FoldableContainer_TitlePosition>` **get_title_position**\ (\ )
  184. Title's position.
  185. .. rst-class:: classref-item-separator
  186. ----
  187. .. _class_FoldableContainer_property_title_text_direction:
  188. .. rst-class:: classref-property
  189. :ref:`TextDirection<enum_Control_TextDirection>` **title_text_direction** = ``0`` :ref:`🔗<class_FoldableContainer_property_title_text_direction>`
  190. .. rst-class:: classref-property-setget
  191. - |void| **set_title_text_direction**\ (\ value\: :ref:`TextDirection<enum_Control_TextDirection>`\ )
  192. - :ref:`TextDirection<enum_Control_TextDirection>` **get_title_text_direction**\ (\ )
  193. Title text writing direction.
  194. .. rst-class:: classref-item-separator
  195. ----
  196. .. _class_FoldableContainer_property_title_text_overrun_behavior:
  197. .. rst-class:: classref-property
  198. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **title_text_overrun_behavior** = ``0`` :ref:`🔗<class_FoldableContainer_property_title_text_overrun_behavior>`
  199. .. rst-class:: classref-property-setget
  200. - |void| **set_title_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>`\ )
  201. - :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **get_title_text_overrun_behavior**\ (\ )
  202. Defines the behavior of the title when the text is longer than the available space.
  203. .. rst-class:: classref-section-separator
  204. ----
  205. .. rst-class:: classref-descriptions-group
  206. Method Descriptions
  207. -------------------
  208. .. _class_FoldableContainer_method_add_title_bar_control:
  209. .. rst-class:: classref-method
  210. |void| **add_title_bar_control**\ (\ control\: :ref:`Control<class_Control>`\ ) :ref:`🔗<class_FoldableContainer_method_add_title_bar_control>`
  211. Adds a :ref:`Control<class_Control>` that will be placed next to the container's title, obscuring the clickable area. Prime usage is adding :ref:`Button<class_Button>` nodes, but it can be any :ref:`Control<class_Control>`.
  212. The control will be added as a child of this container and removed from previous parent if necessary. The controls will be placed aligned to the right, with the first added control being the leftmost one.
  213. .. rst-class:: classref-item-separator
  214. ----
  215. .. _class_FoldableContainer_method_expand:
  216. .. rst-class:: classref-method
  217. |void| **expand**\ (\ ) :ref:`🔗<class_FoldableContainer_method_expand>`
  218. Expands the container and emits :ref:`folding_changed<class_FoldableContainer_signal_folding_changed>`.
  219. .. rst-class:: classref-item-separator
  220. ----
  221. .. _class_FoldableContainer_method_fold:
  222. .. rst-class:: classref-method
  223. |void| **fold**\ (\ ) :ref:`🔗<class_FoldableContainer_method_fold>`
  224. Folds the container and emits :ref:`folding_changed<class_FoldableContainer_signal_folding_changed>`.
  225. .. rst-class:: classref-item-separator
  226. ----
  227. .. _class_FoldableContainer_method_remove_title_bar_control:
  228. .. rst-class:: classref-method
  229. |void| **remove_title_bar_control**\ (\ control\: :ref:`Control<class_Control>`\ ) :ref:`🔗<class_FoldableContainer_method_remove_title_bar_control>`
  230. Removes a :ref:`Control<class_Control>` added with :ref:`add_title_bar_control()<class_FoldableContainer_method_add_title_bar_control>`. The node is not freed automatically, you need to use :ref:`Node.queue_free()<class_Node_method_queue_free>`.
  231. .. rst-class:: classref-section-separator
  232. ----
  233. .. rst-class:: classref-descriptions-group
  234. Theme Property Descriptions
  235. ---------------------------
  236. .. _class_FoldableContainer_theme_color_collapsed_font_color:
  237. .. rst-class:: classref-themeproperty
  238. :ref:`Color<class_Color>` **collapsed_font_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_FoldableContainer_theme_color_collapsed_font_color>`
  239. The title's font color when collapsed.
  240. .. rst-class:: classref-item-separator
  241. ----
  242. .. _class_FoldableContainer_theme_color_font_color:
  243. .. rst-class:: classref-themeproperty
  244. :ref:`Color<class_Color>` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗<class_FoldableContainer_theme_color_font_color>`
  245. The title's font color when expanded.
  246. .. rst-class:: classref-item-separator
  247. ----
  248. .. _class_FoldableContainer_theme_color_font_outline_color:
  249. .. rst-class:: classref-themeproperty
  250. :ref:`Color<class_Color>` **font_outline_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_FoldableContainer_theme_color_font_outline_color>`
  251. The title's font outline color.
  252. .. rst-class:: classref-item-separator
  253. ----
  254. .. _class_FoldableContainer_theme_color_hover_font_color:
  255. .. rst-class:: classref-themeproperty
  256. :ref:`Color<class_Color>` **hover_font_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_FoldableContainer_theme_color_hover_font_color>`
  257. The title's font hover color.
  258. .. rst-class:: classref-item-separator
  259. ----
  260. .. _class_FoldableContainer_theme_constant_h_separation:
  261. .. rst-class:: classref-themeproperty
  262. :ref:`int<class_int>` **h_separation** = ``2`` :ref:`🔗<class_FoldableContainer_theme_constant_h_separation>`
  263. The horizontal separation between the title's icon and text, and between title bar controls.
  264. .. rst-class:: classref-item-separator
  265. ----
  266. .. _class_FoldableContainer_theme_constant_outline_size:
  267. .. rst-class:: classref-themeproperty
  268. :ref:`int<class_int>` **outline_size** = ``0`` :ref:`🔗<class_FoldableContainer_theme_constant_outline_size>`
  269. The title's font outline size.
  270. .. rst-class:: classref-item-separator
  271. ----
  272. .. _class_FoldableContainer_theme_font_font:
  273. .. rst-class:: classref-themeproperty
  274. :ref:`Font<class_Font>` **font** :ref:`🔗<class_FoldableContainer_theme_font_font>`
  275. The title's font.
  276. .. rst-class:: classref-item-separator
  277. ----
  278. .. _class_FoldableContainer_theme_font_size_font_size:
  279. .. rst-class:: classref-themeproperty
  280. :ref:`int<class_int>` **font_size** :ref:`🔗<class_FoldableContainer_theme_font_size_font_size>`
  281. The title's font size.
  282. .. rst-class:: classref-item-separator
  283. ----
  284. .. _class_FoldableContainer_theme_icon_expanded_arrow:
  285. .. rst-class:: classref-themeproperty
  286. :ref:`Texture2D<class_Texture2D>` **expanded_arrow** :ref:`🔗<class_FoldableContainer_theme_icon_expanded_arrow>`
  287. The title's icon used when expanded.
  288. .. rst-class:: classref-item-separator
  289. ----
  290. .. _class_FoldableContainer_theme_icon_expanded_arrow_mirrored:
  291. .. rst-class:: classref-themeproperty
  292. :ref:`Texture2D<class_Texture2D>` **expanded_arrow_mirrored** :ref:`🔗<class_FoldableContainer_theme_icon_expanded_arrow_mirrored>`
  293. The title's icon used when expanded (for bottom title).
  294. .. rst-class:: classref-item-separator
  295. ----
  296. .. _class_FoldableContainer_theme_icon_folded_arrow:
  297. .. rst-class:: classref-themeproperty
  298. :ref:`Texture2D<class_Texture2D>` **folded_arrow** :ref:`🔗<class_FoldableContainer_theme_icon_folded_arrow>`
  299. The title's icon used when folded (for left-to-right layouts).
  300. .. rst-class:: classref-item-separator
  301. ----
  302. .. _class_FoldableContainer_theme_icon_folded_arrow_mirrored:
  303. .. rst-class:: classref-themeproperty
  304. :ref:`Texture2D<class_Texture2D>` **folded_arrow_mirrored** :ref:`🔗<class_FoldableContainer_theme_icon_folded_arrow_mirrored>`
  305. The title's icon used when collapsed (for right-to-left layouts).
  306. .. rst-class:: classref-item-separator
  307. ----
  308. .. _class_FoldableContainer_theme_style_focus:
  309. .. rst-class:: classref-themeproperty
  310. :ref:`StyleBox<class_StyleBox>` **focus** :ref:`🔗<class_FoldableContainer_theme_style_focus>`
  311. Background used when **FoldableContainer** has GUI focus. The :ref:`focus<class_FoldableContainer_theme_style_focus>` :ref:`StyleBox<class_StyleBox>` is displayed *over* the base :ref:`StyleBox<class_StyleBox>`, so a partially transparent :ref:`StyleBox<class_StyleBox>` should be used to ensure the base :ref:`StyleBox<class_StyleBox>` remains visible. A :ref:`StyleBox<class_StyleBox>` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
  312. .. rst-class:: classref-item-separator
  313. ----
  314. .. _class_FoldableContainer_theme_style_panel:
  315. .. rst-class:: classref-themeproperty
  316. :ref:`StyleBox<class_StyleBox>` **panel** :ref:`🔗<class_FoldableContainer_theme_style_panel>`
  317. Default background for the **FoldableContainer**.
  318. .. rst-class:: classref-item-separator
  319. ----
  320. .. _class_FoldableContainer_theme_style_title_collapsed_hover_panel:
  321. .. rst-class:: classref-themeproperty
  322. :ref:`StyleBox<class_StyleBox>` **title_collapsed_hover_panel** :ref:`🔗<class_FoldableContainer_theme_style_title_collapsed_hover_panel>`
  323. Background used when the mouse cursor enters the title's area when collapsed.
  324. .. rst-class:: classref-item-separator
  325. ----
  326. .. _class_FoldableContainer_theme_style_title_collapsed_panel:
  327. .. rst-class:: classref-themeproperty
  328. :ref:`StyleBox<class_StyleBox>` **title_collapsed_panel** :ref:`🔗<class_FoldableContainer_theme_style_title_collapsed_panel>`
  329. Default background for the **FoldableContainer**'s title when collapsed.
  330. .. rst-class:: classref-item-separator
  331. ----
  332. .. _class_FoldableContainer_theme_style_title_hover_panel:
  333. .. rst-class:: classref-themeproperty
  334. :ref:`StyleBox<class_StyleBox>` **title_hover_panel** :ref:`🔗<class_FoldableContainer_theme_style_title_hover_panel>`
  335. Background used when the mouse cursor enters the title's area when expanded.
  336. .. rst-class:: classref-item-separator
  337. ----
  338. .. _class_FoldableContainer_theme_style_title_panel:
  339. .. rst-class:: classref-themeproperty
  340. :ref:`StyleBox<class_StyleBox>` **title_panel** :ref:`🔗<class_FoldableContainer_theme_style_title_panel>`
  341. Default background for the **FoldableContainer**'s title when expanded.
  342. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  343. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  344. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  345. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  346. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  347. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  348. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  349. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  350. .. |void| replace:: :abbr:`void (No return value.)`