juce_ResizableWindow.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  ResizableWindow  : public TopLevelWindow
{
public:
    //==============================================================================
    ResizableWindow (const String& name,
                     bool addToDesktop);

    ResizableWindow (const String& name,
                     Colour backgroundColour,
                     bool addToDesktop);

    ~ResizableWindow() override;
 
    //==============================================================================
    Colour getBackgroundColour() const noexcept;

    void setBackgroundColour (Colour newColour);
 
    //==============================================================================
    void setResizable (bool shouldBeResizable,
                       bool useBottomRightCornerResizer);

    bool isResizable() const noexcept;

    void setResizeLimits (int newMinimumWidth,
                          int newMinimumHeight,
                          int newMaximumWidth,
                          int newMaximumHeight) noexcept;

    void setDraggable (bool shouldBeDraggable) noexcept;

    bool isDraggable() const noexcept                               { return canDrag; }

    ComponentBoundsConstrainer* getConstrainer() noexcept           { return constrainer; }

    void setConstrainer (ComponentBoundsConstrainer* newConstrainer);

    void setBoundsConstrained (const Rectangle<int>& newBounds);
 
 
    //==============================================================================
    bool isFullScreen() const;

    void setFullScreen (bool shouldBeFullScreen);

    bool isMinimised() const;

    void setMinimised (bool shouldMinimise);

    bool isKioskMode() const;
 
    //==============================================================================
    String getWindowStateAsString();

    bool restoreWindowStateFromString (const String& previousState);
 
 
    //==============================================================================
    Component* getContentComponent() const noexcept                 { return contentComponent; }

    void setContentOwned (Component* newContentComponent,
                          bool resizeToFitWhenContentChangesSize);

    void setContentNonOwned (Component* newContentComponent,
                             bool resizeToFitWhenContentChangesSize);

    void clearContentComponent();

    void setContentComponentSize (int width, int height);

    virtual BorderSize<int> getBorderThickness();

    virtual BorderSize<int> getContentComponentBorder();
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId          = 0x1005700,  
    };
 
    //==============================================================================
   #ifndef DOXYGEN
    [[deprecated ("use setContentOwned and setContentNonOwned instead.")]]
    void setContentComponent (Component* newContentComponent,
                              bool deleteOldOne = true,
                              bool resizeToFit = false);
   #endif
 
    using TopLevelWindow::addToDesktop;
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        //==============================================================================
        virtual void drawCornerResizer (Graphics&, int w, int h, bool isMouseOver, bool isMouseDragging) = 0;
        virtual void drawResizableFrame (Graphics&, int w, int h, const BorderSize<int>&) = 0;
 
        virtual void fillResizableWindowBackground (Graphics&, int w, int h, const BorderSize<int>&, ResizableWindow&) = 0;
        virtual void drawResizableWindowBorder (Graphics&, int w, int h, const BorderSize<int>& border, ResizableWindow&) = 0;
    };
 
protected:
    void paint (Graphics&) override;
    void moved() override;
    void resized() override;
    void mouseDown (const MouseEvent&) override;
    void mouseDrag (const MouseEvent&) override;
    void mouseUp (const MouseEvent&) override;
    void lookAndFeelChanged() override;
    void childBoundsChanged (Component*) override;
    void parentSizeChanged() override;
    void visibilityChanged() override;
    void activeWindowStatusChanged() override;
    int getDesktopWindowStyleFlags() const override;
 
   #if JUCE_DEBUG
    void addChildComponent (Component*, int zOrder = -1);
    void addAndMakeVisible (Component*, int zOrder = -1);
   #endif
 
    std::unique_ptr<ResizableCornerComponent> resizableCorner;
    std::unique_ptr<ResizableBorderComponent> resizableBorder;
 
    //==============================================================================
    // The parameters for these methods have changed - please update your code!
    void getBorderThickness (int& left, int& top, int& right, int& bottom);
    void getContentComponentBorder (int& left, int& top, int& right, int& bottom);
 
private:
    //==============================================================================
    Component::SafePointer<Component> contentComponent;
    bool ownsContentComponent = false, resizeToFitContent = false, fullscreen = false, canDrag = true, dragStarted = false;
    ComponentDragger dragger;
    Rectangle<int> lastNonFullScreenPos;
    ComponentBoundsConstrainer defaultConstrainer;
    ComponentBoundsConstrainer* constrainer = nullptr;
   #if JUCE_DEBUG
    bool hasBeenResized = false;
   #endif
 
    void initialise (bool addToDesktop);
    void updateLastPosIfNotFullScreen();
    void updateLastPosIfShowing();
    void setContent (Component*, bool takeOwnership, bool resizeToFit);
    void updatePeerConstrainer();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ResizableWindow)
};
 
} // namespace juce