unipresent/common/UpSlideShow.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 _UpSlideShow_h_
  21 #define _UpSlideShow_h_
  22
  23 /**
  24  * @file UpSlideShow.h
  25  * @brief An abstract slideshow controller.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QObject>
  30
  31 class UpSlide;
  32
  33 /** An abstract slideshow controller.
  34  * Inherit from this class to implement each backend's slideshow controller.
  35  */
  36 class UpSlideShow : public QObject
  37 {
  38   Q_OBJECT
  39   public:
  40
  41     /*
  42      * Constructors + destructor
  43      */
  44
  45     /// Primary constructor.
  46     UpSlideShow(QObject* parent = 0);
  47
  48     /// Destructor.
  49     virtual ~UpSlideShow();
  50
  51     /*
  52      * Main interface
  53      */
  54
  55     /// Start the slideshow.
  56     virtual void start() = 0;
  57
  58     /// Stop the slideshow.
  59     virtual void stop() = 0;
  60
  61     /// Pause the slideshow.
  62     virtual void pause() = 0;
  63
  64     /// Resume the slideshow.
  65     virtual void resume() = 0;
  66
  67     /// Go to the next part of the slideshow.
  68     virtual void next() = 0;
  69
  70     /// Go to the previous part of the slideshow.
  71     virtual void previous() = 0;
  72
  73   signals:
  74
  75     /*
  76      * Signals
  77      */
  78
  79     /// The slideshow has changed slide.
  80     void changedSlide(UpSlide* previousSlide, UpSlide* currentSlide);
  81
  82     /// The current slide has been updated.
  83     void updatedSlide(UpSlide* slide);
  84 };
  85
  86 #endif // _UpSlideShow_h_
  87