kworship/bible/KwBibleModuleBibleGateway.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 _KwBibleModuleBibleGateway_h_
  21 #define _KwBibleModuleBibleGateway_h_
  22
  23 /**
  24  * @file KwBibleModuleBibleGateway.h
  25  * @brief A BibleGateway bible module.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwBibleModule.h"
  30
  31 #include <KUrl>
  32
  33 #include <QList>
  34
  35 /// A BibleGateway bible module.
  36 class KwBibleModuleBibleGateway : public KwBibleModule
  37 {
  38   public:
  39
  40     /*
  41      * Constructors + destructor
  42      */
  43
  44     /// Default constructor.
  45     KwBibleModuleBibleGateway(int id);
  46
  47     /// Destructor.
  48     virtual ~KwBibleModuleBibleGateway();
  49
  50     /*
  51      * Main interface
  52      */
  53
  54     // Reimplemented
  55     virtual QString name();
  56
  57     // Reimplemented
  58     virtual QString description();
  59
  60     // Reimplemented
  61     virtual int numChapters(int book);
  62
  63     // Reimplemented
  64     virtual int numVerses(int book, int chapter);
  65
  66     // Reimplemented
  67     virtual bool fillPassageVerse(int bookIndex, int chapterIndex, int verseIndex, KwBiblePassage* outPassage);
  68
  69     // Reimplemented
  70     virtual QString renderText(const KwBibleModule::Key& key);
  71
  72   protected:
  73
  74     /*
  75      * Protected virtual interface
  76      */
  77
  78     // Reimplemented
  79     virtual void obtainBooks();
  80
  81   private:
  82
  83     /*
  84      * Private functions
  85      */
  86
  87     struct Chapter;
  88
  89     /// Ensure chapter contents are fetched and return the chapter object.
  90     struct Chapter* fetchChapter(int book, int chapter);
  91
  92     /*
  93      * Variables
  94      */
  95
  96     /// The name of the publisher.
  97     QString m_publisher;
  98
  99     /// The long version information.
 100     QString m_versionInfo;
 101
 102     /// The long copyright information.
 103     QString m_copyrightInfo;
 104
 105     /// Chapter data.
 106     struct Chapter
 107     {
 108       /// BibleGateway.com URL for this chapter.
 109       KUrl url;
 110
 111       /// Whether the verses have been fetched.
 112       bool fetched;
 113
 114       /// List of verse contents.
 115       QStringList verses;
 116     };
 117
 118     /// Book data.
 119     struct Book
 120     {
 121       /// Name of the book.
 122       QString name;
 123
 124       /// List of chapter information.
 125       QList<Chapter> chapters;
 126     };
 127
 128     /// List of books.
 129     QList<Book> m_bookList;
 130 };
 131
 132 #endif // _KwBibleModuleBibleGateway_h_
 133