juce_FlexItem.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  FlexItem  final
{
public:
    //==============================================================================
    FlexItem() noexcept;

    FlexItem (float width, float height) noexcept;

    FlexItem (float width, float height, Component& targetComponent) noexcept;

    FlexItem (float width, float height, FlexBox& flexBoxToControl) noexcept;

    FlexItem (Component& componentToControl) noexcept;

    FlexItem (FlexBox& flexBoxToControl) noexcept;
 
    //==============================================================================
    Rectangle<float> currentBounds;

    Component* associatedComponent = nullptr;

    FlexBox* associatedFlexBox = nullptr;

    int order = 0;

    float flexGrow = 0.0f;

    float flexShrink = 1.0f;

    float flexBasis = 0.0f;

    enum class AlignSelf
    {
        autoAlign,       
        flexStart,       
        flexEnd,         
        center,          
        stretch          
    };

    AlignSelf alignSelf = AlignSelf::autoAlign;
 
    //==============================================================================
    static const int autoValue    = -2;
    static const int notAssigned  = -1;
 
    float width     = (float) notAssigned;  
    float minWidth  = 0.0f;                 
    float maxWidth  = (float) notAssigned;  
 
    float height    = (float) notAssigned;  
    float minHeight = 0.0f;                 
    float maxHeight = (float) notAssigned;  

    struct Margin  final
    {
        Margin() noexcept;              
        Margin (float size) noexcept;   
        Margin (float top, float right, float bottom, float left) noexcept;   
 
        float left;   
        float right;  
        float top;    
        float bottom; 
    };

    Margin margin;
 
    //==============================================================================
    FlexItem withFlex (float newFlexGrow) const noexcept;

    FlexItem withFlex (float newFlexGrow, float newFlexShrink) const noexcept;

    FlexItem withFlex (float newFlexGrow, float newFlexShrink, float newFlexBasis) const noexcept;

    FlexItem withWidth (float newWidth) const noexcept;

    FlexItem withMinWidth (float newMinWidth) const noexcept;

    FlexItem withMaxWidth (float newMaxWidth) const noexcept;

    FlexItem withHeight (float newHeight) const noexcept;

    FlexItem withMinHeight (float newMinHeight) const noexcept;

    FlexItem withMaxHeight (float newMaxHeight) const noexcept;

    FlexItem withMargin (Margin) const noexcept;

    FlexItem withOrder (int newOrder) const noexcept;

    FlexItem withAlignSelf (AlignSelf newAlignSelf) const noexcept;
};
 
} // namespace juce