juce_FlexBox.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{

class JUCE_API  FlexBox  final
{
public:
    enum class Direction
    {
        row,                  
        rowReverse,           
        column,               
        columnReverse         
    };

    enum class Wrap
    {
        noWrap,               
        wrap,                 
        wrapReverse           
    };

    enum class AlignContent
    {
        stretch,              
        flexStart,            
        flexEnd,              
        center,               
        spaceBetween,         
        spaceAround           
    };

    enum class AlignItems
    {
        stretch,              
        flexStart,            
        flexEnd,              
        center                
    };

    enum class JustifyContent
    {
        flexStart,            
        flexEnd,              
        center,               
        spaceBetween,         
        spaceAround           
    };
 
    //==============================================================================
    FlexBox() noexcept = default;

    FlexBox (Direction, Wrap, AlignContent, AlignItems, JustifyContent) noexcept;

    FlexBox (JustifyContent) noexcept;
 
    //==============================================================================
    void performLayout (Rectangle<float> targetArea);

    void performLayout (Rectangle<int> targetArea);
 
    //==============================================================================
    Direction flexDirection = Direction::row;

    Wrap flexWrap = Wrap::noWrap;

    AlignContent alignContent = AlignContent::stretch;

    AlignItems alignItems = AlignItems::stretch;

    JustifyContent justifyContent = JustifyContent::flexStart;

    Array<FlexItem> items;
 
private:
    JUCE_LEAK_DETECTOR (FlexBox)
};
 
} // namespace juce