BoxContainer.xml 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="BoxContainer" inherits="Container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Base class for box containers.
  5. </brief_description>
  6. <description>
  7. Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes.
  8. </description>
  9. <tutorials>
  10. <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
  11. </tutorials>
  12. <methods>
  13. <method name="add_spacer">
  14. <return type="void" />
  15. <argument index="0" name="begin" type="bool" />
  16. <description>
  17. Adds a control to the box as a spacer. If [code]true[/code], [code]begin[/code] will insert the spacer control in front of other children.
  18. </description>
  19. </method>
  20. </methods>
  21. <members>
  22. <member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode" default="0">
  23. The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]).
  24. </member>
  25. <member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="1" />
  26. </members>
  27. <constants>
  28. <constant name="ALIGN_BEGIN" value="0" enum="AlignMode">
  29. Aligns children with the beginning of the container.
  30. </constant>
  31. <constant name="ALIGN_CENTER" value="1" enum="AlignMode">
  32. Aligns children with the center of the container.
  33. </constant>
  34. <constant name="ALIGN_END" value="2" enum="AlignMode">
  35. Aligns children with the end of the container.
  36. </constant>
  37. </constants>
  38. </class>