juce_DrawableButton.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  DrawableButton  : public Button
{
public:
    //==============================================================================
    enum ButtonStyle
    {
        ImageFitted,                            
        ImageRaw,                               
        ImageAboveTextLabel,                    
        ImageOnButtonBackground,                
        ImageOnButtonBackgroundOriginalSize,    
        ImageStretched                          
    };
 
    //==============================================================================
    DrawableButton (const String& buttonName,
                    ButtonStyle buttonStyle);

    ~DrawableButton() override;
 
    //==============================================================================
    void setImages (const Drawable* normalImage,
                    const Drawable* overImage       = nullptr,
                    const Drawable* downImage       = nullptr,
                    const Drawable* disabledImage   = nullptr,
                    const Drawable* normalImageOn   = nullptr,
                    const Drawable* overImageOn     = nullptr,
                    const Drawable* downImageOn     = nullptr,
                    const Drawable* disabledImageOn = nullptr);
 
 
    //==============================================================================
    void setButtonStyle (ButtonStyle newStyle);

    ButtonStyle getStyle() const noexcept       { return style; }
 
    //==============================================================================
    void setEdgeIndent (int numPixelsIndent);

    int getEdgeIndent() const noexcept          { return edgeIndent; }
 
    //==============================================================================
    Drawable* getCurrentImage() const noexcept;

    Drawable* getNormalImage() const noexcept;
    Drawable* getOverImage() const noexcept;
    Drawable* getDownImage() const noexcept;

    virtual Rectangle<float> getImageBounds() const;
 
    //==============================================================================
    enum ColourIds
    {
        textColourId             = 0x1004010,  
        textColourOnId           = 0x1004013,  
 
        backgroundColourId       = 0x1004011,  
        backgroundOnColourId     = 0x1004012,  
    };
 
    //==============================================================================
    void paintButton (Graphics&, bool, bool) override;
    void buttonStateChanged() override;
    void resized() override;
    void enablementChanged() override;
    void colourChanged() override;
 
private:
    //==============================================================================
    bool shouldDrawButtonBackground() const  { return style == ImageOnButtonBackground || style == ImageOnButtonBackgroundOriginalSize; }
 
    //==============================================================================
    ButtonStyle style;
    std::unique_ptr<Drawable> normalImage, overImage, downImage, disabledImage,
                              normalImageOn, overImageOn, downImageOn, disabledImageOn;
    Drawable* currentImage = nullptr;
    int edgeIndent = 3;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (DrawableButton)
};
 
} // namespace juce