juce_GridItem.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  GridItem
{
public:
    enum class Keyword { autoValue };
 
    //==============================================================================
    struct Span
    {
        explicit Span (int numberToUse) noexcept : number (numberToUse)
        {
            /* Span must be at least one and positive */
            jassert (numberToUse > 0);
        }
 
        explicit Span (int numberToUse, const String& nameToUse) : Span (numberToUse)
        {
            /* Name must not be empty */
            jassert (nameToUse.isNotEmpty());
            name = nameToUse;
        }
 
        explicit Span (const String& nameToUse) : name (nameToUse)
        {
            /* Name must not be empty */
            jassert (nameToUse.isNotEmpty());
        }
 
        int number = 1;
        String name;
    };
 
    //==============================================================================
    struct Property
    {
        Property() noexcept;
 
        Property (Keyword keyword) noexcept;
 
        Property (const char* lineNameToUse) noexcept;
 
        Property (const String& lineNameToUse) noexcept;
 
        Property (int numberToUse) noexcept;
 
        Property (int numberToUse, const String& lineNameToUse) noexcept;
 
        Property (Span spanToUse) noexcept;
 
        bool hasSpan() const noexcept          { return isSpan && ! isAuto; }
        bool hasAbsolute() const noexcept      { return ! (isSpan || isAuto);  }
        bool hasAuto() const noexcept          { return isAuto; }
        bool hasName() const noexcept          { return name.isNotEmpty(); }
        const String& getName() const noexcept { return name; }
        int getNumber() const noexcept         { return number; }
 
    private:
        String name;
        int number = 1; 
        bool isSpan = false;
        bool isAuto = false;
    };
 
    //==============================================================================
    struct StartAndEndProperty { Property start, end; };
 
    //==============================================================================
    enum class JustifySelf : int
    {
        start = 0,               
        end,                     
        center,                  
        stretch,                 
        autoValue                
    };

    enum class AlignSelf   : int
    {
        start = 0,               
        end,                     
        center,                  
        stretch,                 
        autoValue                
    };

    GridItem() noexcept;
    GridItem (Component& componentToUse) noexcept;
    GridItem (Component* componentToUse) noexcept;
 
    //==============================================================================
    Component* associatedComponent = nullptr;
 
    //==============================================================================
    int order = 0;

    JustifySelf  justifySelf = JustifySelf::autoValue;

    AlignSelf    alignSelf   = AlignSelf::autoValue;

    StartAndEndProperty column = { Keyword::autoValue, Keyword::autoValue };

    StartAndEndProperty row    = { Keyword::autoValue, Keyword::autoValue };

    String area;
 
    //==============================================================================
    enum
    {
        useDefaultValue = -2, /* TODO: useDefaultValue should be named useAuto */
        notAssigned = -1
    };
 
    /* TODO: move all of this into a common class that is shared with the FlexItem */
    float width    = notAssigned;
    float minWidth = 0.0f;
    float maxWidth = notAssigned;
 
    float height    = notAssigned;
    float minHeight = 0.0f;
    float maxHeight = notAssigned;

    struct Margin
    {
        Margin() noexcept;
        Margin (int size) 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;

    Rectangle<float> currentBounds;

    void setArea (Property rowStart, Property columnStart, Property rowEnd, Property columnEnd);

    void setArea (Property rowStart, Property columnStart);

    void setArea (const String& areaName);

    GridItem withArea (Property rowStart, Property columnStart, Property rowEnd, Property columnEnd) const noexcept;

    GridItem withArea (Property rowStart, Property columnStart) const noexcept;

    GridItem withArea (const String& areaName)  const noexcept;

    GridItem withRow (StartAndEndProperty row) const noexcept;

    GridItem withColumn (StartAndEndProperty column) const noexcept;

    GridItem withAlignSelf (AlignSelf newAlignSelf) const noexcept;

    GridItem withJustifySelf (JustifySelf newJustifySelf) const noexcept;

    GridItem withWidth (float newWidth) const noexcept;

    GridItem withHeight (float newHeight) const noexcept;

    GridItem withSize (float newWidth, float newHeight) const noexcept;

    GridItem withMargin (Margin newMargin) const noexcept;

    GridItem withOrder (int newOrder) const noexcept;
};
 
} // namespace juce