juce_ProgressBar.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  ProgressBar  : public Component,
                               public SettableTooltipClient,
                               private Timer
{
public:
    enum class Style
    {
        linear,     
        circular,   
    };
 
    //==============================================================================
    explicit ProgressBar (double& progress);
 
    ProgressBar (double& progress, std::optional<Style> style);
 
    ~ProgressBar() override = default;
 
    //==============================================================================
    void setPercentageDisplay (bool shouldDisplayPercentage);
 
    void setTextToDisplay (const String& text);
 
    void setStyle (std::optional<Style> newStyle);
 
    std::optional<Style> getStyle() const { return style; }
 
    Style getResolvedStyle() const;
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId              = 0x1001900,    
        foregroundColourId              = 0x1001a00,    
    };
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual void drawProgressBar (Graphics&, ProgressBar&, int width, int height,
                                      double progress, const String& textToShow) = 0;
 
        virtual bool isProgressBarOpaque (ProgressBar&) = 0;
 
        virtual Style getDefaultProgressBarStyle (const ProgressBar&) = 0;
    };
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
 
protected:
    //==============================================================================
    void paint (Graphics&) override;
    void lookAndFeelChanged() override;
    void visibilityChanged() override;
    void colourChanged() override;
 
private:
    double& progress;
    std::optional<Style> style;
    double currentValue { jlimit (0.0, 1.0, progress) };
    bool displayPercentage { true };
    String displayedMessage, currentMessage;
    uint32 lastCallbackTime { 0 };
 
    void timerCallback() override;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ProgressBar)
};
 
} // namespace juce