LedIndicator.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 <memory>
#include <QtGui/QColor>
#include <QtCore/QTimer>
 
namespace QtIndustrialWidgets {
 
class LedIndicatorPrivate;
 
class QTINDUSTRIALWIDGETS_EXPORT LedIndicator : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(bool on READ isOn WRITE setOn NOTIFY stateChanged)
    Q_PROPERTY(bool blinking READ isBlinking WRITE setBlinking NOTIFY blinkingChanged)
    Q_PROPERTY(int blinkRateMs READ blinkRateMs WRITE setBlinkRateMs NOTIFY appearanceChanged)
    Q_PROPERTY(QColor onColor READ onColor WRITE setOnColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor offColor READ offColor WRITE setOffColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor bezelColor READ bezelColor WRITE setBezelColor NOTIFY appearanceChanged)
    Q_PROPERTY(bool bezelVisible READ isBezelVisible WRITE setBezelVisible NOTIFY appearanceChanged)
    Q_PROPERTY(bool glowEffect READ hasGlowEffect WRITE setGlowEffect NOTIFY appearanceChanged)
    Q_PROPERTY(LedShape shape READ shape WRITE setShape NOTIFY appearanceChanged)
    Q_PROPERTY(QString labelText READ labelText WRITE setLabelText NOTIFY appearanceChanged)
    Q_PROPERTY(QColor textColor READ textColor WRITE setTextColor NOTIFY appearanceChanged)
    Q_PROPERTY(bool clickable READ isClickable WRITE setClickable NOTIFY appearanceChanged)
 
public:
    enum class LedShape {
        Circular,   
        Rectangular 
    };
    Q_ENUM(LedShape)
 
    
    explicit LedIndicator(QWidget *parent = nullptr);
    explicit LedIndicator(const QColor &onColor, QWidget *parent = nullptr);
    ~LedIndicator() override;
 
    [[nodiscard]] bool isOn() const;
    [[nodiscard]] bool isBlinking() const;
    [[nodiscard]] int blinkRateMs() const;
    [[nodiscard]] QColor onColor() const;
    [[nodiscard]] QColor offColor() const;
    [[nodiscard]] QColor bezelColor() const;
    [[nodiscard]] bool isBezelVisible() const;
    [[nodiscard]] bool hasGlowEffect() const;
    [[nodiscard]] LedShape shape() const;
    [[nodiscard]] QString labelText() const;
    [[nodiscard]] QColor textColor() const;
    [[nodiscard]] bool isClickable() const;
 
    [[nodiscard]] QSize sizeHint() const override;
    [[nodiscard]] QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    void setOn(bool on);
    void setOff();
    void toggle();
    void setBlinking(bool blinking);
    void setBlinkRateMs(int rateMs);
    void setOnColor(const QColor &color);
    void setOffColor(const QColor &color);
    void setBezelColor(const QColor &color);
    void setBezelVisible(bool visible);
    void setGlowEffect(bool glow);
    void setShape(LedShape shape);
    void setLabelText(const QString &text);
    void setTextColor(const QColor &color);
    void setClickable(bool clickable);
 
Q_SIGNALS:
    void stateChanged(bool on);
    void blinkingChanged(bool blinking);
    void clicked();
    void appearanceChanged();
 
protected:
    void paintEvent(QPaintEvent *event) override;
    void mousePressEvent(QMouseEvent *event) override;
 
private Q_SLOTS:
    void onBlinkTimeout();
 
private:
    [[nodiscard]] QColor calculateDefaultOffColor(const QColor &onCol) const;
 
    std::unique_ptr<LedIndicatorPrivate> d_ptr;
    Q_DECLARE_PRIVATE(LedIndicator)
};
 
} // namespace QtIndustrialWidgets