unipresent/kpresenter1/UpKpr1PresentationDcop.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 _UpKpr1PresentationDcop_h_
  21 #define _UpKpr1PresentationDcop_h_
  22
  23 /**
  24  * @file UpKpr1PresentationDcop.h
  25  * @brief DCOP interface for a kpresenter document.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "UpKpr1Dcop.h"
  30 #include "UpKpr1SlideDcop.h"
  31 #include "UpKpr1ViewDcop.h"
  32
  33 #include <QUrl>
  34
  35 /// DCOP interface for a kpresenter document.
  36 class UpKpr1PresentationDcop : public UpKpr1Dcop
  37 {
  38   public:
  39
  40     /*
  41      * Constructors + destructor
  42      */
  43
  44     /// Primary constructor.
  45     UpKpr1PresentationDcop(const UpKpr1Dcop& interface);
  46
  47     /// Destructor.
  48     virtual ~UpKpr1PresentationDcop();
  49
  50     /*
  51      * Main interface
  52      */
  53
  54     /// Get the document url.
  55     QUrl url() const;
  56
  57     /// Get the number of slides.
  58     int numPages() const;
  59
  60     /// Get a particular slide by id.
  61     UpKpr1SlideDcop slide(int index) const;
  62
  63     /// Get the view for this presentation.
  64     UpKpr1ViewDcop view(int index = 0) const;
  65
  66   private:
  67
  68     /*
  69      * Variables
  70      */
  71
  72     /// Document id.
  73     int m_docId;
  74
  75     /// Document url.
  76     QUrl m_url;
  77 };
  78
  79 #endif // _UpKpr1PresentationDcop_h_
  80