KDE 4.0 API Reference okular
Okular::PageTransition Class Reference
#include <pagetransition.h>
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.
Public Types | |
| enum | Type { Replace, Split, Blinds, Box, Wipe, Dissolve, Glitter, Fly, Push, Cover, Uncover, Fade } |
| enum | Alignment { Horizontal, Vertical } |
| enum | Direction { Inward, Outward } |
Public Member Functions | |
| PageTransition (Type type=Replace) | |
| PageTransition (const PageTransition &other) | |
| PageTransition & | operator= (const PageTransition &other) |
| ~PageTransition () | |
| Type | type () const |
| int | duration () const |
| Alignment | alignment () const |
| Direction | direction () const |
| int | angle () const |
| double | scale () const |
| bool | isRectangular () const |
| void | setType (Type type) |
| void | setDuration (int duration) |
| void | setAlignment (Alignment alignment) |
| void | setDirection (Direction direction) |
| void | setAngle (int angle) |
| void | setScale (double scale) |
| void | setIsRectangular (bool rectangular) |
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.
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 | ) |
| PageTransition::~PageTransition | ( | ) |
Member Function Documentation
| PageTransition & PageTransition::operator= | ( | const PageTransition & | other | ) |
Definition at line 50 of file pagetransition.cpp.
| PageTransition::Type PageTransition::type | ( | ) | const |
| int PageTransition::duration | ( | ) | const |
Returns the duration of the transition in seconds.
Definition at line 70 of file pagetransition.cpp.
| PageTransition::Alignment PageTransition::alignment | ( | ) | const |
| PageTransition::Direction PageTransition::direction | ( | ) | const |
Returns the direction of motion of the transition.
Definition at line 80 of file pagetransition.cpp.
| int PageTransition::angle | ( | ) | const |
| double PageTransition::scale | ( | ) | const |
Returns the starting or ending scale (Only if type == 'Fly').
Definition at line 90 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.
| void PageTransition::setType | ( | Type | type | ) |
| void PageTransition::setDuration | ( | int | duration | ) |
| void PageTransition::setAlignment | ( | Alignment | alignment | ) |
Sets the alignment of the transition (Alignment).
Definition at line 110 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::setAngle | ( | int | angle | ) |
| 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::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.
The documentation for this class was generated from the following files:
