#include <pagetransition.h>
Public Types | |
| enum | Alignment { Horizontal, Vertical } |
| enum | Direction { Inward, Outward } |
| enum | Type { Replace, Split, Blinds, Box, Wipe, Dissolve, Glitter, Fly, Push, Cover, Uncover, Fade } |
Public Member Functions | |
| PageTransition (Type type=Replace) | |
| PageTransition (const PageTransition &other) | |
| ~PageTransition () | |
| Alignment | alignment () const |
| int | angle () const |
| Direction | direction () const |
| double | duration () const |
| bool | isRectangular () const |
| PageTransition & | operator= (const PageTransition &other) |
| double | scale () const |
| void | setAlignment (Alignment alignment) |
| void | setAngle (int angle) |
| void | setDirection (Direction direction) |
| void | setDuration (double duration) |
| void | setIsRectangular (bool rectangular) |
| void | setScale (double scale) |
| void | setType (Type type) |
| Type | type () const |
Detailed Description
Information object for the transition effect of a page.
This class encapsulates the information about the effect of a page transition. It supports mainly the transition effects as defined in PDF specification 1.6.
Definition at line 24 of file pagetransition.h.
Member Enumeration Documentation
Describes the alignment that is applied to the Type of transition effect.
Definition at line 49 of file pagetransition.h.
Describes the direction that is applied to the Type of transition effect.
Definition at line 58 of file pagetransition.h.
Describes the type of transition effect.
Definition at line 30 of file pagetransition.h.
Constructor & Destructor Documentation
| PageTransition::PageTransition | ( | Type | type = Replace | ) |
Creates a new page transition of the given type.
If no type is given, the normal Replace transition is used.
Definition at line 40 of file pagetransition.cpp.
| PageTransition::PageTransition | ( | const PageTransition & | other | ) |
Creates a new page transition from an other.
Definition at line 45 of file pagetransition.cpp.
| PageTransition::~PageTransition | ( | ) |
Destroys the page transition.
Definition at line 60 of file pagetransition.cpp.
Member Function Documentation
| PageTransition::Alignment PageTransition::alignment | ( | ) | const |
Returns the alignment of the transition.
Definition at line 75 of file pagetransition.cpp.
| int PageTransition::angle | ( | ) | const |
Returns the angle of rotation of the transition.
Definition at line 85 of file pagetransition.cpp.
| PageTransition::Direction PageTransition::direction | ( | ) | const |
Returns the direction of motion of the transition.
Definition at line 80 of file pagetransition.cpp.
| double PageTransition::duration | ( | ) | const |
Returns the duration of the transition in seconds.
Definition at line 70 of file pagetransition.cpp.
| bool PageTransition::isRectangular | ( | ) | const |
Returns true if the area to be flown is rectangular and opaque (Only if type == 'Fly').
Definition at line 95 of file pagetransition.cpp.
| double PageTransition::scale | ( | ) | const |
Returns the starting or ending scale (Only if type == 'Fly').
Definition at line 90 of file pagetransition.cpp.
| void PageTransition::setAlignment | ( | Alignment | alignment | ) |
Sets the alignment of the transition (Alignment).
Definition at line 110 of file pagetransition.cpp.
| void PageTransition::setAngle | ( | int | angle | ) |
Sets the moving angle of the transition.
Definition at line 120 of file pagetransition.cpp.
| void PageTransition::setDirection | ( | Direction | direction | ) |
Sets the direction of the transition (.
- See also
- Direction).
Definition at line 115 of file pagetransition.cpp.
| void PageTransition::setDuration | ( | double | duration | ) |
Sets the duration in seconds for the transition.
Definition at line 105 of file pagetransition.cpp.
| void PageTransition::setIsRectangular | ( | bool | rectangular | ) |
Sets whether the area to be flown is rectangular and opaque (Only if type == 'Fly').
Definition at line 130 of file pagetransition.cpp.
| void PageTransition::setScale | ( | double | scale | ) |
Sets the starting or ending scale of the transition (Only if type == 'Fly').
Definition at line 125 of file pagetransition.cpp.
| void PageTransition::setType | ( | Type | type | ) |
Sets the type of the transition (Type).
Definition at line 100 of file pagetransition.cpp.
| PageTransition::Type PageTransition::type | ( | ) | const |
Returns the type of the transition.
Definition at line 65 of file pagetransition.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2019 The KDE developers.
Generated on Sun Dec 8 2019 03:39:05 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.