kworship/songdb/KwSongdbLyricsLayout.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 _KwSongdbLyricsLayout_h_
  21 #define _KwSongdbLyricsLayout_h_
  22
  23 /**
  24  * @file KwSongdbLyricsLayout.h
  25  * @brief Manipulates a layout of lyrics.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwSongdbLyrics.h"
  30
  31 /// Manipulates a layout of lyrics.
  32 class KwSongdbLyricsLayout
  33 {
  34   public:
  35
  36     /*
  37      * Constructors + destructor
  38      */
  39
  40     /// Primary constructor.
  41     explicit KwSongdbLyricsLayout(const KwSongdbLyrics& lyrics);
  42
  43     /// Destructor.
  44     virtual ~KwSongdbLyricsLayout();
  45
  46     /*
  47      * Pagination
  48      */
  49
  50     /// Get the number of pages.
  51     int numPages() const;
  52
  53     /// Get the plain text content of a page.
  54     QString pageContent(int page) const;
  55
  56   private:
  57
  58     /*
  59      * Variables
  60      */
  61
  62     /// Lyrics.
  63     const KwSongdbLyrics& m_lyrics;
  64
  65     /// Pages cache.
  66     QStringList m_pageCache;
  67 };
  68
  69 #endif // _KwSongdbLyricsLayout_h_
  70