kworship/songdb/KwSongdbSongEditDialog.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 _KwSongdbSongEditDialog_h_
  21 #define _KwSongdbSongEditDialog_h_
  22
  23 /**
  24  * @file KwSongdbSongEditDialog.h
  25  * @brief Dialog for editing a song.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <KDialog>
  30
  31 class KwSongdbSong;
  32 class KwSongdbVersion;
  33 class KwSongdbSongEditWidget;
  34
  35 /** Dialog for editing a song.
  36  * Allows editing of song information, song versions and lyrics.
  37  */
  38 class KwSongdbSongEditDialog : public KDialog
  39 {
  40     Q_OBJECT
  41
  42   public:
  43
  44     /*
  45      * Constructors + destructor
  46      */
  47
  48     /** Construct a dialog box to edit a song.
  49      * @param song The song to load into the dialog and save to.
  50      *             If song == 0, the dialog box creates a new song.
  51      * @param version The version to default to editing.
  52      */
  53     KwSongdbSongEditDialog(KwSongdbSong* song, KwSongdbVersion* version = 0);
  54
  55     /// Destructor.
  56     virtual ~KwSongdbSongEditDialog();
  57
  58   private:
  59
  60     /*
  61      * Variables
  62      */
  63
  64     /// Main widget in dialog.
  65     KwSongdbSongEditWidget* m_view;
  66
  67     /// Database song.
  68     KwSongdbSong* m_song;
  69 };
  70
  71 #endif // _KwSongdbSongEditDialog_h_