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.

Tutorials

Properties

bool

collapsed

false

DraggerVisibility

dragger_visibility

0

int

split_offset

0

Methods

void

clamp_split_offset ( )

Signals

dragged ( int offset )

Emitted when the dragger is dragged by user.

Enumerations

enum DraggerVisibility:

DraggerVisibility DRAGGER_VISIBLE = 0

The split dragger is visible when the cursor hovers it.

DraggerVisibility DRAGGER_HIDDEN = 1

The split dragger is never visible.

DraggerVisibility DRAGGER_HIDDEN_COLLAPSED = 2

The split dragger is never visible and its space collapsed.

Property Descriptions

bool collapsed = false

  • void set_collapsed ( bool value )

  • bool is_collapsed ( )

If true, the area of the first Control will be collapsed and the dragger will be disabled.

DraggerVisibility dragger_visibility = 0

Determines the dragger's visibility. See DraggerVisibility for details.

int split_offset = 0

  • void set_split_offset ( int value )

  • int 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.