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