AnnunciatorPanel.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/QVector>
#include <QtCore/QString>
#include <memory>
 
namespace QtIndustrialWidgets {
 
class AnnunciatorPanelPrivate;
 
class QTINDUSTRIALWIDGETS_EXPORT AnnunciatorPanel : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(int rows READ rows WRITE setRows NOTIFY appearanceChanged)
    Q_PROPERTY(int columns READ columns WRITE setColumns NOTIFY appearanceChanged)
    Q_PROPERTY(int tileCount READ tileCount NOTIFY appearanceChanged)
    Q_PROPERTY(AnnunciatorSequence sequence READ sequence WRITE setSequence NOTIFY appearanceChanged)
    Q_PROPERTY(bool lampTestActive READ isLampTestActive WRITE setLampTest NOTIFY appearanceChanged)
    Q_PROPERTY(bool audibleHornActive READ isAudibleHornActive NOTIFY audibleHornChanged)
    Q_PROPERTY(int activeAlarmsCount READ activeAlarmsCount NOTIFY activeAlarmsCountChanged)
    Q_PROPERTY(int unacknowledgedCount READ unacknowledgedCount NOTIFY unacknowledgedCountChanged)
    Q_PROPERTY(QColor frameColor READ frameColor WRITE setFrameColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor gridColor READ gridColor WRITE setGridColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor criticalColor READ criticalColor WRITE setCriticalColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor warningColor READ warningColor WRITE setWarningColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor advisoryColor READ advisoryColor WRITE setAdvisoryColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor textColor READ textColor WRITE setTextColor NOTIFY appearanceChanged)
 
public:
    enum class Severity {
        Critical, 
        Warning,  
        Advisory  
    };
    Q_ENUM(Severity)
 
    
    enum class AlarmState {
        Normal,         
        Unacknowledged, 
        Acknowledged,   
        Ringback        
    };
    Q_ENUM(AlarmState)
 
    
    enum class AnnunciatorSequence {
        SequenceA_AutomaticReset, 
        SequenceM_ManualReset     
    };
    Q_ENUM(AnnunciatorSequence)
 
    
    struct TileData {
        QString text;
        Severity severity{Severity::Critical};
        AlarmState state{AlarmState::Normal};
        bool alarmActive{false};
    };
 
    explicit AnnunciatorPanel(QWidget *parent = nullptr);
    AnnunciatorPanel(int rows, int cols, QWidget *parent = nullptr);
    ~AnnunciatorPanel() override;
 
    [[nodiscard]] int rows() const;
    [[nodiscard]] int columns() const;
    [[nodiscard]] int tileCount() const;
    [[nodiscard]] AnnunciatorSequence sequence() const;
    [[nodiscard]] bool isLampTestActive() const;
    [[nodiscard]] bool isAudibleHornActive() const;
    [[nodiscard]] int activeAlarmsCount() const;
    [[nodiscard]] int unacknowledgedCount() const;
 
    [[nodiscard]] QString tileText(int index) const;
    [[nodiscard]] Severity tileSeverity(int index) const;
    [[nodiscard]] AlarmState tileState(int index) const;
    [[nodiscard]] bool isAlarmActive(int index) const;
 
    [[nodiscard]] QColor frameColor() const;
    [[nodiscard]] QColor gridColor() const;
    [[nodiscard]] QColor criticalColor() const;
    [[nodiscard]] QColor warningColor() const;
    [[nodiscard]] QColor advisoryColor() const;
    [[nodiscard]] QColor textColor() const;
 
    [[nodiscard]] QSize sizeHint() const override;
    [[nodiscard]] QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    void setRows(int rows);
    void setColumns(int cols);
    void setGridSize(int rows, int cols);
    void setSequence(AnnunciatorSequence sequence);
 
    void setTileText(int index, const QString &text);
    void setTileText(int row, int col, const QString &text);
    void setTileSeverity(int index, Severity severity);
    void setTileSeverity(int row, int col, Severity severity);
 
    void setAlarmActive(int index, bool active);
    void setAlarmActive(int row, int col, bool active);
    void triggerAlarm(int index);
    void clearAlarm(int index);
 
    void acknowledgeAll();
    void acknowledge(int index);
    void silence();
    void resetAll();
    void reset(int index);
 
    void setLampTest(bool active);
 
    void setFrameColor(const QColor &color);
    void setGridColor(const QColor &color);
    void setCriticalColor(const QColor &color);
    void setWarningColor(const QColor &color);
    void setAdvisoryColor(const QColor &color);
    void setTextColor(const QColor &color);
 
Q_SIGNALS:
    void tileClicked(int index);
    void tileStateChanged(int index, AlarmState newState);
    void audibleHornChanged(bool active);
    void activeAlarmsCountChanged(int count);
    void unacknowledgedCountChanged(int count);
    void appearanceChanged();
 
protected:
    void paintEvent(QPaintEvent *event) override;
    void resizeEvent(QResizeEvent *event) override;
    void changeEvent(QEvent *event) override;
    void mousePressEvent(QMouseEvent *event) override;
 
private Q_SLOTS:
    void onFlashTimerTick();
 
private:
    void invalidateCache();
    void renderStaticFrame(const QSize &size);
    void updateHornAndSummary();
    [[nodiscard]] QRectF calculateTileRect(int row, int col) const;
    [[nodiscard]] int tileIndexAt(const QPointF &pos) const;
    [[nodiscard]] QColor colorForSeverity(Severity severity, bool lit) const;
 
    std::unique_ptr<AnnunciatorPanelPrivate> d_ptr;
    Q_DECLARE_PRIVATE(AnnunciatorPanel)
};
 
} // namespace QtIndustrialWidgets