:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SplitContainer.xml. .. _class_SplitContainer: SplitContainer ============== **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`HSplitContainer`, :ref:`VSplitContainer` Container for splitting and adjusting. .. rst-class:: classref-introduction-group Description ----------- Container for splitting two :ref:`Control`\ s vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`GUI containers <../tutorials/ui/gui_containers>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`collapsed` | ``false`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`DraggerVisibility` | :ref:`dragger_visibility` | ``0`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`split_offset` | ``0`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------+---------------------------------------------------------------------------------------+ | void | :ref:`clamp_split_offset` **(** **)** | +------+---------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_SplitContainer_signal_dragged: .. rst-class:: classref-signal **dragged** **(** :ref:`int` offset **)** Emitted when the dragger is dragged by user. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_SplitContainer_DraggerVisibility: .. rst-class:: classref-enumeration enum **DraggerVisibility**: .. _class_SplitContainer_constant_DRAGGER_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`DraggerVisibility` **DRAGGER_VISIBLE** = ``0`` The split dragger is visible when the cursor hovers it. .. _class_SplitContainer_constant_DRAGGER_HIDDEN: .. rst-class:: classref-enumeration-constant :ref:`DraggerVisibility` **DRAGGER_HIDDEN** = ``1`` The split dragger is never visible. .. _class_SplitContainer_constant_DRAGGER_HIDDEN_COLLAPSED: .. rst-class:: classref-enumeration-constant :ref:`DraggerVisibility` **DRAGGER_HIDDEN_COLLAPSED** = ``2`` The split dragger is never visible and its space collapsed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SplitContainer_property_collapsed: .. rst-class:: classref-property :ref:`bool` **collapsed** = ``false`` .. rst-class:: classref-property-setget - void **set_collapsed** **(** :ref:`bool` value **)** - :ref:`bool` **is_collapsed** **(** **)** If ``true``, the area of the first :ref:`Control` will be collapsed and the dragger will be disabled. .. rst-class:: classref-item-separator ---- .. _class_SplitContainer_property_dragger_visibility: .. rst-class:: classref-property :ref:`DraggerVisibility` **dragger_visibility** = ``0`` .. rst-class:: classref-property-setget - void **set_dragger_visibility** **(** :ref:`DraggerVisibility` value **)** - :ref:`DraggerVisibility` **get_dragger_visibility** **(** **)** Determines the dragger's visibility. See :ref:`DraggerVisibility` for details. .. rst-class:: classref-item-separator ---- .. _class_SplitContainer_property_split_offset: .. rst-class:: classref-property :ref:`int` **split_offset** = ``0`` .. rst-class:: classref-property-setget - void **set_split_offset** **(** :ref:`int` value **)** - :ref:`int` **get_split_offset** **(** **)** The initial offset of the splitting between the two :ref:`Control`\ s, with ``0`` being at the end of the first :ref:`Control`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SplitContainer_method_clamp_split_offset: .. rst-class:: classref-method void **clamp_split_offset** **(** **)** Clamps the :ref:`split_offset` value to not go outside the currently possible minimal and maximum values. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`