okular/core/pagetransition.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Tobias Koenig <tokoe@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_PAGETRANSITION_H_
  11 #define _OKULAR_PAGETRANSITION_H_
  12
  13 #include <okular/core/okular_export.h>
  14
  15 namespace Okular {
  16
  17 /**
  18  * @short Information object for the transition effect of a page.
  19  *
  20  * This class encapsulates the information about the effect of
  21  * a page transition. It supports mainly the transition effects as
  22  * defined in PDF specification 1.6.
  23  */
  24 class OKULAR_EXPORT PageTransition
  25 {
  26     public:
  27         /**
  28          * Describes the type of transition effect.
  29          */
  30         enum Type {
  31             Replace,
  32             Split,
  33             Blinds,
  34             Box,
  35             Wipe,
  36             Dissolve,
  37             Glitter,
  38             Fly,
  39             Push,
  40             Cover,
  41             Uncover,
  42             Fade
  43         };
  44
  45         /**
  46          * Describes the alignment that is applied to the @ref Type
  47          * of transition effect.
  48          */
  49         enum Alignment {
  50             Horizontal,
  51             Vertical
  52         };
  53
  54         /**
  55          * Describes the direction that is applied to the @ref Type
  56          * of transition effect.
  57          */
  58         enum Direction {
  59             Inward,
  60             Outward
  61         };
  62
  63         /**
  64          * Creates a new page transition of the given @p type.
  65          *
  66          * If no type is given, the normal @ref Replace transition is used.
  67          */
  68         PageTransition( Type type = Replace );
  69
  70         /**
  71          * Creates a new page transition from an @p other.
  72          */
  73         PageTransition( const PageTransition &other );
  74         PageTransition& operator=( const PageTransition &other );
  75
  76         /**
  77          * Destroys the page transition.
  78          */
  79         ~PageTransition();
  80
  81         /**
  82          * Returns the type of the transition.
  83          */
  84         Type type() const;
  85
  86         /**
  87          * Returns the duration of the transition in seconds.
  88          */
  89         int duration() const;
  90
  91         /**
  92          * Returns the alignment of the transition.
  93          */
  94         Alignment alignment() const;
  95
  96         /**
  97          * Returns the direction of motion of the transition.
  98          */
  99         Direction direction() const;
 100
 101         /**
 102          * Returns the angle of rotation of the transition.
 103          */
 104         int angle() const;
 105
 106         /**
 107          * Returns the starting or ending scale (Only if type == 'Fly').
 108          */
 109         double scale() const;
 110
 111         /**
 112          * Returns true if the area to be flown is rectangular and opaque (Only if type == 'Fly').
 113          */
 114         bool isRectangular() const;
 115
 116         /**
 117          * Sets the @p type of the transition (@ref Type).
 118          */
 119         void setType( Type type );
 120
 121         /**
 122          * Sets the @p duration in seconds for the transition.
 123          */
 124         void setDuration( int duration );
 125
 126         /**
 127          * Sets the @p alignment of the transition (@ref Alignment).
 128          */
 129         void setAlignment( Alignment alignment );
 130
 131         /**
 132          * Sets the @p direction of the transition (@see Direction).
 133          */
 134         void setDirection( Direction direction );
 135
 136         /**
 137          * Sets the moving @p angle of the transition.
 138          */
 139         void setAngle( int angle );
 140
 141         /**
 142          * Sets the starting or ending scale of the transition (Only if type == 'Fly').
 143          */
 144         void setScale( double scale );
 145
 146         /**
 147          * Sets whether the area to be flown is rectangular and opaque (Only if type == 'Fly').
 148          */
 149         void setIsRectangular( bool rectangular );
 150
 151     private:
 152         class Private;
 153         Private* const d;
 154 };
 155
 156 }
 157
 158 #endif