IPDFHyperlinks::PageDestination Class Reference

#include <IPDFHyperlinks.h>

Public Member Functions
	PageDestination ()
	PageDestination (const uint32 pageIndex, const DestinationType destinationType, const PMRect &destinationRect, const PMReal &zoomFactor)
uint32	GetPageIndex () const
DestinationType	GetDestinationType () const
const PMRect &	GetDestinationRect () const
PMReal	GetZoomFactor () const
bool32	GetInheritRect () const
bool32	GetInheritZoom () const

Detailed Description

Contains the page index along with destination parameters and specifies where

the hyperlink goes in the other document.

Constructor & Destructor Documentation

IPDFHyperlinks::PageDestination::PageDestination ( )

inline

Construct a default PageDestination object.

IPDFHyperlinks::PageDestination::PageDestination ( const uint32  pageIndex, const DestinationType  destinationType, const PMRect &  destinationRect, const PMReal &  zoomFactor  )

inline

Construct a PageDestination object.

Parameters

pageIndex	is the destination page index.
destinationType	is the destination type.
destinationRect	is the destination rectangle.
zoomFactor	is the destination zoom factor.
inheritRect	is the destination inherit rectangle.
inheritZoom	is the destination inherit zoom factor.

Member Function Documentation

const PMRect& IPDFHyperlinks::PageDestination::GetDestinationRect ( ) const

inline

Get the destination rectangle.

Returns

the destination rectangle.

DestinationType IPDFHyperlinks::PageDestination::GetDestinationType ( ) const

inline

Get the destination page type.

Returns

the destination type.

bool32 IPDFHyperlinks::PageDestination::GetInheritRect ( ) const

inline

Get the destination inherit rectangle.

Returns

the destination inherit rectangle.

bool32 IPDFHyperlinks::PageDestination::GetInheritZoom ( ) const

inline

Get the destination inherit zoom factor.

Returns

the destination inherit zoom factor.

uint32 IPDFHyperlinks::PageDestination::GetPageIndex ( ) const

inline

Get the destination page index.

Returns

the destination page.

PMReal IPDFHyperlinks::PageDestination::GetZoomFactor ( ) const

inline

Get the destination zoom factor.

Returns

the destination zoom factor.