ProgressWidget.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
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: ProgressWidget
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/QCustomProgressbar.h>
#include <NDEVR/LogStream.h>
class QTimer;
class QRectF;
class QPixmap;
class QRadialGradient;
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Displays the progress, either horizontally as a bar or as a roand spin dial. Contains various
        options for display and can be added as a LogStream to a Log.
    **/
    class NDEVR_WIDGETS_API ProgressWidget : public QCustomProgressBar, public LogStream
    {
    public:
        explicit ProgressWidget(QWidget* parent = nullptr);
        virtual ~ProgressWidget() override;
        void setIconID(const String& image_id, bool foreground = true);
        void clearIcon();
        void resizeEvent(QResizeEvent* event) override;
        void setHorizontal(bool is_horizontal);
        void setTickCount(uint04 tick_count);
        void paintEvent(QPaintEvent* event) override;
        void setSizeMultiplier(fltp04 size_multiplier);
        virtual void setIndeterminateAnimationTimespan(const TimeSpan& span) override;
        void setProgressThickness(fltp04 thickness);
        [[nodiscard]] QSize sizeHint() const override;
        [[nodiscard]] QSize minimumSizeHint() const override;
        virtual bool event(QEvent* event) override;
        bool isHorizontal() const { return m_is_horizontal; }
        int heightForWidth(int w) const override { return w; }
        virtual void addMessage(const LogMessage&) override;
        void clearTextRectCache();
        fltp04 progressEpsilon() const;
    protected:
        void updateTimerInterval();
        void setProgress(fltp04 percent) override;
    protected:
        String m_icon_id;
        QIcon m_background_icon;
        QPixmap* m_tick_mark_cache_image;
        QRectF m_last_text_rect_a;
        QRectF m_last_text_rect_b;
        QString m_last_text;
        QFont m_last_font_a;
        QFont m_last_font_b;
        fltp04 m_last_percent;
        fltp04 m_size_multiplier = 1.0f;
        uint04 m_tick_count = 10;
        fltp04 m_thickness = 0.1f;
        bool m_is_horizontal;
        bool m_is_analog;
        bool m_is_updating_percent;
        bool m_icon_foreground = false;
    };
 
}