Poppler Qt5  0.74.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 
48 class POPPLER_QT5_EXPORT PageTransition {
49  public:
50 
53  // if changed remember to keep in sync with PageTransition.h enum
54  enum Type {
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  Horizontal = 0,
74  Vertical
75  };
76 
79  // if changed remember to keep in sync with PageTransition.h enum
80  enum Direction {
81  Inward = 0,
82  Outward
83  };
84 
100  // TODO Next ABI break, make this private and remove reference
101  PageTransition(const PageTransitionParams &params);
102 
104  PageTransition(const PageTransition &pt);
105 
107  PageTransition& operator=(const PageTransition &other);
108 
112  ~PageTransition();
113 
117  Type type() const;
118 
124  Q_DECL_DEPRECATED int duration() const;
125 
129  double durationReal() const;
130 
134  Alignment alignment() const;
135 
139  Direction direction() const;
140 
144  int angle() const;
145 
149  double scale() const;
150 
155  bool isRectangular() const;
156 
157  private:
158  PageTransitionData *data;
159 };
160 
161 }
162 
163 #endif
Type
transition effect that shall be used
Definition: poppler-page-transition.h:54
Direction
direction of the transition effect that shall be used
Definition: poppler-page-transition.h:80
Alignment
alignment of the transition effect that shall be used
Definition: poppler-page-transition.h:72
The Poppler Qt5 binding.
Definition: poppler-annotation.h:45
Describes how a PDF file viewer shall perform the transition from one page to another.
Definition: poppler-page-transition.h:48