kworship/bible/KwBiblePlaylistItem.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 _KwBiblePlaylistItem_h_
  21 #define _KwBiblePlaylistItem_h_
  22
  23 /**
  24  * @file KwBiblePlaylistItem.h
  25  * @brief A playlist item for bible passages.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwBibleModule.h"
  30 #include "KwBiblePassage.h"
  31
  32 #include <KwPlaylistItem.h>
  33
  34 #include <QString>
  35
  36 class KwBibleManager;
  37
  38 /// A playlist item for bible passages.
  39 class KwBiblePlaylistItem : public KwPlaylistItem
  40 {
  41     KW_PLAYLIST_ITEM
  42
  43   public:
  44
  45     /*
  46      * Constructors + destructor.
  47      */
  48
  49     /** Construct from reference information.
  50      * @param module Bible module.
  51      * @param moduleKey Bible passage key.
  52      */
  53     KwBiblePlaylistItem(const KwBibleModule* module, const KwBibleModule::Key& moduleKey);
  54
  55     /// Construct from a DOM element.
  56     KwBiblePlaylistItem(const QDomElement& element, KwResourceManager* resourceManager);
  57
  58     /// Destructor.
  59     virtual ~KwBiblePlaylistItem();
  60
  61     /*
  62      * DOM Translation.
  63      */
  64
  65     // Reimplemented
  66     virtual QString itemType() const;
  67
  68     // Reimplemented
  69     virtual void exportDetailsToDom(QDomDocument& document, QDomElement& element, KwResourceManager* resourceManager) const;
  70
  71     /*
  72      * Main interface
  73      */
  74
  75     virtual KwPlaylistNode* getNode(KwPlaylistNode* parent);
  76
  77     /*
  78      * Accessors
  79      */
  80
  81     /// Get the bible passage.
  82     const KwBiblePassage& passage() const;
  83
  84   private:
  85
  86     /*
  87      * Variables
  88      */
  89
  90     /// The bible passage.
  91     KwBiblePassage m_passage;
  92 };
  93
  94 #endif // _KwBiblePlaylistItem_h_
  95