loadindicator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
// Class based on qLed: Copyright (C) 2010 by P. Sereno, http://www.sereno-online.com
 
 
#ifndef SWIFT_GUI_LOADINDICATOR_H
#define SWIFT_GUI_LOADINDICATOR_H
 
#include <QColor>
#include <QList>
#include <QObject>
#include <QSize>
#include <QWidget>
#include <Qt>
 
#include "gui/swiftguiexport.h"
 
class QPaintEvent;
class QPainter;
class QTimerEvent;
 
namespace swift::gui
{
    class SWIFT_GUI_EXPORT CLoadIndicator : public QWidget
    {
        Q_OBJECT
 
    public:
        CLoadIndicator(int width = 64, int height = 64, QWidget *parent = nullptr);
 
        int getAnimationDelayTimeMs() const { return m_delayMs; }
 
        bool isAnimated() const;
 
        bool isDisplayedWhenStopped() const;
 
        const QColor &color() const { return m_color; }
 
        virtual QSize sizeHint() const override;
 
        virtual int heightForWidth(int w) const override;
 
        void paint(QPainter &painter) const;
 
        void centerLoadIndicator(const QPoint &middle);
 
    signals:
        void timedOut();
 
    public slots:
        int startAnimation(std::chrono::milliseconds timeout = std::chrono::milliseconds(0),
                           bool processEvents = false);
 
        void stopAnimation(int indicatorId = -1);
 
        void setAnimationDelay(int delay);
 
        void setDisplayedWhenStopped(bool state);
 
        void setColor(const QColor &color);
 
    protected:
        virtual void timerEvent(QTimerEvent *event) override;
 
        virtual void paintEvent(QPaintEvent *event) override;
 
        bool isParentVisible() const;
 
    private:
        int m_angle = 0;
        int m_timerId = -1;
        int m_delayMs = 1000;
        int m_currentId = 1; 
        QList<int> m_pendingIds; 
        bool m_displayedWhenStopped = false;
        QColor m_color = Qt::blue;
    };
 
    class SWIFT_GUI_EXPORT CLoadIndicatorEnabled
    {
    public:
        CLoadIndicatorEnabled(QWidget *usingWidget);
 
        virtual ~CLoadIndicatorEnabled() {}
 
        CLoadIndicatorEnabled(const CLoadIndicatorEnabled &) = delete;
 
        CLoadIndicatorEnabled &operator=(const CLoadIndicatorEnabled &) = delete;
 
        bool isShowingLoadIndicator() const;
 
        void showLoading(std::chrono::milliseconds timeout = std::chrono::milliseconds(0), bool processEvents = true);
 
        void hideLoading();
 
        bool isLoadInProgress() const;
 
    protected:
        void centerLoadIndicator();
 
        virtual void indicatorTimedOut();
 
        QWidget *m_usingWidget = nullptr; 
        CLoadIndicator *m_loadIndicator = nullptr; 
        bool m_loadInProgress = false; 
        int m_indicatorId = -1; 
    };
} // namespace swift::gui
 
#endif // SWIFT_GUI_LOADINDICATOR_H