plasma-workspace/dataengines/notifications/notificationsengine.h

/*
 * Copyright (C) 2008 Dmitry Suzdalev <dimsuz@gmail.com>
 *
 * This program is free software you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef NOTIFICATIONSENGINE_H
#define NOTIFICATIONSENGINE_H

#include <Plasma/DataEngine>
#include <QHash>
#include <QSet>

namespace NotificationManager
{
class Notification;
}

struct NotificationInhibiton {
    QString hint;
    QString value;
};

typedef QSharedPointer<NotificationInhibiton> NotificationInhibitonPtr;

/**
 *  Engine which provides data sources for notifications.
 *  Each notification is represented by one source.
 */
class NotificationsEngine : public Plasma::DataEngine
{
    Q_OBJECT

public:
    NotificationsEngine(QObject *parent, const QVariantList &args);
    ~NotificationsEngine() override;

    virtual void init();

    /**
     *  This function implements part of Notifications DBus interface.
     *  Once called, will add notification source to the engine
     */
    uint Notify(const QString &app_name,
                uint replaces_id,
                const QString &app_icon,
                const QString &summary,
                const QString &body,
                const QStringList &actions,
                const QVariantMap &hints,
                int timeout);

    Plasma::Service *serviceForSource(const QString &source) override;

    int createNotification(const QString &appName,
                           const QString &appIcon,
                           const QString &summary,
                           const QString &body,
                           int timeout,
                           const QStringList &actions,
                           const QVariantMap &hints);

    void configureNotification(const QString &appName, const QString &eventId = QString());

    /*
     * Block all notification where a given notification hint matches a given value.
     *
     * Inhibition is dropped when dereferenced.
     */
    NotificationInhibitonPtr createInhibition(const QString &hint, const QString &value);

public Q_SLOTS:
    void removeNotification(uint id, uint closeReason);

private:
    void notificationAdded(const NotificationManager::Notification &notification);

    QHash<QString, QString> m_activeNotifications;

    QList<NotificationInhibiton *> m_inhibitions;

    friend class NotificationAction;
};

Q_DECLARE_METATYPE(NotificationInhibitonPtr);

#endif