juce_Justification.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 Justification
{
public:
    //==============================================================================
    Justification (int justificationFlags) noexcept   : flags (justificationFlags) {}

    Justification (const Justification&) = default;

    Justification& operator= (const Justification&) = default;
 
    bool operator== (const Justification& other) const noexcept     { return flags == other.flags; }
    bool operator!= (const Justification& other) const noexcept     { return flags != other.flags; }
 
    //==============================================================================
    inline int getFlags() const noexcept                        { return flags; }

    inline bool testFlags (int flagsToTest) const noexcept      { return (flags & flagsToTest) != 0; }

    int getOnlyVerticalFlags() const noexcept                   { return flags & (top | bottom | verticallyCentred); }

    int getOnlyHorizontalFlags() const noexcept                 { return flags & (left | right | horizontallyCentred | horizontallyJustified); }
 
    //==============================================================================
    template <typename ValueType>
    void applyToRectangle (ValueType& x, ValueType& y, ValueType w, ValueType h,
                           ValueType spaceX, ValueType spaceY, ValueType spaceW, ValueType spaceH) const noexcept
    {
        x = spaceX;
        if ((flags & horizontallyCentred) != 0)     x += (spaceW - w) / (ValueType) 2;
        else if ((flags & right) != 0)              x += spaceW - w;
 
        y = spaceY;
        if ((flags & verticallyCentred) != 0)       y += (spaceH - h) / (ValueType) 2;
        else if ((flags & bottom) != 0)             y += spaceH - h;
    }

    template <typename ValueType>
    const Rectangle<ValueType> appliedToRectangle (const Rectangle<ValueType>& areaToAdjust,
                                                   const Rectangle<ValueType>& targetSpace) const noexcept
    {
        ValueType x = areaToAdjust.getX(), y = areaToAdjust.getY();
        applyToRectangle (x, y, areaToAdjust.getWidth(), areaToAdjust.getHeight(),
                          targetSpace.getX(), targetSpace.getY(), targetSpace.getWidth(), targetSpace.getHeight());
        return areaToAdjust.withPosition (x, y);
    }
 
    //==============================================================================
    enum Flags
    {
        //==============================================================================
        left                            = 1,

        right                           = 2,

        horizontallyCentred             = 4,
 
        //==============================================================================
        top                             = 8,

        bottom                          = 16,

        verticallyCentred               = 32,
 
        //==============================================================================
        horizontallyJustified           = 64,
 
        //==============================================================================
        centred                         = 36,

        centredLeft                     = 33,

        centredRight                    = 34,

        centredTop                      = 12,

        centredBottom                   = 20,

        topLeft                         = 9,

        topRight                        = 10,

        bottomLeft                      = 17,

        bottomRight                     = 18
    };
 
 
private:
    //==============================================================================
    int flags;
};
 
} // namespace juce