Skip to content

Latest commit

 

History

History
126 lines (81 loc) · 4.76 KB

class_splitcontainer.rst

File metadata and controls

126 lines (81 loc) · 4.76 KB
github_url:hide

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>`

Container for splitting and adjusting.

Description

Container for splitting two :ref:`Control<class_Control>`s vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.

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

Emitted when the dragger is dragged by user.

Enumerations

enum DraggerVisibility:

  • DRAGGER_VISIBLE = 0 --- The split dragger is visible when the cursor hovers it.
  • DRAGGER_HIDDEN = 1 --- The split dragger is never visible.
  • DRAGGER_HIDDEN_COLLAPSED = 2 --- The split dragger is never visible and its space collapsed.

Property Descriptions

Default false
Setter set_collapsed(value)
Getter is_collapsed()

If true, the area of the first :ref:`Control<class_Control>` will be collapsed and the dragger will be disabled.


Default 0
Setter set_dragger_visibility(value)
Getter get_dragger_visibility()

Determines the dragger's visibility. See :ref:`DraggerVisibility<enum_SplitContainer_DraggerVisibility>` for details.


Default 0
Setter set_split_offset(value)
Getter get_split_offset()

The initial offset of the splitting between the two :ref:`Control<class_Control>`s, with 0 being at the end of the first :ref:`Control<class_Control>`.

Method Descriptions

  • void clamp_split_offset ( )

Clamps the :ref:`split_offset<class_SplitContainer_property_split_offset>` value to not go outside the currently possible minimal and maximum values.