juce_SidePanel.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 SidePanel    : public Component,
                     private ComponentListener,
                     private ChangeListener
{
public:
    //==============================================================================
    SidePanel (StringRef title, int width, bool positionOnLeft,
               Component* contentComponent = nullptr,
               bool deleteComponentWhenNoLongerNeeded = true);

    ~SidePanel() override;
 
    //==============================================================================
    void setContent (Component* newContentComponent,
                     bool deleteComponentWhenNoLongerNeeded = true);

    Component* getContent() const noexcept    { return contentComponent.get(); }

    void setTitleBarComponent (Component* titleBarComponentToUse,
                               bool keepDismissButton,
                               bool deleteComponentWhenNoLongerNeeded = true);

    Component* getTitleBarComponent() const noexcept    { return titleBarComponent.get(); }

    void showOrHide (bool show);
 
    //==============================================================================
    bool isPanelShowing() const noexcept               { return isShowing; }

    bool isPanelOnLeft() const noexcept                { return isOnLeft; }

    void setShadowWidth (int newWidth) noexcept        { shadowWidth = newWidth; }

    int getShadowWidth() const noexcept                { return shadowWidth; }

    void setTitleBarHeight (int newHeight) noexcept    { titleBarHeight = newHeight; }

    int getTitleBarHeight() const noexcept             { return titleBarHeight; }

    String getTitleText() const noexcept               { return titleLabel.getText(); }
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual Font getSidePanelTitleFont (SidePanel&) = 0;
        virtual Justification getSidePanelTitleJustification (SidePanel&) = 0;
        virtual Path getSidePanelDismissButtonShape (SidePanel&) = 0;
    };

    enum ColourIds
    {
        backgroundColour          = 0x100f001,
        titleTextColour           = 0x100f002,
        shadowBaseColour          = 0x100f003,
        dismissButtonNormalColour = 0x100f004,
        dismissButtonOverColour   = 0x100f005,
        dismissButtonDownColour   = 0x100f006
    };
 
    //==============================================================================
    std::function<void()> onPanelMove;

    std::function<void (bool)> onPanelShowHide;
 
    //==============================================================================
    void moved() override;
    void resized() override;
    void paint (Graphics& g) override;
    void parentHierarchyChanged() override;
    void mouseDrag (const MouseEvent&) override;
    void mouseUp (const MouseEvent&) override;
 
private:
    //==============================================================================
    Component* parent = nullptr;
    OptionalScopedPointer<Component> contentComponent;
    OptionalScopedPointer<Component> titleBarComponent;
 
    Label titleLabel;
    ShapeButton dismissButton { "dismissButton", Colours::lightgrey, Colours::lightgrey, Colours::white };
 
    Rectangle<int> shadowArea;
 
    bool isOnLeft = false;
    bool isShowing = false;
 
    int panelWidth = 0;
    int shadowWidth = 15;
    int titleBarHeight = 40;
 
    Rectangle<int> startingBounds;
    bool shouldResize = false;
    int amountMoved = 0;
 
    bool shouldShowDismissButton = true;
 
    //==============================================================================
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    void lookAndFeelChanged() override;
    void componentMovedOrResized (Component&, bool wasMoved, bool wasResized) override;
    void changeListenerCallback (ChangeBroadcaster*) override;
 
    Rectangle<int> calculateBoundsInParent (Component&) const;
    void calculateAndRemoveShadowBounds (Rectangle<int>& bounds);
 
    bool isMouseEventInThisOrChildren (Component*);
 
    //==============================================================================
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SidePanel)
};
 
} // namespace juce