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: b51a272459
Branches Tags
godot-docs
/
classes
/
class_splitcontainer.rst

class_splitcontainer.rst 4.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_SplitContainer:
    5. 

  5. 

  6. SplitContainer
    7. 

  7. ==============
    8. 

  8. 

  9. **Inherits:** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Inherited By:** :ref:`HSplitContainer<class_hsplitcontainer>`, :ref:`VSplitContainer<class_vsplitcontainer>`
    12. 

  12. 

  13. **Category:** Core
    14. 

  14. 

  15. Brief Description
    16. 

  16. -----------------
    17. 

  17. 

  18. Container for splitting and adjusting.
    19. 

  19. 

  20. Member Functions
    21. 

  21. ----------------
    22. 

  22. 

  23. +--------------------------+---------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | void                     | :ref:`set_split_offset<class_SplitContainer_set_split_offset>`  **(** :ref:`int<class_int>` offset  **)**           |
    25. 

  25. +--------------------------+---------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`int<class_int>`    | :ref:`get_split_offset<class_SplitContainer_get_split_offset>`  **(** **)** const                                   |
    27. 

  27. +--------------------------+---------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | void                     | :ref:`set_collapsed<class_SplitContainer_set_collapsed>`  **(** :ref:`bool<class_bool>` collapsed  **)**            |
    29. 

  29. +--------------------------+---------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`bool<class_bool>`  | :ref:`is_collapsed<class_SplitContainer_is_collapsed>`  **(** **)** const                                           |
    31. 

  31. +--------------------------+---------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | void                     | :ref:`set_dragger_visibility<class_SplitContainer_set_dragger_visibility>`  **(** :ref:`int<class_int>` mode  **)** |
    33. 

  33. +--------------------------+---------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`int<class_int>`    | :ref:`get_dragger_visibility<class_SplitContainer_get_dragger_visibility>`  **(** **)** const                       |
    35. 

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

  36. 

  37. Signals
    38. 

  38. -------
    39. 

  39. 

  40. -  **dragged**  **(** :ref:`int<class_int>` offset  **)**
    41. 

  41. 

  42. Numeric Constants
    43. 

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

  44. 

  45. - **DRAGGER_VISIBLE** = **0** --- The split dragger is visible.
    46. 

  46. - **DRAGGER_HIDDEN** = **1** --- The split dragger is invisible.
    47. 

  47. - **DRAGGER_HIDDEN_COLLAPSED** = **2** --- The split dragger is invisible and collapsed.
    48. 

  48. 

  49. Description
    50. 

  50. -----------
    51. 

  51. 

  52. Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
    53. 

  53. 

  54. Member Function Description
    55. 

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

  56. 

  57. .. _class_SplitContainer_set_split_offset:
    58. 

  58. 

  59. - void  **set_split_offset**  **(** :ref:`int<class_int>` offset  **)**
    60. 

  60. 

  61. Set the split offset.
    62. 

  62. 

  63. .. _class_SplitContainer_get_split_offset:
    64. 

  64. 

  65. - :ref:`int<class_int>`  **get_split_offset**  **(** **)** const
    66. 

  66. 

  67. Return the split offset.
    68. 

  68. 

  69. .. _class_SplitContainer_set_collapsed:
    70. 

  70. 

  71. - void  **set_collapsed**  **(** :ref:`bool<class_bool>` collapsed  **)**
    72. 

  72. 

  73. Set if the split must be collapsed.
    74. 

  74. 

  75. .. _class_SplitContainer_is_collapsed:
    76. 

  76. 

  77. - :ref:`bool<class_bool>`  **is_collapsed**  **(** **)** const
    78. 

  78. 

  79. Return true if the split is collapsed.
    80. 

  80. 

  81. .. _class_SplitContainer_set_dragger_visibility:
    82. 

  82. 

  83. - void  **set_dragger_visibility**  **(** :ref:`int<class_int>` mode  **)**
    84. 

  84. 

  85. Set visibility of the split dragger(*mode* must be one of :ref:`DRAGGER_VISIBLE<class_dragger_visible>`, :ref:`DRAGGER_HIDDEN<class_dragger_hidden>` or :ref:`DRAGGER_HIDDEN_COLLAPSED<class_dragger_hidden_collapsed>`).
    86. 

  86. 

  87. .. _class_SplitContainer_get_dragger_visibility:
    88. 

  88. 

  89. - :ref:`int<class_int>`  **get_dragger_visibility**  **(** **)** const
    90. 

  90. 

  91. Return visibility of the split dragger(One of :ref:`DRAGGER_VISIBLE<class_dragger_visible>`, :ref:`DRAGGER_HIDDEN<class_dragger_hidden>` or :ref:`DRAGGER_HIDDEN_COLLAPSED<class_dragger_hidden_collapsed>`).
    92. 

  92. 

  93.