RemoteDestination Class

class RemoteDestination

Namespace:datalogics_interface

Detailed Description

A view of a page contained in a separate document.

A RemoteDestination is not the same as a ViewDestination; the two objects are not interchangeable.

Referenced by

RemoteGoToAction

Uses types

PDFObject Rect

Constructor & Destructor Documentation

RemoteDestination(Document & doc, int page_number, const std::string & fit_type, const Rect & rect, double zoom)

Parameters

doc: Document &: Document that the RemoteDestination will be created in.
page_number: int: Page number of the page in the remote document to display.
fit_type: const std::string &: Fit Type must be: "XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", or "FitBV".
rect: const Rect &: Target Rectangle
zoom: double: Zoom level

Construct a RemoteDestination.

RemoteDestination(RemoteDestination && )

Parameters

: RemoteDestination &&

~RemoteDestination()

Field Documentation

static null_value

Constant used for "null" values in destination rectangles or zoom.

Member Function Documentation

Rect get_dest_rect()

Returns:

Rect

The rectangle defining the area of the page to display. Fields not applicable to the current fit type will contain NullValue.

The destination rectangle.

std::string get_fit_type()

Returns:

std::string

The fit type string (e.g., "XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", or "FitBV").

The fit type for the destination.

int get_page_number()

Returns:

int

The zero-based page number for this destination in the remote document.

The page number of the destination.

std::unique_ptr< PDFObject > get_pdf_object()

Returns:

std::unique_ptr< PDFObject >

The underlying PDFObject for this RemoteDestination.

Retrieve the PDFObject representation of this Remote Destination.

double get_zoom()

Returns:

double

The zoom level for the destination, or NullValue if not specified.

The zoom factor for the destination.

RemoteDestination & operator=(RemoteDestination && )

Parameters

: RemoteDestination &&

Returns:

RemoteDestination &

bool operator==(const RemoteDestination & other)

Parameters

other: const RemoteDestination &: The RemoteDestination to compare against.

Returns:

bool

true if the two RemoteDestination objects refer to the same underlying PDF object, false otherwise.

Tests whether two RemoteDestination objects are equal.

void set_dest_rect(const Rect & rect)

Parameters

rect: const Rect &: the rectangle for the destination

Returns:

void

Set the rectangle for the destination.

void set_fit_type(const std::string & fit_type)

Parameters

fit_type: const std::string &: the fit type for the destination

Returns:

void

Set the fit type for the destination.

void set_page_number(int page_number)

Parameters

page_number: int: the page number of the destination (page numbers start at 0)

Returns:

void

Set the page number of the destination (page numbers start at 0)

void set_zoom(double zoom)

Parameters

zoom: double: the zoom factor for the destination

Returns:

void

Set the zoom factor for the destination.

std::string to_string()

Returns:

std::string

A string describing the page number, fit type, destination rectangle, and zoom factor.

Returns a string representation of this RemoteDestination.