: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/FlowContainer.xml. .. _class_FlowContainer: FlowContainer ============= **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`HFlowContainer`, :ref:`VFlowContainer` A container that arranges its child controls horizontally or vertically and wraps them around at the borders. .. rst-class:: classref-introduction-group Description ----------- A container that arranges its child controls horizontally or vertically and wraps them around at the borders. This is similar to how text in a book wraps around when no more words can fit on a line. .. 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:`LastWrapAlignmentMode` | :ref:`last_wrap_alignment` | ``0`` | +------------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`reverse_fill` | ``false`` | +------------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`vertical` | ``false`` | +------------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------+--------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | +-----------------------+--------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +-----------------------+----------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`h_separation` | ``4`` | +-----------------------+----------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`v_separation` | ``4`` | +-----------------------+----------------------------------------------------------------------+-------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_FlowContainer_AlignmentMode: .. rst-class:: classref-enumeration enum **AlignmentMode**: :ref:`🔗` .. _class_FlowContainer_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_FlowContainer_constant_ALIGNMENT_CENTER: .. rst-class:: classref-enumeration-constant :ref:`AlignmentMode` **ALIGNMENT_CENTER** = ``1`` The child controls will be centered in the container. .. _class_FlowContainer_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-item-separator ---- .. _enum_FlowContainer_LastWrapAlignmentMode: .. rst-class:: classref-enumeration enum **LastWrapAlignmentMode**: :ref:`🔗` .. _class_FlowContainer_constant_LAST_WRAP_ALIGNMENT_INHERIT: .. rst-class:: classref-enumeration-constant :ref:`LastWrapAlignmentMode` **LAST_WRAP_ALIGNMENT_INHERIT** = ``0`` The last partially filled row or column will wrap aligned to the previous row or column in accordance with :ref:`alignment`. .. _class_FlowContainer_constant_LAST_WRAP_ALIGNMENT_BEGIN: .. rst-class:: classref-enumeration-constant :ref:`LastWrapAlignmentMode` **LAST_WRAP_ALIGNMENT_BEGIN** = ``1`` The last partially filled row or column will wrap aligned to the beginning of the previous row or column. .. _class_FlowContainer_constant_LAST_WRAP_ALIGNMENT_CENTER: .. rst-class:: classref-enumeration-constant :ref:`LastWrapAlignmentMode` **LAST_WRAP_ALIGNMENT_CENTER** = ``2`` The last partially filled row or column will wrap aligned to the center of the previous row or column. .. _class_FlowContainer_constant_LAST_WRAP_ALIGNMENT_END: .. rst-class:: classref-enumeration-constant :ref:`LastWrapAlignmentMode` **LAST_WRAP_ALIGNMENT_END** = ``3`` The last partially filled row or column will wrap aligned to the end of the previous row or column. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_FlowContainer_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_FlowContainer_property_last_wrap_alignment: .. rst-class:: classref-property :ref:`LastWrapAlignmentMode` **last_wrap_alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_last_wrap_alignment**\ (\ value\: :ref:`LastWrapAlignmentMode`\ ) - :ref:`LastWrapAlignmentMode` **get_last_wrap_alignment**\ (\ ) The wrap behavior of the last, partially filled row or column (must be one of :ref:`LAST_WRAP_ALIGNMENT_INHERIT`, :ref:`LAST_WRAP_ALIGNMENT_BEGIN`, :ref:`LAST_WRAP_ALIGNMENT_CENTER`, or :ref:`LAST_WRAP_ALIGNMENT_END`). .. rst-class:: classref-item-separator ---- .. _class_FlowContainer_property_reverse_fill: .. rst-class:: classref-property :ref:`bool` **reverse_fill** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_reverse_fill**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_reverse_fill**\ (\ ) If ``true``, reverses fill direction. Horizontal **FlowContainer**\ s will fill rows bottom to top, vertical **FlowContainer**\ s will fill columns right to left. When using a vertical **FlowContainer** with a right to left :ref:`Control.layout_direction`, columns will fill left to right instead. .. rst-class:: classref-item-separator ---- .. _class_FlowContainer_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 **FlowContainer** will arrange its children vertically, rather than horizontally. Can't be changed when using :ref:`HFlowContainer` and :ref:`VFlowContainer`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_FlowContainer_method_get_line_count: .. rst-class:: classref-method :ref:`int` **get_line_count**\ (\ ) |const| :ref:`🔗` Returns the current line count. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_FlowContainer_theme_constant_h_separation: .. rst-class:: classref-themeproperty :ref:`int` **h_separation** = ``4`` :ref:`🔗` The horizontal separation of child nodes. .. rst-class:: classref-item-separator ---- .. _class_FlowContainer_theme_constant_v_separation: .. rst-class:: classref-themeproperty :ref:`int` **v_separation** = ``4`` :ref:`🔗` The vertical separation of child nodes. .. |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.)`