:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxContainer.xml. .. _class_BoxContainer: BoxContainer ============ **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`HBoxContainer`, :ref:`VBoxContainer` A container that arranges its child controls horizontally or vertically. .. rst-class:: classref-introduction-group Description ----------- A container that arranges its child controls horizontally or vertically, rearranging them automatically when their minimum size changes. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Using Containers <../tutorials/ui/gui_containers>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------+---------------------------------------------------------+-----------+ | :ref:`AlignmentMode` | :ref:`alignment` | ``0`` | +-------------------------------------------------------+---------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`vertical` | ``false`` | +-------------------------------------------------------+---------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`add_spacer`\ (\ begin\: :ref:`bool`\ ) | +-------------------------------+------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +-----------------------+-----------------------------------------------------------------+-------+ | :ref:`int` | :ref:`separation` | ``4`` | +-----------------------+-----------------------------------------------------------------+-------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_BoxContainer_AlignmentMode: .. rst-class:: classref-enumeration enum **AlignmentMode**: :ref:`🔗` .. _class_BoxContainer_constant_ALIGNMENT_BEGIN: .. rst-class:: classref-enumeration-constant :ref:`AlignmentMode` **ALIGNMENT_BEGIN** = ``0`` The child controls will be arranged at the beginning of the container, i.e. top if orientation is vertical, left if orientation is horizontal (right for RTL layout). .. _class_BoxContainer_constant_ALIGNMENT_CENTER: .. rst-class:: classref-enumeration-constant :ref:`AlignmentMode` **ALIGNMENT_CENTER** = ``1`` The child controls will be centered in the container. .. _class_BoxContainer_constant_ALIGNMENT_END: .. rst-class:: classref-enumeration-constant :ref:`AlignmentMode` **ALIGNMENT_END** = ``2`` The child controls will be arranged at the end of the container, i.e. bottom if orientation is vertical, right if orientation is horizontal (left for RTL layout). .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_BoxContainer_property_alignment: .. rst-class:: classref-property :ref:`AlignmentMode` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_alignment**\ (\ value\: :ref:`AlignmentMode`\ ) - :ref:`AlignmentMode` **get_alignment**\ (\ ) The alignment of the container's children (must be one of :ref:`ALIGNMENT_BEGIN`, :ref:`ALIGNMENT_CENTER`, or :ref:`ALIGNMENT_END`). .. rst-class:: classref-item-separator ---- .. _class_BoxContainer_property_vertical: .. rst-class:: classref-property :ref:`bool` **vertical** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_vertical**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_vertical**\ (\ ) If ``true``, the **BoxContainer** will arrange its children vertically, rather than horizontally. Can't be changed when using :ref:`HBoxContainer` and :ref:`VBoxContainer`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_BoxContainer_method_add_spacer: .. rst-class:: classref-method :ref:`Control` **add_spacer**\ (\ begin\: :ref:`bool`\ ) :ref:`🔗` Adds a :ref:`Control` node to the box as a spacer. If ``begin`` is ``true``, it will insert the :ref:`Control` node in front of all other children. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_BoxContainer_theme_constant_separation: .. rst-class:: classref-themeproperty :ref:`int` **separation** = ``4`` :ref:`🔗` The space between the **BoxContainer**'s elements, in pixels. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`