Poppler Qt5  21.05.0
poppler-page-transition.h
1 /* PageTransition.h
2  * Copyright (C) 2005, Net Integration Technologies, Inc.
3  * Copyright (C) 2005, Brad Hards <bradh@frogmouth.net>
4  * Copyright (C) 2015, Arseniy Lartsev <arseniy@alumni.chalmers.se>
5  * Copyright (C) 2018 Albert Astals Cid <aacid@kde.org>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
20  */
21 
22 #ifndef __PAGETRANSITION_X_H__
23 #define __PAGETRANSITION_X_H__
24 
25 #include "poppler-export.h"
26 
27 #include <QtCore/qglobal.h>
28 
29 namespace Poppler {
30 
31 class PageTransitionParams;
32 class PageTransitionData;
33 
47 class POPPLER_QT5_EXPORT PageTransition
48 {
49 public:
52  // if changed remember to keep in sync with PageTransition.h enum
53  enum Type
54  {
55  Replace = 0,
56  Split,
57  Blinds,
58  Box,
59  Wipe,
60  Dissolve,
61  Glitter,
62  Fly,
63  Push,
64  Cover,
65  Uncover,
66  Fade
67  };
68 
71  // if changed remember to keep in sync with PageTransition.h enum
72  enum Alignment
73  {
74  Horizontal = 0,
75  Vertical
76  };
77 
80  // if changed remember to keep in sync with PageTransition.h enum
81  enum Direction
82  {
83  Inward = 0,
84  Outward
85  };
86 
102  // TODO Next ABI break, make this private and remove reference
103  PageTransition(const PageTransitionParams &params);
104 
107 
110 
115 
119  Type type() const;
120 
126  Q_DECL_DEPRECATED int duration() const;
127 
131  double durationReal() const;
132 
137 
142 
146  int angle() const;
147 
151  double scale() const;
152 
157  bool isRectangular() const;
158 
159 private:
160  PageTransitionData *data;
161 };
162 
163 }
164 
165 #endif
Describes how a PDF file viewer shall perform the transition from one page to another.
Definition: poppler-page-transition.h:48
Direction
direction of the transition effect that shall be used
Definition: poppler-page-transition.h:82
Alignment
alignment of the transition effect that shall be used
Definition: poppler-page-transition.h:73
Type
transition effect that shall be used
Definition: poppler-page-transition.h:54
Type type() const
Get type of the transition.
int angle() const
Get direction in which the transition effect moves.
Alignment alignment() const
Get dimension in which the transition effect occurs.
PageTransition(const PageTransition &pt)
copy constructor
Direction direction() const
Get direction of motion of the transition effect.
~PageTransition()
Destructor.
double durationReal() const
Get duration of the transition in seconds.
int duration() const
Get duration of the transition in seconds as integer.
double scale() const
Get starting or ending scale.
PageTransition & operator=(const PageTransition &other)
assignment operator
bool isRectangular() const
Returns true if the area to be flown is rectangular and opaque.
PageTransition(const PageTransitionParams &params)
Construct a new PageTransition object from a page dictionary.
The Poppler Qt5 binding.
Definition: poppler-annotation.h:47