1 /***************************************************************************
2 * This file is part of KWorship. *
3 * Copyright 2008 James Hogan <james@albanarts.com> *
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. *
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. *
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 ***************************************************************************/
20 #ifndef _KwDocument_h_
21 #define _KwDocument_h_
25 * @brief A KWorship document (anything saved in a KWorship data file).
26 * @author James Hogan <james@albanarts.com>
36 class KwLoadSaveFilter
;
38 /// A KWorship document (anything saved in a KWorship data file).
39 class KWMAIN_EXPORT KwDocument
: public QObject
46 * Constructors + destructor
49 /// Primary constructor.
50 KwDocument(KwLoadSaveFilter
* filter
= 0, const QString
& mimeType
= QString(), KUrl url
= KUrl(), QObject
* parent
= 0);
53 virtual ~KwDocument();
59 /// Find whether the document has been modified.
60 bool isModified() const;
62 /// Find whether the document has ever been saved.
65 /// Get the URL the document is saved at.
68 /// Get the main playlist.
69 KwPlaylistList
* playlist();
71 /// Get the current mime type.
72 const QString
& mimeType() const;
78 /// Set the main playlist.
79 void setPlaylist(KwPlaylistList
* playlist
);
84 * Saving and loading actions
90 /// Save the file to a different URL.
91 void saveAs(KwLoadSaveFilter
* filter
, const QString
& mimeType
, const KUrl
& url
);
97 /// Set whether the file is modified.
98 void setModified(bool modified
);
106 /// Emitted when the playlist is reset.
107 void playlistReset();
109 /// Emitted when the document modified status changes.
110 void modifiedChanged(bool modified
);
118 /// The URL of the saved file.
121 /// Active mime type.
124 /// Active save filter.
125 KwLoadSaveFilter
* m_activeFilter
;
127 /// Whether the document has been modified.
130 /// The main playlist item.
131 KwPlaylistList
* m_playlist
;
135 #endif // _KwDocument_h_