kworship/KwPlugin.cpp

   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 /**
  21  * @file KwPlugin.cpp
  22  * @brief An abstract KWorship plugin.
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "KwPlugin.h"
  27 #include "KwPluginManager.h"
  28
  29 /*
  30  * Constructors + destructor
  31  */
  32
  33 /// Primary constructor.
  34 KwPlugin::KwPlugin(QObject* parent, const QString& id, const QString& name, const QString& description)
  35 : KParts::Plugin(parent)
  36 , m_id(id)
  37 , m_name(name)
  38 , m_description(description)
  39 , m_manager(0)
  40 , m_loaded(false)
  41 {
  42 }
  43
  44 /// Destructor.
  45 KwPlugin::~KwPlugin()
  46 {
  47 }
  48
  49 /*
  50  * Basic information accessors
  51  */
  52
  53 /// Get the id.
  54 const QString& KwPlugin::id() const
  55 {
  56   return m_id;
  57 }
  58
  59 /// Get the name.
  60 const QString& KwPlugin::name() const
  61 {
  62   return m_name;
  63 }
  64
  65 /// Get the description.
  66 const QString& KwPlugin::description() const
  67 {
  68   return m_description;
  69 }
  70
  71 /// Get whether the plugin is loaded.
  72 bool KwPlugin::isLoaded() const
  73 {
  74   return m_loaded;
  75 }
  76
  77 /*
  78  * Loading and unloading
  79  */
  80
  81 /// Set the manager.
  82 void KwPlugin::setManager(KwPluginManager* manager)
  83 {
  84   Q_ASSERT(0 == m_manager);
  85   m_manager = manager;
  86 }
  87
  88 /// Load the plugin.
  89 void KwPlugin::load()
  90 {
  91   if (!m_loaded)
  92   {
  93     _load();
  94   }
  95 }
  96
  97 /// Unload the plugin.
  98 void KwPlugin::unload()
  99 {
 100   if (m_loaded)
 101   {
 102     _unload();
 103   }
 104 }
 105
 106 /// Setup config dialog to include the plugin.
 107 void KwPlugin::setupConfigDialog(KConfigDialog* dialog)
 108 {
 109   Q_UNUSED(dialog);
 110 }