okular/core/movie.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Pino Toscano <pino@kde.org>                     *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  ***************************************************************************/
   9
  10 #ifndef _OKULAR_MOVIE_H_
  11 #define _OKULAR_MOVIE_H_
  12
  13 #include <okular/core/global.h>
  14 #include <okular/core/okular_export.h>
  15
  16 #include <QtCore/QSize>
  17
  18 namespace Okular {
  19
  20 /**
  21  * @short Contains information about a movie object.
  22  *
  23  * @since 0.8 (KDE 4.2)
  24  */
  25 class OKULAR_EXPORT Movie
  26 {
  27     public:
  28         /**
  29          * The play mode for playing the movie
  30          */
  31         enum PlayMode
  32         {
  33             PlayOnce,         ///< Play the movie once, closing the movie controls at the end
  34             PlayOpen,         ///< Like PlayOnce, but leaving the controls open
  35             PlayRepeat,       ///< Play continuously until stopped
  36             PlayPalindrome    ///< Play forward, then backward, then again foward and so on until stopped
  37         };
  38
  39         /**
  40          * Creates a new movie object with the given external @p fileName.
  41          */
  42         explicit Movie( const QString& fileName );
  43
  44         /**
  45          * Destroys the movie object.
  46          */
  47         ~Movie();
  48
  49         /**
  50          * Returns the url of the movie.
  51          */
  52         QString url() const;
  53
  54         /**
  55          * Sets the size for the movie.
  56          */
  57         void setSize( const QSize &aspect );
  58
  59         /**
  60          * Returns the size of the movie.
  61          */
  62         QSize size() const;
  63
  64         /**
  65          * Sets the @p rotation of the movie.
  66          */
  67         void setRotation( Rotation rotation );
  68
  69         /**
  70          * Returns the rotation of the movie.
  71          */
  72         Rotation rotation() const;
  73
  74         /**
  75          * Sets whether show a bar with movie controls
  76          */
  77         void setShowControls( bool show );
  78
  79         /**
  80          * Whether show a bar with movie controls
  81          */
  82         bool showControls() const;
  83
  84         /**
  85          * Sets the way the movie should be played
  86          */
  87         void setPlayMode( PlayMode mode );
  88
  89         /**
  90          * How to play the movie
  91          */
  92         PlayMode playMode() const;
  93
  94     private:
  95         class Private;
  96         Private* const d;
  97
  98         Q_DISABLE_COPY( Movie )
  99 };
 100
 101 }
 102
 103 #endif