| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the BoxContainer.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_BoxContainer:
- BoxContainer
- ============
- **Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`ColorPicker<class_ColorPicker>`, :ref:`HBoxContainer<class_HBoxContainer>`, :ref:`VBoxContainer<class_VBoxContainer>`
- Base class for box containers.
- Description
- -----------
- Arranges child :ref:`Control<class_Control>` nodes vertically or horizontally, and rearranges them automatically when their minimum size changes.
- Properties
- ----------
- +-----------------------------------------------+---------------------------------------------------------+-------+
- | :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` | ``0`` |
- +-----------------------------------------------+---------------------------------------------------------+-------+
- Methods
- -------
- +------+---------------------------------------------------------------------------------------------------+
- | void | :ref:`add_spacer<class_BoxContainer_method_add_spacer>` **(** :ref:`bool<class_bool>` begin **)** |
- +------+---------------------------------------------------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_BoxContainer_AlignMode:
- .. _class_BoxContainer_constant_ALIGN_BEGIN:
- .. _class_BoxContainer_constant_ALIGN_CENTER:
- .. _class_BoxContainer_constant_ALIGN_END:
- enum **AlignMode**:
- - **ALIGN_BEGIN** = **0** --- Aligns children with the beginning of the container.
- - **ALIGN_CENTER** = **1** --- Aligns children with the center of the container.
- - **ALIGN_END** = **2** --- Aligns children with the end of the container.
- Property Descriptions
- ---------------------
- .. _class_BoxContainer_property_alignment:
- - :ref:`AlignMode<enum_BoxContainer_AlignMode>` **alignment**
- +-----------+----------------------+
- | *Default* | ``0`` |
- +-----------+----------------------+
- | *Setter* | set_alignment(value) |
- +-----------+----------------------+
- | *Getter* | get_alignment() |
- +-----------+----------------------+
- The alignment of the container's children (must be one of :ref:`ALIGN_BEGIN<class_BoxContainer_constant_ALIGN_BEGIN>`, :ref:`ALIGN_CENTER<class_BoxContainer_constant_ALIGN_CENTER>`, or :ref:`ALIGN_END<class_BoxContainer_constant_ALIGN_END>`).
- Method Descriptions
- -------------------
- .. _class_BoxContainer_method_add_spacer:
- - void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**
- Adds a :ref:`Control<class_Control>` node to the box as a spacer. If ``begin`` is ``true``, it will insert the :ref:`Control<class_Control>` node in front of all other children.
|
