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   public:
  43
  44     /*
  45      * Constructors + destructor
  46      */
  47
  48     /// Default constructor.
  49     KwBibleManagerSword();
  50
  51     /// Destructor.
  52     virtual ~KwBibleManagerSword();
  53
  54     /*
  55      * Main interface
  56      */
  57
  58     // Reimplemented
  59     virtual QString name() const;
  60
  61     // Reimplemented
  62     virtual bool isRemote() const;
  63
  64     // Reimplemented
  65     virtual KwBibleModule* module(const QString& name);
  66
  67     // Reimplemented
  68     virtual QStringList moduleNames();
  69
  70     // Reimplemented
  71     virtual QStringList moduleNamesInLanguage(const QString& lang);
  72
  73     // Reimplemented
  74     virtual QStringList languages();
  75
  76   private:
  77
  78     /*
  79      * Variables
  80      */
  81
  82     /// SWORD manager object.
  83     sword::SWMgr* m_manager;
  84
  85     /// Modules managed by this manager.
  86     QHash<QString, KwBibleModule*> m_modules;
  87
  88     /// Languages.
  89     QStringList m_languages;
  90
  91     /// Modules by language.
  92     QHash<QString, QStringList> m_modulesByLanguage;
  93 };
  94
  95 #endif // _KwBibleManagerSword_h_
  96