QCustomProgressbar.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: QCustomProgressbar
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/BaseValues.h>
#include <NDEVR/TimeSpan.h>
#include <NDEVR/RGBColor.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/String.h>
#include <QProgressBar>
namespace NDEVR
{
    class TranslatedString;
    class String;
    class NDEVR_WIDGETS_API QCustomProgressBar : public QProgressBar
    {
        Q_OBJECT
    public:
        explicit QCustomProgressBar(QWidget* parent = nullptr);
        virtual ~QCustomProgressBar() override;

        void setProgressColor(RGBColor color);

        void addProgressColor(fltp08 percent, RGBColor color);

        void setProgressColors(const Buffer<RGBColor>& colors);
        void clearProgressColors();

        virtual void setPercent(fltp08 percent);
        [[nodiscard]] fltp08 percent() const;

        [[nodiscard]] bool isIndeterminateState() const;

        void setDrawBackground(bool draw_background);

        virtual void setMessage(const TranslatedString& message);

        void setFormat(const StringView& format);

        virtual void setToIndeterminateState(bool is_indeterminate);

        virtual void setIndeterminateAnimationTimespan(const TimeSpan& span);
    protected:
        [[nodiscard]] QSize sizeHint() const override;
        [[nodiscard]] QSize minimumSizeHint() const override;
        [[nodiscard]] fltp08 indeterminatePercent() const;
        [[nodiscard]] QString customText(fltp04 percent) const;
        void paintEvent(QPaintEvent* event) override;
    protected slots:
        void updateFromTimer();
    protected:
        void updateProgressColor();
    protected:
        String m_last_format = String("0%"); 
        QTimer* m_update_timer; 
        TimeSpan m_indeterminate_period = TimeSpan(1.0); 
        Buffer<std::pair<fltp08, RGBColor>> m_progress_colors; 
        QString m_last_text; 
        bool m_draw_background; 
    };
}