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 <QObject>
  30 #include <QString>
  31
  32 class KwPluginManager;
  33
  34 class QMainWindow;
  35 class QDockWidget;
  36
  37 /// An abstract KWorship plugin.
  38 class KwPlugin : public QObject
  39 {
  40     Q_OBJECT
  41
  42   public:
  43
  44     /*
  45      * Constructors + destructor
  46      */
  47
  48     /** Primary constructor.
  49      * @param id Short unique untranslated id.
  50      * @param name Translated name of plugin.
  51      * @param description Translated description of plugin.
  52      */
  53     KwPlugin(const QString& id, const QString& name, const QString& description);
  54
  55     /// Destructor.
  56     virtual ~KwPlugin();
  57
  58     /*
  59      * Basic information accessors
  60      */
  61
  62     /// Get the id.
  63     const QString& id() const;
  64
  65     /// Get the name.
  66     const QString& name() const;
  67
  68     /// Get the description.
  69     const QString& description() const;
  70
  71     /// Get whether the plugin is loaded.
  72     bool isLoaded() const;
  73
  74     /*
  75      * Loading and unloading
  76      */
  77
  78     /** Set the manager.
  79      * This should only be called by the manager class itself.
  80      * @pre Manager must not have already been set.
  81      * @param manager New manager object.
  82      */
  83     void setManager(KwPluginManager* manager);
  84
  85     /** Load the plugin.
  86      * @pre Manager must have been set.
  87      */
  88     void load(QMainWindow* mainWindow);
  89
  90     /// Unload the plugin.
  91     void unload();
  92
  93   protected:
  94
  95     /*
  96      * Loading and unloading virtual interface
  97      */
  98
  99     /** Load the plugin.
 100      * @pre !isLoaded()
 101      */
 102     virtual void _load(QMainWindow* mainWindow) = 0;
 103
 104     /** Unload the plugin.
 105      * @pre isLoaded()
 106      */
 107     virtual void _unload() = 0;
 108
 109   private:
 110
 111     /*
 112      * Constants
 113      */
 114
 115     /// Short unique untranslated id.
 116     QString m_id;
 117
 118     /// Translated name.
 119     QString m_name;
 120
 121     /// Translated description.
 122     QString m_description;
 123
 124     /*
 125      * Variables
 126      */
 127
 128     /// The current plugin manager.
 129     KwPluginManager* m_manager;
 130
 131     /// Whether the plugin is loaded.
 132     bool m_loaded;
 133
 134 };
 135
 136 #endif // _KwPlugin_h_
 137