unipresent/common/UpSlide.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 _UpSlide_h_
  21 #define _UpSlide_h_
  22
  23 /**
  24  * @file UpSlide.h
  25  * @brief An abstract presentation slide.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "UpExport.h"
  30
  31 #include <QObject>
  32 #include <QPixmap>
  33
  34 class QTextDocument;
  35
  36 /** An abstract presentation slide.
  37  * Inherit from this class to implement each backend's presentation slide.
  38  */
  39 class UNIPRESENT_EXPORT UpSlide : public QObject
  40 {
  41   Q_OBJECT
  42   public:
  43
  44     /*
  45      * Constructors + destructor
  46      */
  47
  48     /// Primary constructor.
  49     UpSlide(QObject* parent = 0);
  50
  51     /// Destructor.
  52     virtual ~UpSlide();
  53
  54     /*
  55      * Main interface
  56      */
  57
  58     /// Get the slide's title.
  59     virtual QString title();
  60
  61     /// Get outline text.
  62     virtual QString outline();
  63
  64     /** Write notes into a text document.
  65      * Clears the document if returns false.
  66      *
  67      * @param doc Text document to write notes into.
  68      * @return Whether the slide had any notes to write.
  69      */
  70     virtual bool writeNotes(QTextDocument* doc);
  71
  72     /// Get preview pixmap.
  73     virtual QPixmap preview();
  74
  75 };
  76
  77 #endif // _UpSlide_h_
  78