class_splitcontainer.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the SplitContainer.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_SplitContainer:
  5. SplitContainer
  6. ==============
  7. **Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Inherited By:** :ref:`HSplitContainer<class_HSplitContainer>`, :ref:`VSplitContainer<class_VSplitContainer>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Container for splitting and adjusting.
  13. Properties
  14. ----------
  15. +-----------------------------------------------------------------+--------------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`collapsed<class_SplitContainer_collapsed>` |
  17. +-----------------------------------------------------------------+--------------------------------------------------------------------+
  18. | :ref:`DraggerVisibility<enum_SplitContainer_DraggerVisibility>` | :ref:`dragger_visibility<class_SplitContainer_dragger_visibility>` |
  19. +-----------------------------------------------------------------+--------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`split_offset<class_SplitContainer_split_offset>` |
  21. +-----------------------------------------------------------------+--------------------------------------------------------------------+
  22. Methods
  23. -------
  24. +-------+--------------------------------------------------------------------------------+
  25. | void | :ref:`clamp_split_offset<class_SplitContainer_clamp_split_offset>` **(** **)** |
  26. +-------+--------------------------------------------------------------------------------+
  27. Signals
  28. -------
  29. .. _class_SplitContainer_dragged:
  30. - **dragged** **(** :ref:`int<class_int>` offset **)**
  31. Emitted when the dragger is dragged by user.
  32. Enumerations
  33. ------------
  34. .. _enum_SplitContainer_DraggerVisibility:
  35. enum **DraggerVisibility**:
  36. - **DRAGGER_VISIBLE** = **0** --- The split dragger is visible.
  37. - **DRAGGER_HIDDEN** = **1** --- The split dragger is invisible.
  38. - **DRAGGER_HIDDEN_COLLAPSED** = **2** --- The split dragger is invisible and collapsed.
  39. Description
  40. -----------
  41. Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
  42. Property Descriptions
  43. ---------------------
  44. .. _class_SplitContainer_collapsed:
  45. - :ref:`bool<class_bool>` **collapsed**
  46. +----------+----------------------+
  47. | *Setter* | set_collapsed(value) |
  48. +----------+----------------------+
  49. | *Getter* | is_collapsed() |
  50. +----------+----------------------+
  51. .. _class_SplitContainer_dragger_visibility:
  52. - :ref:`DraggerVisibility<enum_SplitContainer_DraggerVisibility>` **dragger_visibility**
  53. +----------+-------------------------------+
  54. | *Setter* | set_dragger_visibility(value) |
  55. +----------+-------------------------------+
  56. | *Getter* | get_dragger_visibility() |
  57. +----------+-------------------------------+
  58. Determines whether the dragger is visible.
  59. .. _class_SplitContainer_split_offset:
  60. - :ref:`int<class_int>` **split_offset**
  61. +----------+-------------------------+
  62. | *Setter* | set_split_offset(value) |
  63. +----------+-------------------------+
  64. | *Getter* | get_split_offset() |
  65. +----------+-------------------------+
  66. Method Descriptions
  67. -------------------
  68. .. _class_SplitContainer_clamp_split_offset:
  69. - void **clamp_split_offset** **(** **)**