IndustrialSwitch.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 <memory>
 
namespace QtIndustrialWidgets {
 
class IndustrialSwitchPrivate;
 
class QTINDUSTRIALWIDGETS_EXPORT IndustrialSwitch : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(SwitchType switchType READ switchType WRITE setSwitchType NOTIFY appearanceChanged)
    Q_PROPERTY(int positionCount READ positionCount WRITE setPositionCount NOTIFY appearanceChanged)
    Q_PROPERTY(int position READ position WRITE setPosition NOTIFY positionChanged)
    Q_PROPERTY(bool checked READ isChecked WRITE setChecked NOTIFY toggled)
    Q_PROPERTY(Qt::Orientation orientation READ orientation WRITE setOrientation NOTIFY appearanceChanged)
    Q_PROPERTY(bool hasSafetyGuard READ hasSafetyGuard WRITE setHasSafetyGuard NOTIFY appearanceChanged)
    Q_PROPERTY(bool isGuardOpen READ isGuardOpen WRITE setGuardOpen NOTIFY guardToggled)
    Q_PROPERTY(bool animated READ isAnimated WRITE setAnimated NOTIFY appearanceChanged)
    Q_PROPERTY(bool hasLed READ hasLed WRITE setHasLed NOTIFY appearanceChanged)
    Q_PROPERTY(QString label READ label WRITE setLabel NOTIFY appearanceChanged)
    Q_PROPERTY(QString labelOff READ labelOff WRITE setLabelOff NOTIFY appearanceChanged)
    Q_PROPERTY(QString labelOn READ labelOn WRITE setLabelOn NOTIFY appearanceChanged)
    Q_PROPERTY(QString labelCenter READ labelCenter WRITE setLabelCenter NOTIFY appearanceChanged)
    Q_PROPERTY(QColor plateColor READ plateColor WRITE setPlateColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor leverColor READ leverColor WRITE setLeverColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor ledColor READ ledColor WRITE setLedColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor textColor READ textColor WRITE setTextColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor guardColor READ guardColor WRITE setGuardColor NOTIFY appearanceChanged)
 
public:
    enum class SwitchType {
        ToggleLever, 
        Rocker       
    };
    Q_ENUM(SwitchType)
 
    
    explicit IndustrialSwitch(QWidget *parent = nullptr);
    ~IndustrialSwitch() override;
 
    [[nodiscard]] SwitchType switchType() const;
    [[nodiscard]] int positionCount() const;
    [[nodiscard]] int position() const;
    [[nodiscard]] bool isChecked() const;
    [[nodiscard]] Qt::Orientation orientation() const;
    [[nodiscard]] bool hasSafetyGuard() const;
    [[nodiscard]] bool isGuardOpen() const;
    [[nodiscard]] bool isAnimated() const;
    [[nodiscard]] bool hasLed() const;
    [[nodiscard]] QString label() const;
    [[nodiscard]] QString labelOff() const;
    [[nodiscard]] QString labelOn() const;
    [[nodiscard]] QString labelCenter() const;
 
    [[nodiscard]] QColor plateColor() const;
    [[nodiscard]] QColor leverColor() const;
    [[nodiscard]] QColor ledColor() const;
    [[nodiscard]] QColor textColor() const;
    [[nodiscard]] QColor guardColor() const;
 
    [[nodiscard]] QSize sizeHint() const override;
    [[nodiscard]] QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    void setSwitchType(SwitchType type);
    void setPositionCount(int count);
    void setPosition(int position);
    void setChecked(bool checked);
    void toggle();
    void setOrientation(Qt::Orientation orientation);
    void setHasSafetyGuard(bool guard);
    void setGuardOpen(bool open);
    void setAnimated(bool animated);
    void setHasLed(bool hasLed);
    void setLabel(const QString &label);
    void setLabelOff(const QString &label);
    void setLabelOn(const QString &label);
    void setLabelCenter(const QString &label);
    void setPlateColor(const QColor &color);
    void setLeverColor(const QColor &color);
    void setLedColor(const QColor &color);
    void setTextColor(const QColor &color);
    void setGuardColor(const QColor &color);
 
Q_SIGNALS:
    void positionChanged(int position);
    void toggled(bool checked);
    void guardToggled(bool isOpen);
    void appearanceChanged();
 
protected:
    void paintEvent(QPaintEvent *event) override;
    void resizeEvent(QResizeEvent *event) override;
    void changeEvent(QEvent *event) override;
    void mousePressEvent(QMouseEvent *event) override;
    void mouseMoveEvent(QMouseEvent *event) override;
    void mouseReleaseEvent(QMouseEvent *event) override;
    void keyPressEvent(QKeyEvent *event) override;
    void wheelEvent(QWheelEvent *event) override;
 
private:
    void renderStaticBackground();
    void drawToggleLever(QPainter &painter, const QRectF &switchArea, double currentPos);
    void drawRocker(QPainter &painter, const QRectF &switchArea, double currentPos);
    void drawSafetyGuard(QPainter &painter, const QRectF &switchArea);
    void drawLed(QPainter &painter, const QPointF &center, double radius, bool active);
    void drawScrew(QPainter &painter, const QPointF &center, double radius);
    QRectF calculateSwitchRect() const;
    QRectF calculateGuardRect() const;
 
    std::unique_ptr<IndustrialSwitchPrivate> d_ptr;
    Q_DECLARE_PRIVATE(IndustrialSwitch)
};
 
} // namespace QtIndustrialWidgets