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