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