unipresent/kpresenter1/UpKpr1Presentation.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 _UpKpr1Presentation_h_
  21 #define _UpKpr1Presentation_h_
  22
  23 /**
  24  * @file UpKpr1Presentation.h
  25  * @brief KPresenter 1 presentation.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "UpKpr1PresentationDcop.h"
  30 #include "UpKpr1ViewDcop.h"
  31 #include "UpPresentation.h"
  32
  33 class UpKpr1Backend;
  34
  35 /** KPresenter 1 presentation.
  36  * @todo We could do a lot more caching in this class to avoid repeated dcop
  37  *       terminal commands.
  38  */
  39 class UpKpr1Presentation : public UpPresentation
  40 {
  41   Q_OBJECT
  42   public:
  43
  44     /*
  45      * Constructors + destructor
  46      */
  47
  48     /// Primary constructor.
  49     UpKpr1Presentation(const UpKpr1PresentationDcop& dcop, const UpKpr1ViewDcop& dcopView, UpKpr1Backend* parent = 0);
  50
  51     /// Destructor.
  52     virtual ~UpKpr1Presentation();
  53
  54     /*
  55      * Main interface
  56      */
  57
  58     virtual void close();
  59     virtual QUrl url() const;
  60
  61     /*
  62      * Custom slideshows
  63      */
  64
  65     virtual QString currentSlideshow();
  66     virtual QStringList slideshows();
  67     virtual void setSlideshow(QString slideshow);
  68     virtual int numSlides();
  69     virtual UpSlide* slide(int index);
  70
  71     /*
  72      * Slideshow accessors
  73      */
  74
  75     virtual bool isSlideshowRunning();
  76     virtual int numSlidesInSlideshow();
  77     virtual int currentSlideshowSlide();
  78     virtual int stepsInCurrentSlideshowSlide();
  79     virtual int currentSlideshowStep();
  80
  81     /*
  82      * Slideshow control
  83      */
  84
  85     virtual void startSlideshow();
  86     virtual void stopSlideshow();
  87     virtual void goToSlide(int index);
  88     virtual void previousSlide();
  89     virtual void nextSlide();
  90     virtual void previousStep();
  91     virtual void nextStep();
  92
  93     /*
  94      * Backend specific interface.
  95      */
  96
  97     /// Get the dcop interface.
  98     UpKpr1PresentationDcop dcop() const;
  99
 100     /// Get the dcop view interface.
 101     UpKpr1ViewDcop dcopView() const;
 102
 103   private:
 104
 105     /*
 106      * Variables
 107      */
 108
 109     /// DCOP interface.
 110     UpKpr1PresentationDcop m_dcop;
 111
 112     /// DCOP view interface.
 113     UpKpr1ViewDcop m_dcopView;
 114
 115     /// Url.
 116     QUrl m_url;
 117
 118     /*
 119      * Helpers
 120      */
 121
 122     /// Signal that the slide has changed.
 123     void signalChangedSlide(int slide = -1, int step = -1);
 124
 125     /// Signal that the step has changed.
 126     void signalChangedStep(int step = -1);
 127 };
 128
 129 #endif // _UpKpr1Presentation_h_
 130