led.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 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_LEDWIDGET_H
#define SWIFT_GUI_LEDWIDGET_H
 
#include <QList>
#include <QObject>
#include <QPixmap>
#include <QScopedPointer>
#include <QString>
#include <QTimer>
#include <QWidget>
 
#include "gui/swiftguiexport.h"
 
class QMouseEvent;
class QPaintEvent;
class QSvgRenderer;
 
namespace swift::gui
{
    class SWIFT_GUI_EXPORT CLedWidget : public QWidget
    {
        Q_OBJECT
 
    public:
        enum LedColor
        {
            Red = 0,
            Green,
            Yellow,
            Grey,
            Orange,
            Purple,
            Blue,
            Black,
            NoColor
        };
        Q_ENUM(LedColor)
 
        
        enum LedShape
        {
            Circle = 0,
            Square,
            Triangle,
            Rounded
        };
        Q_ENUM(LedShape)
 
        
        enum State
        {
            On,
            Off,
            TriState
        };
 
        CLedWidget(QWidget *parent = nullptr);
 
        CLedWidget(bool on, LedColor onColor, LedColor offColor, LedShape shape, const QString &onName = "on",
                   const QString &offName = "off", int targetWidth = -1, QWidget *parent = nullptr);
 
        virtual ~CLedWidget() override;
 
        bool value() const { return m_blinkState; }
 
        void setOn(bool on) { this->setOn(on, -1); }
 
        void blink(int resetTimeMs = 500);
 
        void setTriState(int resetTimeMs = -1);
 
        void toggleValue();
 
        LedShape shape() const { return m_shape; }
 
        LedColor onColor() const { return m_colorOn; }
 
        LedColor offColor() const { return m_colorOff; }
 
        LedColor triStateColor() const { return m_colorTriState; }
 
        void setOnColor(LedColor color);
 
        void setOffColor(LedColor color);
 
        void setTriStateColor(LedColor color);
 
        void setShape(LedShape);
 
        void setTargetWidth(int width)
        {
            this->m_widthTarget = width;
            this->setLed();
        }
 
        QString getOnToolTip() const { return m_tooltipOn; }
 
        QString getOffToolTip() const { return m_tooltipOff; }
 
        QString getTriStateToolTip() const { return m_tooltipTriState; }
 
        void setToolTips(const QString &on, const QString &off, const QString &triState = "tri-state");
 
        void setOnToolTip(const QString &on);
 
        void setOffToolTip(const QString &off);
 
        void setTriStateToolTip(const QString &triStateTooltip);
 
        void setTriStateValues(LedColor color, const QString &tooltip);
 
        void setValues(LedColor onColor, LedColor offColor, LedShape shape, const QString &toolTipOn,
                       const QString &toolTipOff, int width = -1);
 
        void setValues(LedColor onColor, LedColor offColor, LedColor triStateColor, LedShape shape,
                       const QString &toolTipOn, const QString &toolTipOff, const QString &toolTipTriState,
                       int width = -1);
 
        QPixmap asPixmap() const;
 
    signals:
        void clicked();
 
    private:
        State m_blinkState = Off; 
        State m_value = Off; 
        LedColor m_colorOn = Yellow; 
        LedColor m_colorOff = Black; 
        LedColor m_colorTriState = Blue; 
        LedShape m_shape = Circle; 
        double m_whRatio = 1.0; 
        int m_widthTarget = -1; 
        int m_heightCalculated = 1; 
 
        QString m_tooltipOn = "on"; 
        QString m_tooltipOff = "off"; 
        QString m_tooltipTriState = "tri-state"; 
        QString m_currentToolTip = "off"; 
        QScopedPointer<QSvgRenderer> m_renderer; 
        QTimer m_resetTimer; 
 
        void init();
 
        void setOn(bool on, int resetTimeMs);
 
        void resetState();
 
        virtual void paintEvent(QPaintEvent *event) override;
 
        virtual void mousePressEvent(QMouseEvent *event) override;
 
        void setLed(LedColor ledColor = NoColor);
 
        QPixmap renderToPixmap() const;
 
        static const QStringList &shapes();
 
        static const QStringList &colorFiles();
 
        static const QList<int> &widths();
 
        static const QString &colorString(LedColor color); 
    };
} // namespace swift::gui
#endif // SWIFT_GUI_LEDWIDGET_H