kworship/songdb/KwSongdbSongBookSongItem.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 _KwSongdbSongBookSongItem_h_
  21 #define _KwSongdbSongBookSongItem_h_
  22
  23 /**
  24  * @file KwSongdbSongBookSongItem.h
  25  * @brief A list widget item for a song book song.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QObject>
  30 #include <QListWidgetItem>
  31
  32 class KwSongdbVersion;
  33 class KwSongdbSongBook;
  34 class KwSongdbSongBookSong;
  35
  36 /// A list widget item for a song book song.
  37 class KwSongdbSongBookSongItem : public QObject, public QListWidgetItem
  38 {
  39     Q_OBJECT
  40
  41   public:
  42
  43     /*
  44      * Constructors + destructor
  45      */
  46
  47     /// Construct a new song book song.
  48     KwSongdbSongBookSongItem(QListWidget* parent = 0);
  49
  50     /// Construct from an existing song book song.
  51     KwSongdbSongBookSongItem(KwSongdbSongBookSong* songBookSong, QListWidget* parent = 0);
  52
  53     /// Destructor.
  54     virtual ~KwSongdbSongBookSongItem();
  55
  56     /*
  57      * Accessors
  58      */
  59
  60     /// Get the song book.
  61     KwSongdbSongBook* songBook();
  62
  63     /// Get the song book number
  64     int songNumber() const;
  65
  66     /// Get the version.
  67     KwSongdbVersion* version();
  68
  69   public slots:
  70
  71     /*
  72      * Modifier slots
  73      */
  74
  75     /// Save the changes to the song book object.
  76     void save(KwSongdbVersion* version);
  77
  78     /// Set the song book.
  79     void setSongBook(KwSongdbSongBook* songBook);
  80
  81     /// Set the song book number.
  82     void setSongNumber(int songNumber);
  83
  84     /// Update the text.
  85     void updateText();
  86
  87   private:
  88
  89     /*
  90      * Variables
  91      */
  92
  93     /// Song book song object.
  94     KwSongdbSongBookSong* m_songBookSong;
  95
  96     /// Song book object.
  97     KwSongdbSongBook* m_songBook;
  98
  99     /// Song book number.
 100     int m_songNumber;
 101
 102     /// Version.
 103     KwSongdbVersion* m_version;
 104
 105 };
 106
 107 #endif // _KwSongdbSongBookSongItem_h_
 108