class_splitcontainer.rst

SplitContainer

Inherits: Container<class_container> < Control<class_control> < CanvasItem<class_canvasitem> < Node<class_node> < Object<class_object>

Inherited By: HSplitContainer<class_hsplitcontainer>, VSplitContainer<class_vsplitcontainer>

Category: Core

Brief Description

Container for splitting and adjusting.

Member Functions

int<class_int>	get_dragger_visibility<class_SplitContainer_get_dragger_visibility> ( ) const
int<class_int>	get_split_offset<class_SplitContainer_get_split_offset> ( ) const
bool<class_bool>	is_collapsed<class_SplitContainer_is_collapsed> ( ) const
void	set_collapsed<class_SplitContainer_set_collapsed> ( bool<class_bool> collapsed )
void	set_dragger_visibility<class_SplitContainer_set_dragger_visibility> ( int<class_int> mode )
void	set_split_offset<class_SplitContainer_set_split_offset> ( int<class_int> offset )

Signals

- dragged ( int<class_int> offset ) Emmited when the dragger is gragged by user.

Numeric Constants

• DRAGGER_VISIBLE = 0 --- The split dragger is visible.
• DRAGGER_HIDDEN = 1 --- The split dragger is invisible.
• DRAGGER_HIDDEN_COLLAPSED = 2 --- The split dragger is invisible and collapsed.

Description

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

Member Function Description

• int<class_int> get_dragger_visibility ( ) const

Return visibility of the split dragger(One of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED).

• int<class_int> get_split_offset ( ) const

Return the split offset.

• bool<class_bool> is_collapsed ( ) const

Return true if the split is collapsed.

• void set_collapsed ( bool<class_bool> collapsed )

Set if the split must be collapsed.

• void set_dragger_visibility ( int<class_int> mode )

Set visibility of the split dragger(mode must be one of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED).

• void set_split_offset ( int<class_int> offset )

Set the split offset.