| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182 |
- .. 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>`
- **Category:** Core
- Brief Description
- -----------------
- Base class for box containers.
- Properties
- ----------
- +-----------------------------------------------+---------------------------------------------------------+
- | :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` |
- +-----------------------------------------------+---------------------------------------------------------+
- 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.
- Description
- -----------
- Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes.
- Property Descriptions
- ---------------------
- .. _class_BoxContainer_property_alignment:
- - :ref:`AlignMode<enum_BoxContainer_AlignMode>` **alignment**
- +----------+----------------------+
- | *Setter* | set_alignment(value) |
- +----------+----------------------+
- | *Getter* | get_alignment() |
- +----------+----------------------+
- The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END).
- Method Descriptions
- -------------------
- .. _class_BoxContainer_method_add_spacer:
- - void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**
- Adds a control to the box as a spacer. If ``true``, *begin* will insert the spacer control in front of other children.
|
