kworship/songdb/KwSongdbSong.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 _KwSongdbSong_h_
  21 #define _KwSongdbSong_h_
  22
  23 /**
  24  * @file KwSongdbSong.h
  25  * @brief A song from the database.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwSongdbExport.h"
  30
  31 #include <QString>
  32 #include <QList>
  33
  34 class KwSongdbVersion;
  35
  36 /// A song from the database.
  37 class KWSONGDB_EXPORT KwSongdbSong
  38 {
  39   public:
  40
  41     /*
  42      * Types
  43      */
  44
  45     /// Version data fields.
  46     enum Field
  47     {
  48       Name = 0x1,
  49       AlternateName = 0x2
  50     };
  51     Q_DECLARE_FLAGS(Fields, Field)
  52
  53     /*
  54      * Constructors + destructor
  55      */
  56
  57     /** Construct a new song for database insertion.
  58      * This constructs a blank song which will be inserted into the
  59      * database when it is saved.
  60      */
  61     KwSongdbSong();
  62
  63     /** Construct from the database.
  64      * Loads the song information from the database.
  65      * @param id Database id of song.
  66      */
  67     KwSongdbSong(int id);
  68
  69     /// Destructor.
  70     virtual ~KwSongdbSong();
  71
  72     /*
  73      * Accessors
  74      */
  75
  76     /// Get the id.
  77     int id() const;
  78
  79     /// Get the name of the song.
  80     QString name() const;
  81
  82     /// Get the alternate name of the song.
  83     QString alternateName() const;
  84
  85     /// Get list of song versions.
  86     QList<KwSongdbVersion*> versions();
  87
  88     /*
  89      * Mutators
  90      */
  91
  92     /// Set the name.
  93     void setName(const QString& name);
  94
  95     /// Set the alternate name.
  96     void setAlternateName(const QString& name);
  97
  98     /// Save changes to the song data.
  99     void save();
 100
 101     /// Register a version object.
 102     void registerVersion(KwSongdbVersion* version);
 103
 104   private:
 105
 106     /*
 107      * Variables
 108      */
 109
 110     /// Song id.
 111     int m_id;
 112
 113     /// Which fields have been modified.
 114     Fields m_modifiedFields;
 115
 116     /// Name.
 117     QString m_name;
 118
 119     /// Alternate name.
 120     QString m_alternateName;
 121
 122     /// Whether versions have been loaded.
 123     bool m_versionsLoaded;
 124
 125     /// Version ids.
 126     QList<int> m_versionIds;
 127 };
 128
 129 Q_DECLARE_OPERATORS_FOR_FLAGS(KwSongdbSong::Fields)
 130
 131 #endif // _KwSongdbSong_h_
 132