A container that splits two child controls horizontally or vertically and provides a grabber for adjusting the split ratio.
A container that accepts only two child controls, then arranges them horizontally or vertically and creates a divisor between them. The divisor can be dragged around to change the size relation between the child controls.
$DOCS_URL/tutorials/ui/gui_containers.html
Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values.
Returns the drag area [Control]. For example, you can move a pre-configured button into the drag area [Control] so that it rides along with the split bar. Try setting the [Button] anchors to [code]center[/code] prior to the [code]reparent()[/code] call. [codeblock] $BarnacleButton.reparent($SplitContainer.get_drag_area_control()) [/codeblock] [b]Note:[/b] The drag area [Control] is drawn over the [SplitContainer]'s children, so [CanvasItem] draw objects called from the [Control] and children added to the [Control] will also appear over the [SplitContainer]'s children. Try setting [member Control.mouse_filter] of custom children to [constant Control.MOUSE_FILTER_IGNORE] to prevent blocking the mouse from dragging if desired. [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash.
- If [code]true[/code], the dragger will be disabled and the children will be sized as if the [member split_offset] was [code]0[/code].
- Highlights the drag area [Rect2] so you can see where it is during development. The drag area is gold if [member dragging_enabled] is [code]true[/code], and red if [code]false[/code].
- Reduces the size of the drag area and split bar [theme_item split_bar_background] at the beginning of the container.
- Reduces the size of the drag area and split bar [theme_item split_bar_background] at the end of the container.
- Shifts the drag area in the axis of the container to prevent the drag area from overlapping the [ScrollBar] or other selectable [Control] of a child node.
- Determines the dragger's visibility. See [enum DraggerVisibility] for details. This property does not determine whether dragging is enabled or not. Use [member dragging_enabled] for that.
- Enables or disables split dragging.
- The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control].
- If [code]true[/code], the [SplitContainer] will arrange its children vertically, rather than horizontally. Can't be changed when using [HSplitContainer] and [VSplitContainer].
Emitted when the user ends dragging.
Emitted when the user starts dragging.
Emitted when the dragger is dragged by user.
The split dragger icon is always visible when [theme_item autohide] is [code]false[/code], otherwise visible only when the cursor hovers it. The size of the grabber icon determines the minimum [theme_item separation]. The dragger icon is automatically hidden if the length of the grabber icon is longer than the split bar.
The split dragger icon is never visible regardless of the value of [theme_item autohide]. The size of the grabber icon determines the minimum [theme_item separation].
The split dragger icon is not visible, and the split bar is collapsed to zero thickness.
Boolean value. If [code]1[/code] ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If [code]0[/code] ([code]false[/code]), it's always visible. The [member dragger_visibility] must be [constant DRAGGER_VISIBLE].
The minimum thickness of the area users can click on to grab the split bar. This ensures that the split bar can still be dragged if [theme_item separation] or [theme_item h_grabber] / [theme_item v_grabber]'s size is too narrow to easily select.
The split bar thickness, i.e., the gap between the two children of the container. This is overridden by the size of the grabber icon if [member dragger_visibility] is set to [constant DRAGGER_VISIBLE], or [constant DRAGGER_HIDDEN], and [theme_item separation] is smaller than the size of the grabber icon in the same axis. [b]Note:[/b] To obtain [theme_item separation] values less than the size of the grabber icon, for example a [code]1 px[/code] hairline, set [theme_item h_grabber] or [theme_item v_grabber] to a new [ImageTexture], which effectively sets the grabber icon size to [code]0 px[/code].
The icon used for the grabber drawn in the middle area.
The icon used for the grabber drawn in the middle area when [member vertical] is [code]false[/code].
The icon used for the grabber drawn in the middle area when [member vertical] is [code]true[/code].
Determines the background of the split bar if its thickness is greater than zero.