godot/doc/classes/Container.xml
Chris verBurg e7329c0cfc Link to Container tutorial
Users happening across any of the Container pages may not already know the intent of Containers, or which others are available.  This commit adds a link to the existing "GUI containers" page in their tutorials sections.

(cherry picked from commit 3b941ed98c)
2022-05-05 13:44:17 +02:00

42 lines
1.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Container" inherits="Control" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<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>
<link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
</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>
<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>