kworship/playlist/KwPlaylistFile.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 _KwPlaylistFile_h_
  21 #define _KwPlaylistFile_h_
  22
  23 /**
  24  * @file KwPlaylistFile.h
  25  * @brief A file based playlist item.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwPlaylistItem.h"
  30 #include "KwResourceLink.h"
  31
  32 #include <KwExport.h>
  33
  34 #include <QUrl>
  35
  36 class KwDisplayManager;
  37
  38 /// A file based playlist item.
  39 class KWMAIN_EXPORT KwPlaylistFile : public KwPlaylistItem
  40 {
  41     KW_PLAYLIST_ITEM
  42
  43   public:
  44
  45     /*
  46      * Constructors + destructor.
  47      */
  48
  49     /// Primary constructor.
  50     KwPlaylistFile(const QUrl& url);
  51
  52     /// Construct from a DOM element.
  53     KwPlaylistFile(const QDomElement& element, KwResourceManager* resourceManager);
  54
  55     /// Destructor.
  56     virtual ~KwPlaylistFile();
  57
  58     /*
  59      * DOM Translation.
  60      */
  61
  62     virtual QString itemType() const;
  63     virtual void exportDetailsToDom(QDomDocument& document, QDomElement& element, KwResourceManager* resourceManager) const;
  64
  65     /*
  66      * Main interface.
  67      */
  68
  69     virtual KwPlaylistNode* getNode(KwPlaylistNode* parent);
  70
  71     /// Activate the file.
  72     virtual void activate(KwDisplayManager* manager);
  73
  74     /*
  75      * Accessors
  76      */
  77
  78     /// Get the image url.
  79     QUrl getUrl() const;
  80
  81     /// Get the title.
  82     const QString& title() const;
  83
  84     /*
  85      * Mutators
  86      */
  87
  88     /// Set the title to display.
  89     void setTitle(const QString& title) ;
  90
  91   private:
  92
  93     /*
  94      * Variables
  95      */
  96
  97     /// Title.
  98     QString m_title;
  99
 100     /// File resource.
 101     KwResourceLink* m_resource;
 102 };
 103
 104 #endif // _KwPlaylistFile_h_
 105