Welcome to the Godot Reference Fork and the Godot Proposals Fork alternatives. Why?

SplitContainer

0 0 vote
Article Rating

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

voidclamp_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

Defaultfalse
Setterset_collapsed(value)
Getteris_collapsed()

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


Default0
Setterset_dragger_visibility(value)
Getterget_dragger_visibility()

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


  • int split_offset
Default0
Setterset_split_offset(value)
Getterget_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.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x