#define PDViewDestNULL fixedNegativeInfinity
typedef OPAQUE_64_BITS PDViewDestination;
PDViewDestination PDViewDestCreate(PDDoc doc, PDPage initialPage, ASAtom initialFitType, const ASFixedRectP initialRect, const ASFixed initialZoom, ASInt32 pageNumber);
doc | The document in which the destination is used.
|
initialPage | The destination page.
|
initialFitType | The destination fit type. It must be one of the View Destination Fit Types, which must be converted into an ASAtom with ASAtomFromString().
|
initialRect | A pointer to an ASFixedRect specifying the destination rectangle, specified in user space coordinates. The appropriate information will be extracted from
initialRect, depending on initialFitType, to create the destination. All four of the initialRect parameter's components should be set; using PDViewDestNULL for any components can result in incorrect results for rotated pages. |
initialZoom | The zoom factor to set for the destination. Used only if
initialFitType is XYZ. Use the predefined value PDViewDestNULL (see PDExpT.h) to indicate a NULL zoom factor, described in Destinations in "Document-Level Navigation," in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 12.4.4, page 365. |
pageNumber | Currently unused.
|
void PDViewDestDestroy(PDViewDestination dest);
dest | IN/OUT The view destination to destroy.
|
PDViewDestination PDViewDestFromCosObj(CosObj obj);
obj | IN/OUT The dictionary Cos object to convert to a view destination.
|
is raised if the destination is invalid, as determined by PDViewDestIsValid().
|
void PDViewDestGetAttr(PDViewDestination dest, ASInt32 *pageNum, ASAtom *fitType, ASFixedRectP destRect, ASFixed *zoom);
dest | IN/OUT The view destination whose attributes are obtained.
|
pageNum | IN/OUT (Filled by the method) The page number of the destination's page.
|
fitType | IN/OUT (Filled by the method) The destination fit type. One of the values listed in View Destination Fit Types.
|
destRect | IN/OUT (Filled by the method) A pointer to a ASFixedRect containing the destination's rectangle, specified in user space coordinates.
|
zoom | IN/OUT (Filled by the method) The destination's zoom factor.
|
is raised if the destination is not represented by an array.
|
CosObj PDViewDestGetCosObj(PDViewDestination dest);
dest | IN/OUT The view destination whose Cos object is obtained.
|
NULL Cos object if the view destination is invalid, as determined by PDViewDestIsValid(). ASBool PDViewDestIsValid(PDViewDestination dest);
dest | The view destination whose validity is determined.
|
Resolves a destination. dest is the value of the D key in an action. It can be a real destination (an array) or a name. If it is a name, look it up in the doc parameter's Dests dictionary. The value found there can be a real destination (an array) or a dictionary. If it is a dictionary, look up the D key in that dictionary.
This method is useful for getting a PDViewDestination from an action, as provided by PDActionGetDest(), since this method may not return a PDViewDestination.
This method can raise memory, I/O, and parsing exceptions.
PDViewDestination PDViewDestResolve(PDViewDestination dest, PDDoc doc);
dest | IN/OUT The destination to resolve.
|
doc | IN/OUT The PDDoc that contains the destination.
|