#include <PdfDestination.h>
List of all members.
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
Create an empty destination - points to nowhere
Create a new PdfDestination from an existing PdfObject (such as loaded from a doc)
- Parameters:
-
pObject | the object to construct from |
pDocument | a PDF document owning this destination, needed to resolve pages |
Create a new PdfDestination from an existing PdfObject (such as loaded from a doc)
- Parameters:
-
pObject | the object to construct from |
pVecObjects | a PdfVecObjects owning this destination, needed to resolve pages |
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 |
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 |
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 |
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 |
Member Function Documentation
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 |
Get access to the internal array
- Returns:
- the internal PdfArray
Get access to the internal array This is an overloaded member function.
- Returns:
- the internal PdfArray
Get the destination Value Destination must be of type FitH, FitV or FitBH, otherwise exception is thrown
- Returns:
- the destination Value
Get the destination Left position Destination must be of type XYZ, FitV or FitR otherwise exception is thrown.
- Returns:
- the Left position
Get access to the internal object
- Returns:
- the internal PdfObject
Get access to the internal object This is an overloaded member function.
- Returns:
- the internal PdfObject
Get the page that this destination points to Requires that this PdfDestination was somehow created by or from a PdfDocument. Won't work otherwise.
- Parameters:
-
pDoc | a PDF document owning this destination, needed to resolve pages |
- Returns:
- the referenced PdfPage
Get the page that this destination points to Requires that this PdfDestination was somehow created by or from a PdfDocument. Won't work otherwise.
- Parameters:
-
pVecObjects | a PdfVecObjects owning this destination, needed to resolve pages |
- Returns:
- the referenced PdfPage
Get the destination rect Destination must be of type FirR otherwise exception is thrown
- Returns:
- the destination rect
Get the destination Top position Destination must be of type XYZ, FitH, FitR, FitBH otherwise exception is thrown.
- Returns:
- the Top position
Get the destination fit type
- Returns:
- the fit type
Get the destination zoom Destination must be of type XYZ otherwise exception is thrown.
- Returns:
- the zoom