kworship/songdb/KwSongdbSongEditWidget.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 _KwSongdbSongEditWidget_h_
  21 #define _KwSongdbSongEditWidget_h_
  22
  23 /**
  24  * @file KwSongdbSongEditWidget.h
  25  * @brief Widget for editing a song.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "ui_KwSongdbSongEditWidget_base.h"
  30
  31 #include <QWidget>
  32
  33 class KwSongdbSong;
  34 class KwSongdbVersion;
  35 class KwSongdbVersionItem;
  36 class KwSongdbSongBook;
  37
  38 /** Widget for editing a song.
  39  * Allows editing of song information, song versions and lyrics.
  40  */
  41 class KwSongdbSongEditWidget : public QWidget, public Ui::KwSongdbSongEditWidget_base
  42 {
  43     Q_OBJECT
  44
  45   public:
  46
  47     /*
  48      * Constructors + destructor
  49      */
  50
  51     /// Default constructor.
  52     KwSongdbSongEditWidget();
  53
  54     /// Destructor.
  55     virtual ~KwSongdbSongEditWidget();
  56
  57   public slots:
  58
  59     /*
  60      * Saving and loading
  61      */
  62
  63     /// Load from database.
  64     void load(KwSongdbSong* song, KwSongdbVersion* selectedVersion = 0);
  65
  66     /// Save to database.
  67     void save();
  68
  69     /// Add a song version.
  70     void addVersion();
  71
  72   signals:
  73
  74     /*
  75      * Signals
  76      */
  77
  78     /// Emitted when the lyrics markup has changed.
  79     void lyricsMarkupChangedSignal(const QString& lyricsMarkup);
  80
  81     /// Emitted when the song book is changed.
  82     void songBookChangedSignal(KwSongdbSongBook* songBook);
  83
  84     /// Emitted when the changed state of the form changes.
  85     void changed(bool changed);
  86
  87   private slots:
  88
  89     /*
  90      * Private slots
  91      */
  92
  93     /// A different version has been selected.
  94     void versionChanged(QListWidgetItem* current, QListWidgetItem* previous);
  95
  96     /// A different song book number has been selected.
  97     void songBookNumberChanged(QListWidgetItem* current, QListWidgetItem* previous);
  98
  99     /// Lyrics markup edit box has been modified.
 100     void lyricsMarkupChanged();
 101
 102     /// Selected song book has changed.
 103     void songBookChanged(int index);
 104
 105     /// Button to edit song books has been clicked.
 106     void editSongBooksClicked();
 107
 108     /// Update the list of song books.
 109     void updateSongBooks();
 110
 111     /// Add a song book number to the version.
 112     void addSongBookNumber();
 113
 114     /// Remove the selected song book number.
 115     void removeSongBookNumber();
 116
 117   private:
 118
 119     /*
 120      * Variables
 121      */
 122
 123     /// Song object.
 124     KwSongdbSong* m_song;
 125
 126     /// Current version.
 127     KwSongdbVersionItem* m_currentVersion;
 128
 129 };
 130
 131 #endif // _KwSongdbSongEditWidget_h_