Okular::PageTransition Class Reference

#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 (const PageTransition &other)
	PageTransition (Type type=Replace)
	~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 21 of file pagetransition.h.

Member Enumeration Documentation

Alignment

enum Okular::PageTransition::Alignment

Describes the alignment that is applied to the Type of transition effect.

Definition at line 33 of file pagetransition.h.

Direction

enum Okular::PageTransition::Direction

Describes the direction that is applied to the Type of transition effect.

Definition at line 39 of file pagetransition.h.

Type

enum Okular::PageTransition::Type

Describes the type of transition effect.

Definition at line 27 of file pagetransition.h.

Constructor & Destructor Documentation

PageTransition() [1/2]

PageTransition::PageTransition ( Type  type = Replace )

explicit

Creates a new page transition of the given type.

If no type is given, the normal Replace transition is used.

Definition at line 37 of file pagetransition.cpp.

PageTransition() [2/2]

PageTransition::PageTransition

(

const PageTransition &

other

)

Creates a new page transition from an other.

Definition at line 42 of file pagetransition.cpp.

~PageTransition()

PageTransition::~PageTransition

(

)

Destroys the page transition.

Definition at line 58 of file pagetransition.cpp.

Member Function Documentation

alignment()

PageTransition::Alignment PageTransition::alignment

(

)

const

Returns the alignment of the transition.

Definition at line 73 of file pagetransition.cpp.

angle()

int PageTransition::angle

(

)

const

Returns the angle of rotation of the transition.

Definition at line 83 of file pagetransition.cpp.

direction()

PageTransition::Direction PageTransition::direction

(

)

const

Returns the direction of motion of the transition.

Definition at line 78 of file pagetransition.cpp.

duration()

double PageTransition::duration

(

)

const

Returns the duration of the transition in seconds.

Definition at line 68 of file pagetransition.cpp.

isRectangular()

bool PageTransition::isRectangular

(

)

const

Returns true if the area to be flown is rectangular and opaque (Only if type == 'Fly').

Definition at line 93 of file pagetransition.cpp.

scale()

double PageTransition::scale

(

)

const

Returns the starting or ending scale (Only if type == 'Fly').

Definition at line 88 of file pagetransition.cpp.

setAlignment()

void PageTransition::setAlignment

(

Alignment

alignment

)

Sets the alignment of the transition (Alignment).

Definition at line 108 of file pagetransition.cpp.

setAngle()

void PageTransition::setAngle

(

int

angle

)

Sets the moving angle of the transition.

Definition at line 118 of file pagetransition.cpp.

setDirection()

void PageTransition::setDirection

(

Direction

direction

)

Sets the direction of the transition (.

See also

Direction).

Definition at line 113 of file pagetransition.cpp.

setDuration()

void PageTransition::setDuration

(

double

duration

)

Sets the duration in seconds for the transition.

Definition at line 103 of file pagetransition.cpp.

setIsRectangular()

void PageTransition::setIsRectangular

(

bool

rectangular

)

Sets whether the area to be flown is rectangular and opaque (Only if type == 'Fly').

Definition at line 128 of file pagetransition.cpp.

setScale()

void PageTransition::setScale

(

double

scale

)

Sets the starting or ending scale of the transition (Only if type == 'Fly').

Definition at line 123 of file pagetransition.cpp.

setType()

void PageTransition::setType

(

Type

type

)

Sets the type of the transition (Type).

Definition at line 98 of file pagetransition.cpp.

type()

PageTransition::Type PageTransition::type

(

)

const

Returns the type of the transition.

Definition at line 63 of file pagetransition.cpp.

---

The documentation for this class was generated from the following files:

• pagetransition.h
• pagetransition.cpp