calendarsupport/plugin.h

   1 /*
   2   Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>
   3
   4   This library 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 library 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 #ifndef CALENDARSUPPORT_PLUGIN_H
  20 #define CALENDARSUPPORT_PLUGIN_H
  21
  22 #include <KPluginFactory>
  23
  24 namespace CalendarSupport
  25 {
  26
  27 /**
  28    @class Plugin
  29
  30    @brief Specifies the plugin interface.
  31
  32    This class is shared between korganizer's print plugins and
  33    calendarview's decoration plugins.
  34 */
  35 class Plugin
  36 {
  37
  38     enum {
  39         INTERFACE_VERSION = 2
  40     };
  41
  42 public:
  43     static int interfaceVersion()
  44     {
  45         return INTERFACE_VERSION;
  46     }
  47
  48     static QString serviceType()
  49     {
  50         return QStringLiteral("Calendar/Plugin");
  51     }
  52
  53     Plugin() {}
  54     virtual ~Plugin() {}
  55
  56     virtual QString info() const = 0;
  57
  58     virtual void configure(QWidget *) {}
  59 };
  60
  61 class PluginFactory : public KPluginFactory
  62 {
  63 public:
  64     virtual Plugin *createPluginFactory() = 0;
  65
  66 protected:
  67     virtual QObject *createObject(QObject *, const char *, const QStringList &)
  68     {
  69         return 0;
  70     }
  71 };
  72
  73 }
  74
  75 #endif