kworship/KwDocument.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 _KwDocument_h_
  21 #define _KwDocument_h_
  22
  23 /**
  24  * @file KwDocument.h
  25  * @brief A KWorship document (anything saved in a KWorship data file).
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <KUrl>
  30
  31 #include <QObject>
  32
  33 class KwPlaylistList;
  34 class KwArchive;
  35
  36 /// A KWorship document (anything saved in a KWorship data file).
  37 class KwDocument : public QObject
  38 {
  39     Q_OBJECT
  40
  41   public:
  42
  43     /*
  44      * Constructors + destructor
  45      */
  46
  47     /// Primary constructor.
  48     KwDocument(KUrl url, QObject* parent = 0);
  49
  50     /// Destructor.
  51     virtual ~KwDocument();
  52
  53     /*
  54      * Accessors
  55      */
  56
  57     /// Find whether the document has been modified.
  58     bool isModified() const;
  59
  60     /// Find whether the document has ever been saved.
  61     bool isSaved() const;
  62
  63     /// Get the URL the document is saved at.
  64     KUrl url() const;
  65
  66     /// Get the main playlist.
  67     KwPlaylistList* playlist();
  68
  69     /*
  70      * Mutators
  71      */
  72
  73     /// Set the main playlist.
  74     void setPlaylist(KwPlaylistList* playlist);
  75
  76   public slots:
  77
  78     /*
  79      * Saving and loading actions
  80      */
  81
  82     /// Save the file.
  83     void save();
  84
  85     /// Save the file to a different URL.
  86     void saveAs(const KUrl& url);
  87
  88     /*
  89      * Other slots
  90      */
  91
  92     /// Set whether the file is modified.
  93     void setModified(bool modified);
  94
  95   signals:
  96
  97     /*
  98      * Signals
  99      */
 100
 101     /// Emitted when the playlist is reset.
 102     void playlistReset();
 103
 104     /// Emitted when the document modified status changes.
 105     void modifiedChanged(bool modified);
 106
 107   protected:
 108
 109     /*
 110      * Archive interface.
 111      */
 112
 113     /// Save to an archive.
 114     void saveToArchive(KwArchive* archive) const;
 115
 116   private:
 117
 118     /*
 119      * Variables
 120      */
 121
 122     /// The URL of the saved file.
 123     KUrl m_url;
 124
 125     /// Whether the document has been modified.
 126     bool m_modified;
 127
 128     /// The main playlist item.
 129     KwPlaylistList* m_playlist;
 130
 131 };
 132
 133 #endif // _KwDocument_h_
 134