7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
44 lines
1.4 KiB
XML
44 lines
1.4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Container" inherits="Control" version="4.0">
|
|
<brief_description>
|
|
Base node for containers.
|
|
</brief_description>
|
|
<description>
|
|
Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way.
|
|
A Control can inherit this to create custom container classes.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="fit_child_in_rect">
|
|
<return type="void" />
|
|
<argument index="0" name="child" type="Control" />
|
|
<argument index="1" name="rect" type="Rect2" />
|
|
<description>
|
|
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
|
|
</description>
|
|
</method>
|
|
<method name="queue_sort">
|
|
<return type="void" />
|
|
<description>
|
|
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" override="true" enum="Control.MouseFilter" default="1" />
|
|
</members>
|
|
<signals>
|
|
<signal name="sort_children">
|
|
<description>
|
|
Emitted when sorting the children is needed.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
<constant name="NOTIFICATION_SORT_CHILDREN" value="50">
|
|
Notification for when sorting the children, it must be obeyed immediately.
|
|
</constant>
|
|
</constants>
|
|
</class>
|