Notification.h

/***************************************************************************
 *   Copyright (C) 2023-2024 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QObject>
#include <QQmlEngine>
 
#include "units/Timespan.h"
 
using namespace Qt::Literals::StringLiterals;
 
namespace Notifications {

 
class Notification : public QObject
{
    Q_OBJECT
    QML_ELEMENT
 
public:
    enum Importance : quint8 {
        Info = 1<<1,               
        Info_Navigation = 1<<2,    
        Warning = 1<<3,            
        Warning_Navigation = 1<<4, 
        Alert = 1<<5               
    };
    enum Importance : quint8 {…};
    Q_ENUM(Importance);

    enum TextBodyAction : quint8 {
        None,                   
        OpenMapsAndDataPage,    
        OpenTrafficReceiverPage 
    };
    enum TextBodyAction : quint8 {…};
    Q_ENUM(TextBodyAction);
 
 
    //
    // Constructors and destructors
    //
 
public:
    explicit Notification(
        QString _title,
        Notifications::Notification::Importance _importance = Notifications::Notification::Info,
        QObject* parent = nullptr);
 
    // Standard constructor, required by QML
    explicit Notification(QObject* parent = nullptr);

    ~Notification() override = default;
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(QString button1Text READ button1Text WRITE setButton1Text NOTIFY button1TextChanged)
 
    
    Q_PROPERTY(QString button2Text READ button2Text WRITE setButton2Text NOTIFY button2TextChanged)

    Q_PROPERTY(Notifications::Notification::Importance importance READ importance CONSTANT)

    Q_PROPERTY(Units::Timespan reactionTime READ reactionTime WRITE setReactionTime NOTIFY reactionTimeChanged)

    Q_PROPERTY(QString spokenText READ spokenText WRITE setSpokenText NOTIFY spokenTextChanged)

    Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged)

    Q_PROPERTY(Notifications::Notification::TextBodyAction textBodyAction READ textBodyAction WRITE setTextBodyAction NOTIFY textBodyActionChanged)

    Q_PROPERTY(QString title READ title CONSTANT)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] QString button1Text() const { return m_button1Text; }

    [[nodiscard]] QString button2Text() const { return m_button2Text; }

    [[nodiscard]] Notifications::Notification::Importance importance() const { return m_importance; }

    [[nodiscard]] Units::Timespan reactionTime() const { return m_reactionTime; }

    [[nodiscard]] QString spokenText() const;

    [[nodiscard]] QString text() const { return m_text; }

    [[nodiscard]] Notifications::Notification::TextBodyAction textBodyAction() const { return m_textBodyAction; }

    [[nodiscard]] QString title() const { return m_title; }
 
 
 
    //
    // Setter Methods
    //

    void setButton1Text(const QString& newButton1Text);

    void setButton2Text(const QString& newButton2Text);

    void setReactionTime(Units::Timespan newReactionTime);

    void setSpokenText(const QString& newSpokenText);

    void setText(const QString& newText);

    void setTextBodyAction(Notifications::Notification::TextBodyAction newTextBodyAction);
 
 
    //
    // Methods
    //

    Q_INVOKABLE virtual void onButton1Clicked();

    Q_INVOKABLE virtual void onButton2Clicked();
 
signals:
    void button1TextChanged();

    void button2TextChanged();

    void reactionTimeChanged();

    void spokenTextChanged();

    void textChanged();

    void textBodyActionChanged();
 
 
private:
    Q_DISABLE_COPY_MOVE(Notification)
 
    // Property data
    QString m_button1Text {tr("Dismiss")};
    QString m_button2Text;
    Notifications::Notification::Importance m_importance {Info};
    Units::Timespan m_reactionTime;
    QString m_spokenText;
    QString m_title {u"Placeholder title"_s};
    QString m_text;
    Notifications::Notification::TextBodyAction m_textBodyAction {None};
};
class Notification : public QObject {…};
 
} // namespace Notifications