godot-docs/classes/class_splitcontainer.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the SplitContainer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_SplitContainer:

SplitContainer
==============

**Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`HSplitContainer<class_HSplitContainer>`, :ref:`VSplitContainer<class_VSplitContainer>`

**Category:** Core

Brief Description
-----------------

Container for splitting and adjusting.

Properties
----------

+-----------------------------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>`                                         | :ref:`collapsed<class_SplitContainer_property_collapsed>`                   | false |
+-----------------------------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`DraggerVisibility<enum_SplitContainer_DraggerVisibility>` | :ref:`dragger_visibility<class_SplitContainer_property_dragger_visibility>` | 0     |
+-----------------------------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`int<class_int>`                                           | :ref:`split_offset<class_SplitContainer_property_split_offset>`             | 0     |
+-----------------------------------------------------------------+-----------------------------------------------------------------------------+-------+

Methods
-------

+------+---------------------------------------------------------------------------------------+
| void | :ref:`clamp_split_offset<class_SplitContainer_method_clamp_split_offset>` **(** **)** |
+------+---------------------------------------------------------------------------------------+

Signals
-------

.. _class_SplitContainer_signal_dragged:

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

Emitted when the dragger is dragged by user.

Enumerations
------------

.. _enum_SplitContainer_DraggerVisibility:

.. _class_SplitContainer_constant_DRAGGER_VISIBLE:

.. _class_SplitContainer_constant_DRAGGER_HIDDEN:

.. _class_SplitContainer_constant_DRAGGER_HIDDEN_COLLAPSED:

enum **DraggerVisibility**:

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

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

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

Description
-----------

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

Property Descriptions
---------------------

.. _class_SplitContainer_property_collapsed:

- :ref:`bool<class_bool>` **collapsed**

+-----------+----------------------+
| *Default* | false                |
+-----------+----------------------+
| *Setter*  | set_collapsed(value) |
+-----------+----------------------+
| *Getter*  | is_collapsed()       |
+-----------+----------------------+

.. _class_SplitContainer_property_dragger_visibility:

- :ref:`DraggerVisibility<enum_SplitContainer_DraggerVisibility>` **dragger_visibility**

+-----------+-------------------------------+
| *Default* | 0                             |
+-----------+-------------------------------+
| *Setter*  | set_dragger_visibility(value) |
+-----------+-------------------------------+
| *Getter*  | get_dragger_visibility()      |
+-----------+-------------------------------+

Determines whether the dragger is visible.

.. _class_SplitContainer_property_split_offset:

- :ref:`int<class_int>` **split_offset**

+-----------+-------------------------+
| *Default* | 0                       |
+-----------+-------------------------+
| *Setter*  | set_split_offset(value) |
+-----------+-------------------------+
| *Getter*  | get_split_offset()      |
+-----------+-------------------------+

Method Descriptions
-------------------

.. _class_SplitContainer_method_clamp_split_offset:

- void **clamp_split_offset** **(** **)**