mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 20:29:03 +00:00
Rémi Verschelde
1204e3ea17
To tell potential contributors that they should NOT edit those files but instead should work on the class.xml source of the main Godot repo
90 lines
3.7 KiB
ReStructuredText
90 lines
3.7 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _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.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_split_offset<class_SplitContainer_set_split_offset>` **(** :ref:`int<class_int>` offset **)** |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_split_offset<class_SplitContainer_get_split_offset>` **(** **)** const |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_collapsed<class_SplitContainer_set_collapsed>` **(** :ref:`bool<class_bool>` collapsed **)** |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_collapsed<class_SplitContainer_is_collapsed>` **(** **)** const |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_dragger_visibility<class_SplitContainer_set_dragger_visibility>` **(** :ref:`int<class_int>` mode **)** |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_dragger_visibility<class_SplitContainer_get_dragger_visibility>` **(** **)** const |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
- **dragged** **(** :ref:`int<class_int>` offset **)**
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **DRAGGER_VISIBLE** = **0**
|
|
- **DRAGGER_HIDDEN** = **1**
|
|
- **DRAGGER_HIDDEN_COLLAPSED** = **2**
|
|
|
|
Description
|
|
-----------
|
|
|
|
Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_SplitContainer_set_split_offset:
|
|
|
|
- void **set_split_offset** **(** :ref:`int<class_int>` offset **)**
|
|
|
|
Set the split offset.
|
|
|
|
.. _class_SplitContainer_get_split_offset:
|
|
|
|
- :ref:`int<class_int>` **get_split_offset** **(** **)** const
|
|
|
|
Return the split offset.
|
|
|
|
.. _class_SplitContainer_set_collapsed:
|
|
|
|
- void **set_collapsed** **(** :ref:`bool<class_bool>` collapsed **)**
|
|
|
|
Set if the split must be collapsed.
|
|
|
|
.. _class_SplitContainer_is_collapsed:
|
|
|
|
- :ref:`bool<class_bool>` **is_collapsed** **(** **)** const
|
|
|
|
Return if the split is collapsed.
|
|
|
|
.. _class_SplitContainer_set_dragger_visibility:
|
|
|
|
- void **set_dragger_visibility** **(** :ref:`int<class_int>` mode **)**
|
|
|
|
.. _class_SplitContainer_get_dragger_visibility:
|
|
|
|
- :ref:`int<class_int>` **get_dragger_visibility** **(** **)** const
|
|
|
|
|