CircularBargraph.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 Paolo Sereno <paolomsereno@gmail.com>
 *
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
 
#include <QtIndustrialWidgets/qtindustrialwidgets_global.h>
#include <QtWidgets/QWidget>
#include <QtGui/QColor>
#include <QtCore/QString>
#include <memory>
 
namespace QtIndustrialWidgets {
 
class CircularBargraphPrivate;
 
class QTINDUSTRIALWIDGETS_EXPORT CircularBargraph : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(double value READ value WRITE setValue NOTIFY valueChanged)
    Q_PROPERTY(double rawValue READ rawValue)
    Q_PROPERTY(ValueState valueState READ valueState NOTIFY valueStateChanged)
    Q_PROPERTY(double minimum READ minimum WRITE setMinimum NOTIFY rangeChanged)
    Q_PROPERTY(double maximum READ maximum WRITE setMaximum NOTIFY rangeChanged)
    Q_PROPERTY(int segmentCount READ segmentCount WRITE setSegmentCount NOTIFY appearanceChanged)
    Q_PROPERTY(double startAngle READ startAngle WRITE setStartAngle NOTIFY appearanceChanged)
    Q_PROPERTY(double spanAngle READ spanAngle WRITE setSpanAngle NOTIFY appearanceChanged)
    Q_PROPERTY(DisplayMode displayMode READ displayMode WRITE setDisplayMode NOTIFY appearanceChanged)
    Q_PROPERTY(double warningThreshold READ warningThreshold WRITE setWarningThreshold NOTIFY thresholdChanged)
    Q_PROPERTY(double errorThreshold READ errorThreshold WRITE setErrorThreshold NOTIFY thresholdChanged)
    Q_PROPERTY(bool peakHoldEnabled READ isPeakHoldEnabled WRITE setPeakHoldEnabled NOTIFY appearanceChanged)
    Q_PROPERTY(int peakHoldTimeMs READ peakHoldTimeMs WRITE setPeakHoldTimeMs NOTIFY appearanceChanged)
    Q_PROPERTY(double peakDecayRate READ peakDecayRate WRITE setPeakDecayRate NOTIFY appearanceChanged)
    Q_PROPERTY(bool digitalDisplayVisible READ isDigitalDisplayVisible WRITE setDigitalDisplayVisible NOTIFY appearanceChanged)
    Q_PROPERTY(int precision READ precision WRITE setPrecision NOTIFY appearanceChanged)
    Q_PROPERTY(QString unit READ unit WRITE setUnit NOTIFY appearanceChanged)
    Q_PROPERTY(QColor normalColor READ normalColor WRITE setNormalColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor warningColor READ warningColor WRITE setWarningColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor errorColor READ errorColor WRITE setErrorColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor peakColor READ peakColor WRITE setPeakColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor ghostColor READ ghostColor WRITE setGhostColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor dialColor READ dialColor WRITE setDialColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor textColor READ textColor WRITE setTextColor NOTIFY appearanceChanged)
 
public:
    enum class DisplayMode {
        Bar,  
        Dot   
    };
    Q_ENUM(DisplayMode)
 
    
    enum class ValueState {
        Valid,      
        Underrange, 
        Overrange,  
        Invalid     
    };
    Q_ENUM(ValueState)
 
    
    explicit CircularBargraph(QWidget *parent = nullptr);
    ~CircularBargraph() override;
 
    [[nodiscard]] double value() const;
    [[nodiscard]] double rawValue() const;
    [[nodiscard]] ValueState valueState() const;
    [[nodiscard]] double minimum() const;
    [[nodiscard]] double maximum() const;
    [[nodiscard]] double peakValue() const;
    [[nodiscard]] int segmentCount() const;
    [[nodiscard]] double startAngle() const;
    [[nodiscard]] double spanAngle() const;
    [[nodiscard]] DisplayMode displayMode() const;
    [[nodiscard]] double warningThreshold() const;
    [[nodiscard]] double errorThreshold() const;
    [[nodiscard]] bool isPeakHoldEnabled() const;
    [[nodiscard]] int peakHoldTimeMs() const;
    [[nodiscard]] double peakDecayRate() const;
    [[nodiscard]] bool isDigitalDisplayVisible() const;
    [[nodiscard]] int precision() const;
    [[nodiscard]] QString unit() const;
 
    [[nodiscard]] QColor normalColor() const;
    [[nodiscard]] QColor warningColor() const;
    [[nodiscard]] QColor errorColor() const;
    [[nodiscard]] QColor peakColor() const;
    [[nodiscard]] QColor ghostColor() const;
    [[nodiscard]] QColor dialColor() const;
    [[nodiscard]] QColor textColor() const;
 
    [[nodiscard]] QSize sizeHint() const override;
    [[nodiscard]] QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    void setValue(double val);
    void setMinimum(double min);
    void setMaximum(double max);
    void setRange(double min, double max);
    void setSegmentCount(int count);
    void setStartAngle(double angle);
    void setSpanAngle(double angle);
    void setDisplayMode(DisplayMode mode);
    void setWarningThreshold(double threshold);
    void setErrorThreshold(double threshold);
    void setPeakHoldEnabled(bool enable);
    void setPeakHoldTimeMs(int ms);
    void setPeakDecayRate(double rate);
    void setDigitalDisplayVisible(bool visible);
    void setPrecision(int prec);
    void setUnit(const QString &unit);
    void resetPeak();
 
    void setNormalColor(const QColor &color);
    void setWarningColor(const QColor &color);
    void setErrorColor(const QColor &color);
    void setPeakColor(const QColor &color);
    void setGhostColor(const QColor &color);
    void setDialColor(const QColor &color);
    void setTextColor(const QColor &color);
 
Q_SIGNALS:
    void valueChanged(double newValue);
    void valueStateChanged(QtIndustrialWidgets::CircularBargraph::ValueState state);
    void rangeChanged(double newMin, double newMax);
    void thresholdChanged(double warning, double error);
    void appearanceChanged();
 
protected:
    void paintEvent(QPaintEvent *event) override;
    void resizeEvent(QResizeEvent *event) override;
 
private:
    std::unique_ptr<CircularBargraphPrivate> d_ptr;
    Q_DECLARE_PRIVATE(CircularBargraph)
};
 
} // namespace QtIndustrialWidgets