juce_ComponentBoundsConstrainer.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  ComponentBoundsConstrainer
{
public:
    //==============================================================================
    ComponentBoundsConstrainer() noexcept;

    virtual ~ComponentBoundsConstrainer();
 
    //==============================================================================
    void setMinimumWidth (int minimumWidth) noexcept;

    int getMinimumWidth() const noexcept                        { return minW; }

    void setMaximumWidth (int maximumWidth) noexcept;

    int getMaximumWidth() const noexcept                        { return maxW; }

    void setMinimumHeight (int minimumHeight) noexcept;

    int getMinimumHeight() const noexcept                       { return minH; }

    void setMaximumHeight (int maximumHeight) noexcept;

    int getMaximumHeight() const noexcept                       { return maxH; }

    void setMinimumSize (int minimumWidth,
                         int minimumHeight) noexcept;

    void setMaximumSize (int maximumWidth,
                         int maximumHeight) noexcept;

    void setSizeLimits (int minimumWidth,
                        int minimumHeight,
                        int maximumWidth,
                        int maximumHeight) noexcept;
 
    //==============================================================================
    void setMinimumOnscreenAmounts (int minimumWhenOffTheTop,
                                    int minimumWhenOffTheLeft,
                                    int minimumWhenOffTheBottom,
                                    int minimumWhenOffTheRight) noexcept;
 

    int getMinimumWhenOffTheTop() const noexcept        { return minOffTop; }
    int getMinimumWhenOffTheLeft() const noexcept       { return minOffLeft; }
    int getMinimumWhenOffTheBottom() const noexcept     { return minOffBottom; }
    int getMinimumWhenOffTheRight() const noexcept      { return minOffRight; }
 
    //==============================================================================
    void setFixedAspectRatio (double widthOverHeight) noexcept;

    double getFixedAspectRatio() const noexcept;
 
 
    //==============================================================================
    virtual void checkBounds (Rectangle<int>& bounds,
                              const Rectangle<int>& previousBounds,
                              const Rectangle<int>& limits,
                              bool isStretchingTop,
                              bool isStretchingLeft,
                              bool isStretchingBottom,
                              bool isStretchingRight);

    virtual void resizeStart();

    virtual void resizeEnd();

    void setBoundsForComponent (Component* component,
                                Rectangle<int> bounds,
                                bool isStretchingTop,
                                bool isStretchingLeft,
                                bool isStretchingBottom,
                                bool isStretchingRight);

    void checkComponentBounds (Component* component);

    virtual void applyBoundsToComponent (Component&, Rectangle<int> bounds);
 
private:
    //==============================================================================
    int minW = 0, maxW = 0x3fffffff, minH = 0, maxH = 0x3fffffff;
    int minOffTop = 0, minOffLeft = 0, minOffBottom = 0, minOffRight = 0;
    double aspectRatio = 0;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ComponentBoundsConstrainer)
};
 
} // namespace juce