godot/doc/classes/SplitContainer.xml

50 lines
2.0 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name="SplitContainer" inherits="Container" version="4.0">
<brief_description>
Container for splitting and adjusting.
</brief_description>
<description>
Container for splitting two [Control]s vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
</description>
<tutorials>
</tutorials>
<methods>
2018-11-23 00:06:24 +00:00
<method name="clamp_split_offset">
<return type="void" />
2018-11-23 00:06:24 +00:00
<description>
Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values.
2018-11-23 00:06:24 +00:00
</description>
</method>
</methods>
<members>
<member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed" default="false">
If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled.
</member>
<member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility" default="0">
Determines the dragger's visibility. See [enum DraggerVisibility] for details.
</member>
<member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset" default="0">
The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control].
</member>
</members>
<signals>
<signal name="dragged">
<argument index="0" name="offset" type="int" />
<description>
Emitted when the dragger is dragged by user.
</description>
</signal>
</signals>
<constants>
2017-11-24 22:16:30 +00:00
<constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility">
The split dragger is visible when the cursor hovers it.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility">
The split dragger is never visible.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility">
The split dragger is never visible and its space collapsed.
</constant>
</constants>
</class>