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(const QString& id, const QString& name, const QString& description)
  35 : m_id(id)
  36 , m_name(name)
  37 , m_description(description)
  38 , m_manager(0)
  39 , m_loaded(false)
  40 {
  41 }
  42
  43 /// Destructor.
  44 KwPlugin::~KwPlugin()
  45 {
  46 }
  47
  48 /*
  49  * Basic information accessors
  50  */
  51
  52 /// Get the id.
  53 const QString& KwPlugin::id() const
  54 {
  55   return m_id;
  56 }
  57
  58 /// Get the name.
  59 const QString& KwPlugin::name() const
  60 {
  61   return m_name;
  62 }
  63
  64 /// Get the description.
  65 const QString& KwPlugin::description() const
  66 {
  67   return m_description;
  68 }
  69
  70 /// Get whether the plugin is loaded.
  71 bool KwPlugin::isLoaded() const
  72 {
  73   return m_loaded;
  74 }
  75
  76 /*
  77  * Loading and unloading
  78  */
  79
  80 /// Set the manager.
  81 void KwPlugin::setManager(KwPluginManager* manager)
  82 {
  83   Q_ASSERT(0 == m_manager);
  84   m_manager = manager;
  85 }
  86
  87 /// Load the plugin.
  88 void KwPlugin::load()
  89 {
  90   if (!m_loaded)
  91   {
  92     _load();
  93   }
  94 }
  95
  96 /// Unload the plugin.
  97 void KwPlugin::unload()
  98 {
  99   if (m_loaded)
 100   {
 101     _unload();
 102   }
 103 }
 104