BoxContainer.xml 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="BoxContainer" inherits="Container" version="3.4">
  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. </tutorials>
  11. <methods>
  12. <method name="add_spacer">
  13. <return type="void" />
  14. <argument index="0" name="begin" type="bool" />
  15. <description>
  16. 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.
  17. </description>
  18. </method>
  19. </methods>
  20. <members>
  21. <member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode" default="0">
  22. The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]).
  23. </member>
  24. <member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" override="true" enum="Control.MouseFilter" default="1" />
  25. </members>
  26. <constants>
  27. <constant name="ALIGN_BEGIN" value="0" enum="AlignMode">
  28. Aligns children with the beginning of the container.
  29. </constant>
  30. <constant name="ALIGN_CENTER" value="1" enum="AlignMode">
  31. Aligns children with the center of the container.
  32. </constant>
  33. <constant name="ALIGN_END" value="2" enum="AlignMode">
  34. Aligns children with the end of the container.
  35. </constant>
  36. </constants>
  37. </class>