PoDoFo::PdfDestination Class Reference

#include <PdfDestination.h>

List of all members.

Public Member Functions

 PdfDestination (PdfVecObjects *pParent)
 PdfDestination (PdfObject *pObject)
 PdfDestination (const PdfPage *pPage, EPdfDestinationFit eFit=ePdfDestinationFit_Fit)
 PdfDestination (const PdfPage *pPage, const PdfRect &rRect)
 PdfDestination (const PdfPage *pPage, double dLeft, double dTop, double dZoom)
 PdfDestination (const PdfPage *pPage, EPdfDestinationFit eFit, double dValue)
 PdfDestination (const PdfDestination &rhs)
const PdfDestinationoperator= (const PdfDestination &rhs)
PdfPageGetPage ()
PdfObjectGetObject ()
const PdfObjectGetObject () const
void AddToDictionary (PdfDictionary &dictionary) const


Detailed Description

A destination in a PDF file. A destination can either be a page or an action.

See also:
PdfOutlineItem

PdfAnnotation

PdfDocument


Constructor & Destructor Documentation

PoDoFo::PdfDestination::PdfDestination ( PdfVecObjects pParent  ) 

Create an empty destination - points to nowhere

PoDoFo::PdfDestination::PdfDestination ( PdfObject pObject  ) 

Create a new PdfDestination from an existing PdfObject (such as loaded from a doc)

Parameters:
pObject the object to construct from

PoDoFo::PdfDestination::PdfDestination ( const PdfPage pPage,
EPdfDestinationFit  eFit = ePdfDestinationFit_Fit 
)

Create a new PdfDestination with a page as destination

Parameters:
pPage a page which is the destination
eFit fit mode for the page. Must be ePdfDestinationFit_Fit or ePdfDestinationFit_FitB

PoDoFo::PdfDestination::PdfDestination ( const PdfPage pPage,
const PdfRect rRect 
)

Create a destination to a page with its contents magnified to fit into the given rectangle

Parameters:
pPage a page which is the destination
rRect magnify the page so that the contents of the rectangle are visible

PoDoFo::PdfDestination::PdfDestination ( const PdfPage pPage,
double  dLeft,
double  dTop,
double  dZoom 
)

Create a new destination to a page with specified left and top coordinates and a zoom factor.

Parameters:
pPage a page which is the destination
dLeft left coordinate
dTop top coordinate
dZoom zoom factor in the viewer

PoDoFo::PdfDestination::PdfDestination ( const PdfPage pPage,
EPdfDestinationFit  eFit,
double  dValue 
)

Create a new destination to a page.

Parameters:
pPage a page which is the destination
eFit fit mode for the Page. Allowed values are ePdfDestinationFit_FitH, ePdfDestinationFit_FitV, ePdfDestinationFit_FitBH, ePdfDestinationFit_FitBV
dValue value which is a required argument for the selected fit mode

PoDoFo::PdfDestination::PdfDestination ( const PdfDestination rhs  ) 

Copy an existing PdfDestination

Parameters:
rhs copy this PdfDestination


Member Function Documentation

void PoDoFo::PdfDestination::AddToDictionary ( PdfDictionary &  dictionary  )  const

Adds this destination to an dictionary. This method handles the all the complexities of making sure it's added correctly

If this destination is empty. Nothing will be added.

Parameters:
dictionary the destination will be added to this dictionary

const PdfObject * PoDoFo::PdfDestination::GetObject (  )  const [inline]

Get access to the internal object This is an overloaded member function.

Returns:
the internal PdfObject

PdfObject * PoDoFo::PdfDestination::GetObject (  )  [inline]

Get access to the internal object

Returns:
the internal PdfObject

PdfPage * PoDoFo::PdfDestination::GetPage (  ) 

Get the page that this destination points to Requires that this PdfDestination was somehow created by or from a PdfDocument. Won't work otherwise.

Returns:
the referenced PdfPage

const PdfDestination & PoDoFo::PdfDestination::operator= ( const PdfDestination rhs  ) 

Copy an existing PdfDestination

Parameters:
rhs copy this PdfDestination
Returns:
this object


Generated on Wed May 6 08:17:04 2009 for PoDoFo by  doxygen 1.5.8