kworship/KwPlugin.h

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _KwPlugin_h_
  21 #define _KwPlugin_h_
  22
  23 /**
  24  * @file KwPlugin.h
  25  * @brief An abstract KWorship plugin.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <kdemacros.h>
  30
  31 #include <KParts/Plugin>
  32
  33 #include <QString>
  34
  35 class KwPluginManager;
  36
  37 class QDockWidget;
  38
  39 /// An abstract KWorship plugin.
  40 class KDE_EXPORT KwPlugin : public KParts::Plugin
  41 {
  42     Q_OBJECT
  43
  44   public:
  45
  46     /*
  47      * Constructors + destructor
  48      */
  49
  50     /** Primary constructor.
  51      * @param id Short unique untranslated id.
  52      * @param name Translated name of plugin.
  53      * @param description Translated description of plugin.
  54      */
  55     KwPlugin(QObject* parent, const QString& id, const QString& name, const QString& description);
  56
  57     /// Destructor.
  58     virtual ~KwPlugin();
  59
  60     /*
  61      * Basic information accessors
  62      */
  63
  64     /// Get the id.
  65     const QString& id() const;
  66
  67     /// Get the name.
  68     const QString& name() const;
  69
  70     /// Get the description.
  71     const QString& description() const;
  72
  73     /// Get whether the plugin is loaded.
  74     bool isLoaded() const;
  75
  76     /*
  77      * Loading and unloading
  78      */
  79
  80     /** Set the manager.
  81      * This should only be called by the manager class itself.
  82      * @pre Manager must not have already been set.
  83      * @param manager New manager object.
  84      */
  85     void setManager(KwPluginManager* manager);
  86
  87     /** Load the plugin.
  88      * @pre Manager must have been set.
  89      */
  90     void load();
  91
  92     /// Unload the plugin.
  93     void unload();
  94
  95   protected:
  96
  97     /*
  98      * Loading and unloading virtual interface
  99      */
 100
 101     /** Load the plugin.
 102      * @pre !isLoaded()
 103      */
 104     virtual void _load() = 0;
 105
 106     /** Unload the plugin.
 107      * @pre isLoaded()
 108      */
 109     virtual void _unload() = 0;
 110
 111   private:
 112
 113     /*
 114      * Constants
 115      */
 116
 117     /// Short unique untranslated id.
 118     QString m_id;
 119
 120     /// Translated name.
 121     QString m_name;
 122
 123     /// Translated description.
 124     QString m_description;
 125
 126     /*
 127      * Variables
 128      */
 129
 130     /// The current plugin manager.
 131     KwPluginManager* m_manager;
 132
 133     /// Whether the plugin is loaded.
 134     bool m_loaded;
 135
 136 };
 137
 138 #endif // _KwPlugin_h_
 139