kworship/KwPluginManager.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 _KwPluginManager_h_
  21 #define _KwPluginManager_h_
  22
  23 /**
  24  * @file KwPluginManager.h
  25  * @brief Manages KWorship plugins.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QObject>
  30 #include <QMap>
  31 #include <QString>
  32
  33 class KwPlugin;
  34 class KXmlGuiWindow;
  35 class KConfigDialog;
  36
  37 /** Manages KWorship plugins.
  38  * @todo Dynamic loading/unloading of plugins.
  39  */
  40 class KwPluginManager : public QObject
  41 {
  42     Q_OBJECT
  43
  44   public:
  45
  46     /*
  47      * Constructors + destructor
  48      */
  49
  50     /// Primary constructor.
  51     KwPluginManager();
  52
  53     /// Destructor.
  54     virtual ~KwPluginManager();
  55
  56     /*
  57      * Plugin loading and unloading
  58      */
  59
  60     /// Set the main window.
  61     void setMainWindow(KXmlGuiWindow* mainWindow);
  62
  63     /** Directly load a plugin.
  64      * @param plugin The plugin object.
  65      * @returns True on success, false otherwise.
  66      */
  67     bool loadPlugin(KwPlugin* plugin);
  68
  69     /// Load all plugins.
  70     void loadPlugins();
  71
  72     /// Setup config dialog to include the plugin.
  73     void setupConfigDialog(KConfigDialog* dialog);
  74
  75   private:
  76
  77     /*
  78      * Variables
  79      */
  80
  81     /// Main window.
  82     KXmlGuiWindow* m_mainWindow;
  83
  84     /// Plugins by id.
  85     QMap<QString, KwPlugin*> m_plugins;
  86 };
  87
  88 #endif // _KwPluginManager_h_
  89