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
  36 /** Manages KWorship plugins.
  37  * @todo Dynamic loading/unloading of plugins.
  38  */
  39 class KwPluginManager : public QObject
  40 {
  41     Q_OBJECT
  42
  43   public:
  44
  45     /*
  46      * Constructors + destructor
  47      */
  48
  49     /// Primary constructor.
  50     KwPluginManager();
  51
  52     /// Destructor.
  53     virtual ~KwPluginManager();
  54
  55     /*
  56      * Plugin loading and unloading
  57      */
  58
  59     /// Set the main window.
  60     void setMainWindow(KXmlGuiWindow* mainWindow);
  61
  62     /** Directly load a plugin.
  63      * @param plugin The plugin object.
  64      * @returns True on success, false otherwise.
  65      */
  66     bool loadPlugin(KwPlugin* plugin);
  67
  68     /// Load all plugins.
  69     void loadPlugins();
  70
  71   private:
  72
  73     /*
  74      * Variables
  75      */
  76
  77     /// Main window.
  78     KXmlGuiWindow* m_mainWindow;
  79
  80     /// Plugins by id.
  81     QMap<QString, KwPlugin*> m_plugins;
  82 };
  83
  84 #endif // _KwPluginManager_h_
  85