unipresent/okular/UpOkPresentation.h

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008-2009 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 _UpOkPresentation_h_
  21 #define _UpOkPresentation_h_
  22
  23 /**
  24  * @file UpOkPresentation.h
  25  * @brief Okular presentation.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "UpPresentation.h"
  30
  31 #include <QDBusInterface>
  32
  33 class UpOkBackend;
  34
  35 /// Okular presentation.
  36 class UpOkPresentation : public UpPresentation
  37 {
  38   Q_OBJECT
  39   public:
  40
  41     /*
  42      * Constructors + destructor
  43      */
  44
  45     /// Primary constructor.
  46     UpOkPresentation(QString service, UpOkBackend* backend, QObject* parent = 0);
  47
  48     /// Destructor.
  49     virtual ~UpOkPresentation();
  50
  51     /*
  52      * Main interface
  53      */
  54
  55     virtual void close();
  56     virtual QUrl url() const;
  57
  58     /*
  59      * Custom slideshows
  60      */
  61
  62     virtual QString currentSlideshow();
  63     virtual QStringList slideshows();
  64     virtual void setSlideshow(QString slideshow);
  65     virtual int numSlides();
  66     virtual UpSlide* slide(int index);
  67
  68     /*
  69      * Slideshow accessors
  70      */
  71
  72     virtual bool isSlideshowRunning();
  73     virtual int numSlidesInSlideshow();
  74     virtual int currentSlideshowSlide();
  75     virtual int stepsInCurrentSlideshowSlide();
  76     virtual int currentSlideshowStep();
  77
  78     /*
  79      * Slideshow control
  80      */
  81
  82     virtual void startSlideshow();
  83     virtual void stopSlideshow();
  84     virtual void goToSlide(int index);
  85     virtual void previousSlide();
  86     virtual void nextSlide();
  87     virtual void previousStep();
  88     virtual void nextStep();
  89
  90     /*
  91      * Backend specific interface.
  92      */
  93
  94     /// Get the dbus interface.
  95     QDBusInterface& dbus();
  96
  97   private:
  98
  99     /*
 100      * Variables
 101      */
 102
 103     /// Main DBus interface.
 104     QDBusInterface m_dbus;
 105
 106     /// Url.
 107     QUrl m_url;
 108
 109     /// Slideshow running.
 110     bool m_running;
 111 };
 112
 113 #endif // _UpOkPresentation_h_
 114