kworship/bible/KwBibleManagerSword.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 _KwBibleManagerSword_h_
  21 #define _KwBibleManagerSword_h_
  22
  23 /**
  24  * @file KwBibleManagerSword.h
  25  * @brief A bible manager for SWORD.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwBibleManager.h"
  30
  31 #include <QHash>
  32 #include <QStringList>
  33
  34 namespace sword
  35 {
  36   class SWMgr;
  37 }
  38
  39 /// A bible manager (analagous to a SWORD manager).
  40 class KwBibleManagerSword : public KwBibleManager
  41 {
  42     KW_BIBLE_MANAGER(KwBibleManagerSword, "SWORD");
  43
  44   public:
  45
  46     /*
  47      * Constructors + destructor
  48      */
  49
  50     /// Default constructor.
  51     KwBibleManagerSword();
  52
  53     /// Destructor.
  54     virtual ~KwBibleManagerSword();
  55
  56     /*
  57      * Main interface
  58      */
  59
  60     // Reimplemented
  61     virtual QString name() const;
  62
  63     // Reimplemented
  64     virtual bool isRemote() const;
  65
  66     // Reimplemented
  67     virtual KwBibleModule* module(const QString& name);
  68
  69     // Reimplemented
  70     virtual QStringList moduleNames();
  71
  72     // Reimplemented
  73     virtual QStringList moduleNamesInLanguage(const QString& lang);
  74
  75     // Reimplemented
  76     virtual QStringList languages();
  77
  78   private:
  79
  80     /*
  81      * Variables
  82      */
  83
  84     /// SWORD manager object.
  85     sword::SWMgr* m_manager;
  86
  87     /// Modules managed by this manager.
  88     QHash<QString, KwBibleModule*> m_modules;
  89
  90     /// Languages.
  91     QStringList m_languages;
  92
  93     /// Modules by language.
  94     QHash<QString, QStringList> m_modulesByLanguage;
  95 };
  96
  97 #endif // _KwBibleManagerSword_h_
  98