kworship/songdb/KwSongdbLyrics.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 _KwSongdbLyrics_h_
  21 #define _KwSongdbLyrics_h_
  22
  23 /**
  24  * @file KwSongdbLyrics.h
  25  * @brief Contains and manupulates a set of song lyrics.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwSongdbExport.h"
  30
  31 #include <QString>
  32 #include <QStringList>
  33
  34 /// Contains and manupulates a set of song lyrics.
  35 class KWSONGDB_EXPORT KwSongdbLyrics
  36 {
  37   public:
  38
  39     /*
  40      * Constructors + destructor
  41      */
  42
  43     /// Default constructor.
  44     KwSongdbLyrics();
  45
  46     /// Primary constructor.
  47     KwSongdbLyrics(const QString& markup);
  48
  49     /// Destructor.
  50     virtual ~KwSongdbLyrics();
  51
  52     /*
  53      * Accessors
  54      */
  55
  56     /// Get the markup for these lyrics.
  57     QString markup() const;
  58
  59     /// Get verses of lyrics in plain text.
  60     QStringList plainVerses() const;
  61
  62     /*
  63      * Mutators
  64      */
  65
  66     /// Set the lyrics from markup.
  67     void setMarkup(const QString& markup);
  68
  69     /// Set the lyrics from plain text verses.
  70     void setPlainVerses(const QStringList& plainVerses);
  71
  72     /*
  73      * Equality + inequality operators
  74      */
  75
  76     /// Equals operator.
  77     bool operator == (const KwSongdbLyrics& rhs) const
  78     {
  79       return m_markup == rhs.m_markup;
  80     }
  81     /// Not equals operator.
  82     bool operator != (const KwSongdbLyrics& rhs) const
  83     {
  84       return m_markup != rhs.m_markup;
  85     }
  86
  87   private:
  88
  89     /*
  90      * Variables
  91      */
  92
  93     /// Source lyric markup.
  94     QString m_markup;
  95 };
  96
  97 #endif // _KwSongdbLyrics_h_
  98