unipresent/common/UpPresentation.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 3 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, see <http://www.gnu.org/licenses/>.     *
  17  ***************************************************************************/
  18
  19 #ifndef _UpPresentation_h_
  20 #define _UpPresentation_h_
  21
  22 /**
  23  * @file UpPresentation.h
  24  * @brief An abstract presentation document.
  25  * @author James Hogan <james@albanarts.com>
  26  */
  27
  28 #include <QObject>
  29 #include <QUrl>
  30
  31 class UpSlide;
  32
  33 /** An abstract presentation document.
  34  * Inherit from this class to implement each backend's presentation.
  35  */
  36 class UpPresentation : public QObject
  37 {
  38   Q_OBJECT
  39   public:
  40
  41     /*
  42      * Constructors + destructor
  43      */
  44
  45     /// Primary constructor.
  46     UpPresentation(QObject* parent = 0);
  47
  48     /// Destructor.
  49     virtual ~UpPresentation();
  50
  51     /*
  52      * Main interface
  53      */
  54
  55     /// Close this presentation.
  56     virtual void close() = 0;
  57
  58     /// Get the url.
  59     virtual QUrl url() const = 0;
  60
  61     /*
  62      * Slides
  63      */
  64
  65     /// Get the number of slides in this presentation.
  66     virtual int numSlides() = 0;
  67
  68     /// Get a specific slide.
  69     virtual UpSlide* slide(int) = 0;
  70 };
  71
  72 #endif // _UpPresentation_h_
  73