pdftron::PDF::Destination Class Reference

A destination defines a particular view of a document, consisting of the following:. More...

#include <Destination.h>

List of all members.

Public Types

enum  FitType {
  e_XYZ, e_Fit, e_FitH, e_FitV,
  e_FitR, e_FitB, e_FitBH, e_FitBV
}
 View Destination Fit Types:. More...

Public Member Functions

 Destination (SDF::Obj dest)
 Create a Destination and initialize it using given Cos/SDF object.
 Destination (const Destination &d)
 Copy constructor.
Destinationoperator= (const Destination &d)
 Assignment operator.
bool IsValid () const
FitType GetFitType ()
Page GetPage ()
void SetPage (Page page)
 Modify the destination so that it refers to the new 'page' as the destination page.
SDF::Obj GetSDFObj () const
SDF::Obj GetExplicitDestObj ()
 Destination (TRN_Destination impl)

Static Public Member Functions

static Destination CreateXYZ (Page page, double left, double top, double zoom)
 Create a new 'XYZ' Destination.
static Destination CreateFit (Page page)
 Create a new 'Fit' Destination.
static Destination CreateFitH (Page page, double top)
 Create a new 'FitH' Destination.
static Destination CreateFitV (Page page, double left)
 Create a new 'FitV' Destination.
static Destination CreateFitR (Page page, double left, double bottom, double right, double top)
 Create a new 'FitR' Destination.
static Destination CreateFitB (Page page)
 Create a new 'FitB' Destination.
static Destination CreateFitBH (Page page, double top)
 Create a new 'FitBH' Destination.
static Destination CreateFitBV (Page page, double left)
 Create a new 'FitBV' Destination.


Detailed Description

A destination defines a particular view of a document, consisting of the following:.

Destinations may be associated with Bookmarks, Annotations, and Remote Go-To Actions.

Destination is a utility class used to simplify work with PDF Destinations; Please refer to section 8.2.1 'Destinations' in PDF Reference Manual for details.


Member Enumeration Documentation

View Destination Fit Types:.

XYZ - Destination specified as upper-left corner point and a zoom factor. Fit - Fits the page into the window FitH - Fits the widths of the page into the window FitV - Fits the height of the page into a window. FitR - Fits the rectangle specified by its upper-left and lower-right corner points into the window. FitB - Fits the rectangle containing all visible elements on the page into the window. FitBH - Fits the width of the bounding box into the window. FitBV - Fits the height of the bounding box into the window.

Enumerator:
e_XYZ 
e_Fit 
e_FitH 
e_FitV 
e_FitR 
e_FitB 
e_FitBH 
e_FitBV 


Constructor & Destructor Documentation

pdftron::PDF::Destination::Destination ( SDF::Obj  dest  ) 

Create a Destination and initialize it using given Cos/SDF object.

Parameters:
dest - a low-level (SDF/Cos) destination object. The low-level destination can be either a named destination (i.e. a Name or a String) or an explicit destination (i.e. an Array Obj). Please refer to section 8.2.1 'Destinations' in PDF Reference Manual for more details.
Note:
The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Named destinations (in case 'dest' is a Name or a String) are automatically resolved to the explicit destination. If the name can't be resolved to the explicit destination dest.IsValid() will return false.

pdftron::PDF::Destination::Destination ( const Destination d  ) 

Copy constructor.

pdftron::PDF::Destination::Destination ( TRN_Destination  impl  ) 


Member Function Documentation

static Destination pdftron::PDF::Destination::CreateXYZ ( Page  page,
double  left,
double  top,
double  zoom 
) [static]

Create a new 'XYZ' Destination.

The new Destination displays the page designated by 'page', with the coordinates ('left', 'top') positioned at the top-left corner of the window and the contents of the page magnified by the factor 'zoom'. A null value for any of the parameters 'left', 'top', or 'zoom' specifies that the current value of that parameter is to be retained unchanged. A 'zoom' value of 0 has the same meaning as a null value.

static Destination pdftron::PDF::Destination::CreateFit ( Page  page  )  [static]

Create a new 'Fit' Destination.

The new Destination displays the page designated by 'page', with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

static Destination pdftron::PDF::Destination::CreateFitH ( Page  page,
double  top 
) [static]

Create a new 'FitH' Destination.

The new Destination displays the page designated by 'page', with the vertical coordinate 'top' positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window.

static Destination pdftron::PDF::Destination::CreateFitV ( Page  page,
double  left 
) [static]

Create a new 'FitV' Destination.

The new Destination displays the page designated by 'page', with the horizontal coordinate 'left' positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window.

static Destination pdftron::PDF::Destination::CreateFitR ( Page  page,
double  left,
double  bottom,
double  right,
double  top 
) [static]

Create a new 'FitR' Destination.

The new Destination displays the page designated by 'page', with its contents magnified just enough to fit the rectangle specified by the coordinates 'left', 'bottom', 'right', and 'top' entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.

static Destination pdftron::PDF::Destination::CreateFitB ( Page  page  )  [static]

Create a new 'FitB' Destination.

The new Destination displays the page designated by 'page', with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.

static Destination pdftron::PDF::Destination::CreateFitBH ( Page  page,
double  top 
) [static]

Create a new 'FitBH' Destination.

The new Destination displays the page designated by 'page', with the vertical coordinate 'top' positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window.

static Destination pdftron::PDF::Destination::CreateFitBV ( Page  page,
double  left 
) [static]

Create a new 'FitBV' Destination.

The new Destination displays Display the page designated by 'page', with the horizontal coordinate 'left' positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window.

Destination& pdftron::PDF::Destination::operator= ( const Destination d  ) 

Assignment operator.

bool pdftron::PDF::Destination::IsValid (  )  const

Returns:
True if this is a valid Destination and can be resolved, false otherwise.
Note:
If this method returns false the underlying SDF/Cos object is null and the Action object should be treated as null as well.

FitType pdftron::PDF::Destination::GetFitType (  ) 

Returns:
destination's FitType.
Exceptions:
An Exception is thrown if this is not a valid Destination.

Page pdftron::PDF::Destination::GetPage (  ) 

Returns:
the Page that this destination refers to.
Exceptions:
An Exception is thrown if this is not a valid Destination.

void pdftron::PDF::Destination::SetPage ( Page  page  ) 

Modify the destination so that it refers to the new 'page' as the destination page.

Parameters:
page The new page associated with this Destination.
Exceptions:
An Exception is thrown if this is not a valid Destination.

SDF::Obj pdftron::PDF::Destination::GetSDFObj (  )  const

Returns:
the object to the underlying SDF/Cos object. The returned SDF/Cos object is an explicit destination (i.e. the Obj is either an array defining the destination, using the syntax shown in Table 8.2 in PDF Reference Manual), or a dictionary with a 'D' entry whose value is such an array. The latter form allows additional attributes to be associated with the destination

SDF::Obj pdftron::PDF::Destination::GetExplicitDestObj (  ) 

Returns:
the explicit destination SDF/Cos object. This is always an Array as shown in Table 8.2 in PDF Reference Manual.
Exceptions:
An Exception is thrown if this is not a valid Destination.


© 2002-2010 PDFTron Systems Inc.