class_splitcontainer.rst 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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. Signals
  14. -------
  15. .. _class_SplitContainer_dragged:
  16. - **dragged** **(** :ref:`int<class_int>` offset **)**
  17. Emitted when the dragger is dragged by user.
  18. Member Variables
  19. ----------------
  20. .. _class_SplitContainer_collapsed:
  21. - :ref:`bool<class_bool>` **collapsed**
  22. .. _class_SplitContainer_dragger_visibility:
  23. - :ref:`DraggerVisibility<enum_splitcontainer_draggervisibility>` **dragger_visibility** - Determines whether the dragger is visible.
  24. .. _class_SplitContainer_split_offset:
  25. - :ref:`int<class_int>` **split_offset**
  26. Enums
  27. -----
  28. .. _enum_SplitContainer_DraggerVisibility:
  29. enum **DraggerVisibility**
  30. - **DRAGGER_VISIBLE** = **0** --- The split dragger is visible.
  31. - **DRAGGER_HIDDEN** = **1** --- The split dragger is invisible.
  32. - **DRAGGER_HIDDEN_COLLAPSED** = **2** --- The split dragger is invisible and collapsed.
  33. Description
  34. -----------
  35. Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.