workspace/plasma/applets/systemtray/core/protocol.h

   1 /***************************************************************************
   2  *   taskprotocol.h                                                        *
   3  *                                                                         *
   4  *   Copyright (C) 2008 Jason Stubbs <jasonbstubbs@gmail.com>              *
   5  *                                                                         *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  *                                                                         *
  11  *   This program is distributed in the hope that it will be useful,       *
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  14  *   GNU General Public License for more details.                          *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU General Public License     *
  17  *   along with this program; if not, write to the                         *
  18  *   Free Software Foundation, Inc.,                                       *
  19  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA .        *
  20  ***************************************************************************/
  21
  22 #ifndef SYSTEMTRAYPROTOCOL_H
  23 #define SYSTEMTRAYPROTOCOL_H
  24
  25 #include <QtCore/QObject>
  26
  27 namespace SystemTray
  28 {
  29     class Job;
  30     class Notification;
  31     class Task;
  32 }
  33
  34
  35 namespace SystemTray
  36 {
  37
  38 /**
  39  * @short System tray protocol base class
  40  *
  41  * To support a new system tray protocol, this class and Task should be
  42  * subclassed and the subclass of this class registered with the global
  43  * Manager. The Protocol subclass should emit taskCreated() for each new
  44  * task created.
  45  **/
  46 class Protocol : public QObject
  47 {
  48     Q_OBJECT
  49 public:
  50     explicit Protocol(QObject *parent);
  51
  52     virtual void init() = 0;
  53
  54 signals:
  55     /**
  56      * Signals that a new task has been created
  57      **/
  58     void taskCreated(SystemTray::Task *task);
  59
  60     /**
  61      * Signals that a new notification has been created
  62      **/
  63     void jobCreated(SystemTray::Job *job);
  64
  65     /**
  66      * Signals that a new notification has been created
  67      **/
  68     void notificationCreated(SystemTray::Notification *notification);
  69 };
  70
  71 }
  72
  73
  74 #endif