juce_Justification.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_JUSTIFICATION_H_INCLUDED
#define JUCE_JUSTIFICATION_H_INCLUDED
 
 
//==============================================================================
class Justification
{
public:
    //==============================================================================
    Justification (int justificationFlags) noexcept   : flags (justificationFlags) {}
 
    Justification (const Justification& other) noexcept   : flags (other.flags) {}
 
    Justification& operator= (const Justification& other) noexcept
    {
        flags = other.flags;
        return *this;
    }
 
    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;
};
 
#endif   // JUCE_JUSTIFICATION_H_INCLUDED