virtualx-engine/doc/classes/SplitContainer.xml
2019-04-01 12:33:56 +02:00

50 lines
1.6 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SplitContainer" inherits="Container" category="Core" version="3.2">
<brief_description>
Container for splitting and adjusting.
</brief_description>
<description>
Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="clamp_split_offset">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed">
</member>
<member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility">
Determines whether the dragger is visible.
</member>
<member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset">
</member>
</members>
<signals>
<signal name="dragged">
<argument index="0" name="offset" type="int">
</argument>
<description>
Emitted when the dragger is dragged by user.
</description>
</signal>
</signals>
<constants>
<constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility">
The split dragger is visible.
</constant>
<constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility">
The split dragger is invisible.
</constant>
<constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility">
The split dragger is invisible and collapsed.
</constant>
</constants>
</class>