kworship/songdb/KwSongdbSongBookSong.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 _KwSongdbSongBookSong_h_
  21 #define _KwSongdbSongBookSong_h_
  22
  23 /**
  24  * @file KwSongdbSongBookSong.h
  25  * @brief A song book song from the database.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QString>
  30 #include <QFlags>
  31
  32 class KwSongdbSongBook;
  33 class KwSongdbVersion;
  34
  35 /// A song book song from the database.
  36 class KwSongdbSongBookSong
  37 {
  38   public:
  39
  40     /*
  41      * Types
  42      */
  43
  44     /// Version data fields.
  45     enum Field
  46     {
  47       SongBook = 0x1,
  48       SongNumber = 0x2,
  49       Version = 0x4
  50     };
  51     Q_DECLARE_FLAGS(Fields, Field)
  52
  53     /*
  54      * Constructors + destructor
  55      */
  56
  57     /** Construct a new song book song for database insertion.
  58      * This constructs a blank song book song which will be inserted into the
  59      * database when it is saved.
  60      */
  61     KwSongdbSongBookSong();
  62
  63     /** Construct from the database from data.
  64      * @param songBook Song book object.
  65      * @param songNumber Number in the song book that the song is.
  66      * @param version Version at the song position.
  67      */
  68     KwSongdbSongBookSong(KwSongdbSongBook* songBook, int songNumber, KwSongdbVersion* version);
  69
  70     /// Destructor.
  71     virtual ~KwSongdbSongBookSong();
  72
  73     /*
  74      * Accessors
  75      */
  76
  77     /// Get the song book.
  78     KwSongdbSongBook* songBook();
  79
  80     /// Get the song number in the song book.
  81     int songNumber() const;
  82
  83     /// Get the song version.
  84     KwSongdbVersion* version();
  85
  86     /*
  87      * Mutators
  88      */
  89
  90     /// Set the song book.
  91     void setSongBook(KwSongdbSongBook* songBook);
  92
  93     /// Set the song number in the song book.
  94     void setSongNumber(int songNumber);
  95
  96     /// Set the song version.
  97     void setVersion(KwSongdbVersion* version);
  98
  99     /// Save changes to the song book data.
 100     void save();
 101
 102   private:
 103
 104     /*
 105      * Variables
 106      */
 107
 108     /// Original song book id.
 109     int m_originalSongBookId;
 110
 111     /// Original song book number.
 112     int m_originalSongNumber;
 113
 114     /// Which fields have been modified.
 115     Fields m_modifiedFields;
 116
 117     /// Song book.
 118     KwSongdbSongBook* m_songBook;
 119
 120     /// Song book number.
 121     int m_songNumber;
 122
 123     /// Version.
 124     KwSongdbVersion* m_version;
 125 };
 126
 127 Q_DECLARE_OPERATORS_FOR_FLAGS(KwSongdbSongBookSong::Fields)
 128
 129 #endif // _KwSongdbSongBookSong_h_
 130