SplitContainer

Inherits: Container < Control < CanvasItem < Node < Object

Inherited By: HSplitContainer, VSplitContainer

Container for splitting and adjusting.

Description

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

Methods

void clamp_split_offset ( )

Signals

  • dragged ( int offset )

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 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 DraggerVisibility for details.


  • int split_offset
Default 0
Setter set_split_offset(value)
Getter get_split_offset()

The initial offset of the splitting between the two Controls, with 0 being at the end of the first Control.

Method Descriptions

  • void clamp_split_offset ( )

Clamps the split_offset value to not go outside the currently possible minimal and maximum values.