SimpleQmlNotify/notificationservice.h
2023-04-13 15:46:01 +03:00

170 lines
6.1 KiB
C++

#ifndef NOTIFICATIONSERVICE_H
#define NOTIFICATIONSERVICE_H
#include "notificationdata.h"
#include "historynotificationsmodel.h"
#include <QHash>
#include <QObject>
#include <QSharedPointer>
#include <QQmlEngine>
namespace QmlNotificationService {
/**
* @brief Listner This is listner lyambda function of user ansver. This function has next signature: void(bool accept)
*/
using Listner = std::function<void(bool accept)>;
/**
* @brief The NotificationService class. This class used for working with notify.
*/
class NOTIFYSERVICESHARED_EXPORT NotificationService: public QObject
{
Q_OBJECT
Q_PROPERTY(NotificationData notify READ notify NOTIFY notifyChanged)
Q_PROPERTY(NotificationData question READ question NOTIFY questionChanged)
Q_PROPERTY(QObject* history READ history NOTIFY notifyChanged)
public:
/**
* @brief Notify This method return data of the last notify message.
* @return return data of the last notify message.
*/
NotificationData notify() const;
/**
* @brief question This method return data of the last question.
* @return question data.
*/
NotificationData question() const;
/**
* @brief setNotify This method add new notification message of application.
* @param notify are message data.
*/
void setNotify(const NotificationData &notify);
/**
* @brief setQuestion This method sets information of the users question.
* @param listner This is listner lyambda function.
* @param question are data of the question.
* @return return question code. You must be save this code for check ansver of your qestion.
*/
int setQuestion(const Listner &listner, const NotificationData& question);
/**
* @brief questionComplete This method is main responce method of the users questions.
* @param accepted are boolean option. Set this option to true if user click on accept button.
* @param code are automaticly generated code fo the question.
*/
Q_INVOKABLE void questionComplete(bool accepted, int code = 0);
/**
* @brief setNotify This method set new notify message for user. When notify changed on main application windows shows notify message.
* @param title are title of a notify window.
* @param text are text value of a notify window.
* @param img are url to image of a notify window.
* @param type are code of a notification type. For more information about notification type see the NotificationData enum.
*/
Q_INVOKABLE void setNotify(const QString& title = "",
const QString& text = "",
const QString& img = "",
int type = NotificationData::Normal);
/**
* @brief setQuestion This method set new question for user. When question changed on main application windows shows question.
* @param listnerObject This is qml object with listner function.
* @param listnerMethod This is listner method name. Method signature : void(bool)
* @param title are title of a question window.
* @param text are text value of a question window.
* @param img are url to image of a queston window.
* @param code are code of question. This code must be sendet to the questionComplete method after buttons clik.
*/
Q_INVOKABLE int setQuestion(QObject *listnerObject,
const QString &listnerMethod,
const QString& title = "",
const QString& text = "",
const QString& img = "",
int code = 0);
/**
* @brief setQuestion This method set new question for user. When question changed on main application windows shows question.
* @param listner This is listner lyambda function.
* @param title are title of a question window.
* @param text are text value of a question window.
* @param img are url to image of a queston window.
* @param code are code of question. This code must be sendet to the questionComplete method after buttons clik.
*/
int setQuestion(const Listner &listner,
const QString& title = "",
const QString& text = "",
const QString& img = "",
int code = 0);
/**
* @brief libVersion This method return string value of the version of this library.
* @return string value of the version of this library.
*/
static QString libVersion();
/**
* @brief getService This method return instance to notify service.
* @return pointer to the notification service.
*/
static NotificationService* getService();
/**
* @brief history - This method used for return notify history model.
* @return history model of all notify.
*/
QObject* history() const;
/**
* @brief showHistory - This method used for emit signal by which show notification menu.
*/
Q_INVOKABLE void showHistory();
~NotificationService();
signals:
/**
* @brief notifyChanged This signal emited whet the notificator (Ths object) received a new notification message.
*/
void notifyChanged();
/**
* @brief questionChanged This signal emited whet the notificator (Ths object) received a new question message.
*/
void questionChanged();
/**
* @brief questionCompleted This signal emited when youser clcik any buttons on question popup.
* @param accepted are bool option with "true" value if the yesr click to accept button.
* @param questionCode are automaticly generated code of the question.
* For more information about code option see the setQuestion method.
*/
void questionCompleted(bool accepted, int questionCode);
void historyListChanged();
void sigShowHistory();
private:
explicit NotificationService(QObject *ptr = nullptr);
QHash<int, Listner> _listners;
NotificationData _question;
NotificationData _notify;
HistoryNotificationsModel* _history = nullptr;
};
}
#endif // NOTIFICATIONSERVICE_H