kworship/songdb/KwSongdbVersionItem.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 _KwSongdbVersionItem_h_
  21 #define _KwSongdbVersionItem_h_
  22
  23 /**
  24  * @file KwSongdbVersionItem.h
  25  * @brief A list widget item for a song version.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QObject>
  30 #include <QListWidgetItem>
  31 #include <QString>
  32 #include <QList>
  33
  34 class KwSongdbSong;
  35 class KwSongdbVersion;
  36 class KwSongdbSongBookSongItem;
  37
  38 /// A list widget item for a song version.
  39 class KwSongdbVersionItem : public QObject, public QListWidgetItem
  40 {
  41     Q_OBJECT
  42
  43   public:
  44
  45     /*
  46      * Constructors + destructor
  47      */
  48
  49     /// Construct a new song version.
  50     KwSongdbVersionItem(QListWidget* parent = 0);
  51
  52     /// Construct from an existing song version.
  53     KwSongdbVersionItem(KwSongdbVersion* version, QListWidget* parent = 0);
  54
  55     /// Destructor.
  56     virtual ~KwSongdbVersionItem();
  57
  58     /*
  59      * Accessors
  60      */
  61
  62     /// Get the song version.
  63     KwSongdbVersion* version();
  64
  65     /// Get the version name.
  66     QString versionName() const;
  67
  68     /// Get the name of the writer.
  69     QString writer() const;
  70
  71     /// Get the copyright notice.
  72     QString copyright() const;
  73
  74     /// Get the lyrics markup.
  75     QString lyricsMarkup() const;
  76
  77     /// Get the list of song book number items.
  78     QList<KwSongdbSongBookSongItem*> songBookNumbers();
  79
  80   public slots:
  81
  82     /*
  83      * Modifier slots
  84      */
  85
  86     /// Save the changes to the version object.
  87     void save(KwSongdbSong* song);
  88
  89     /// Set the version name.
  90     void setVersionName(const QString& name);
  91
  92     /// Set the name of the writer.
  93     void setWriter(const QString& writer);
  94
  95     /// Set the copyright notice.
  96     void setCopyright(const QString& copyright);
  97
  98     /// Set the lyrics markup.
  99     void setLyricsMarkup(const QString& lyricsMarkup);
 100
 101     /// Add a song book number.
 102     KwSongdbSongBookSongItem* addSongBookNumber();
 103
 104   private:
 105
 106     /*
 107      * Variables
 108      */
 109
 110     /// Original database version object.
 111     KwSongdbVersion* m_version;
 112
 113     /// Version name.
 114     QString m_name;
 115
 116     /// Writer.
 117     QString m_writer;
 118
 119     /// Copyright.
 120     QString m_copyright;
 121
 122     /// Lyrics markup.
 123     QString m_lyricsMarkup;
 124
 125     /// Song book numbers.
 126     QList<KwSongdbSongBookSongItem*> m_songBookNumbers;
 127
 128 };
 129
 130 #endif // _KwSongdbVersionItem_h_
 131