kworship/songdb/KwSongdbVersion.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 _KwSongdbVersion_h_
  21 #define _KwSongdbVersion_h_
  22
  23 /**
  24  * @file KwSongdbVersion.h
  25  * @brief A song version from the database.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwSongdbLyrics.h"
  30
  31 #include <kdemacros.h>
  32
  33 #include <QHash>
  34 #include <QVector>
  35
  36 class KwSongdbSong;
  37 class KwSongdbSongBookSong;
  38
  39 /// A song version from the database.
  40 class KDE_EXPORT KwSongdbVersion
  41 {
  42   public:
  43
  44     /*
  45      * Types
  46      */
  47
  48     /// Version data fields.
  49     enum Field
  50     {
  51       Name = 0x1,
  52       Writer = 0x2,
  53       Copyright = 0x4,
  54       Lyrics = 0x8
  55     };
  56     Q_DECLARE_FLAGS(Fields, Field)
  57
  58     /*
  59      * Constructors + destructor
  60      */
  61
  62     /** Construct a new version for database insertion.
  63      * This constructs a blank song version which will be inserted into the
  64      * database when it is saved.
  65      * @param song The song for the version to belong to.
  66      */
  67     KwSongdbVersion(KwSongdbSong* song);
  68
  69     /** Construct from the database.
  70      * Loads the version information from the database.
  71      * @param id Database id of version.
  72      */
  73     KwSongdbVersion(int id);
  74
  75     /// Destructor.
  76     virtual ~KwSongdbVersion();
  77
  78     /*
  79      * Accessors
  80      */
  81
  82     /// Get the version id.
  83     int id();
  84
  85     /// Get the song this is a version of.
  86     KwSongdbSong* song();
  87
  88     /// Get the name of this version.
  89     QString name() const;
  90
  91     /** Get a non-empty name of this version.
  92      * @return The name or i18n("Default version").
  93      */
  94     QString niceName() const;
  95
  96     /// Get the name of the writer.
  97     QString writer() const;
  98
  99     /// Get the copyright notice.
 100     QString copyright() const;
 101
 102     /// Get the lyrics.
 103     const KwSongdbLyrics& lyrics() const;
 104
 105     /// Get song book numbers.
 106     QList<KwSongdbSongBookSong*> songBookNumbers();
 107
 108     /*
 109      * Mutators
 110      */
 111
 112     /// Set the name.
 113     void setName(const QString& name);
 114
 115     /// Set the writer.
 116     void setWriter(const QString& writer);
 117
 118     /// Set the copyright notice.
 119     void setCopyright(const QString& copyright);
 120
 121     /// Set the lyrics markup.
 122     void setLyricsMarkup(const QString& markup);
 123
 124     /// Set the lyrics plain text verses.
 125     void setLyricsPlainVerses(const QStringList& plainVerses);
 126
 127     /// Set the lyrics.
 128     void setLyrics(const KwSongdbLyrics& lyrics);
 129
 130     /// Save changes to the version data.
 131     void save();
 132
 133   private:
 134
 135     /*
 136      * Variables
 137      */
 138
 139     /// Version id.
 140     int m_id;
 141
 142     /// Song object.
 143     KwSongdbSong* m_song;
 144
 145     /// Which fields have been modified.
 146     Fields m_modifiedFields;
 147
 148     /// Name of this version.
 149     QString m_name;
 150
 151     /// Name of the writer.
 152     QString m_writer;
 153
 154     /// Copyright notice.
 155     QString m_copyright;
 156
 157     /// Lyrics.
 158     KwSongdbLyrics m_lyrics;
 159
 160     /// Whether song book numbers have been loaded.
 161     bool m_songBookNumbersLoaded;
 162
 163     /// Song book numbers.
 164     QList<KwSongdbSongBookSong*> m_songBookNumbers;
 165 };
 166
 167 Q_DECLARE_OPERATORS_FOR_FLAGS(KwSongdbVersion::Fields)
 168
 169 #endif // _KwSongdbVersion_h_
 170