workspace/plasma/dataengines/notifications/notificationsengine.h

   1 /*
   2  * Copyright (C) 2008 Dmitry Suzdalev <dimsuz@gmail.com>
   3  *
   4  * This program is free software you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public License
  15  * along with this library; see the file COPYING.LIB.  If not, write to
  16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18 */
  19
  20
  21 #ifndef NOTIFICATIONSENGINE_H
  22 #define NOTIFICATIONSENGINE_H
  23
  24 #include <Plasma/DataEngine>
  25
  26 class QSignalMapper;
  27 class QTimer;
  28
  29 /**
  30  *  Engine which provides data sources for notifications.
  31  *  Each notification is represented by one source.
  32  */
  33 class NotificationsEngine : public Plasma::DataEngine
  34 {
  35     Q_OBJECT
  36
  37 public:
  38     NotificationsEngine( QObject* parent, const QVariantList& args );
  39     ~NotificationsEngine();
  40
  41     virtual void init();
  42
  43     /**
  44      *  This function implements part of Notifications DBus interface.
  45      *  Once called, will add notification source to the engine
  46      */
  47     uint Notify(const QString &app_name, uint replaces_id, const QString &event_id, const QString &app_icon, const QString &summary, const QString &body, const QStringList &actions, const QVariantMap &hints, int timeout);
  48
  49     void CloseNotification( uint id );
  50
  51     Plasma::Service* serviceForSource(const QString& source);
  52
  53 signals:
  54     void NotificationClosed( uint id, uint reason );
  55     void ActionInvoked( uint id, const QString& actionKey );
  56
  57 private:
  58     /**
  59      * Holds the id that will be assigned to the next notification source
  60      * that will be created
  61      */
  62     uint m_nextId;
  63
  64     friend class NotificationAction;
  65 };
  66
  67 #endif