BoxContainer.xml 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="BoxContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build">
  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. <demos>
  12. </demos>
  13. <methods>
  14. <method name="add_spacer">
  15. <return type="void">
  16. </return>
  17. <argument index="0" name="begin" type="bool">
  18. </argument>
  19. <description>
  20. Adds a control to the box as a spacer. If [code]true[/code], [i]begin[/i] will insert the spacer control in front of other children.
  21. </description>
  22. </method>
  23. <method name="get_alignment" qualifiers="const">
  24. <return type="int" enum="BoxContainer.AlignMode">
  25. </return>
  26. <description>
  27. Return the alignment of children in the container.
  28. </description>
  29. </method>
  30. <method name="set_alignment">
  31. <return type="void">
  32. </return>
  33. <argument index="0" name="alignment" type="int" enum="BoxContainer.AlignMode">
  34. </argument>
  35. <description>
  36. Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END).
  37. </description>
  38. </method>
  39. </methods>
  40. <members>
  41. <member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode">
  42. The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END).
  43. </member>
  44. </members>
  45. <constants>
  46. <constant name="ALIGN_BEGIN" value="0">
  47. Aligns children with the beginning of the container.
  48. </constant>
  49. <constant name="ALIGN_CENTER" value="1">
  50. Aligns children with the center of the container.
  51. </constant>
  52. <constant name="ALIGN_END" value="2">
  53. Aligns children with the end of the container.
  54. </constant>
  55. </constants>
  56. </class>