RemoteDestination Class Documentation

classRemoteDestination

Namespace:datalogics_interface

Detailed Description

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

Referenced by

RemoteGoToAction

Uses types

PDFObjectRect

Constructor & Destructor Documentation

RemoteDestination

RemoteDestination(Document &doc, intpage_number, const std::string &fit_type, const Rect &rect, doublezoom)

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()

Member Function Documentation

get_dest_rect

Rectget_dest_rect()

Returns:

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

The destination rectangle.

get_fit_type

std::stringget_fit_type()

Returns:

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

The fit type for the destination.

get_page_number

intget_page_number()

Returns:

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

The page number of the destination.

get_pdf_object

std::unique_ptr< PDFObject >get_pdf_object()

Returns:

The underlying PDFObject for this RemoteDestination.

Retrieve the PDFObject representation of this Remote Destination.

get_zoom

doubleget_zoom()

Returns:

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

The zoom factor for the destination.

operator==

booloperator==(const RemoteDestination &other)

Parameters

other: const RemoteDestination &

The RemoteDestination to compare against.

Returns:

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

Tests whether two RemoteDestination objects are equal.

set_dest_rect

voidset_dest_rect(const Rect &rect)

Parameters

rect: const Rect &

the rectangle for the destination

Returns:

void

Set the rectangle for the destination.

set_fit_type

voidset_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.

set_page_number

voidset_page_number(intpage_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)

set_zoom

voidset_zoom(doublezoom)

Parameters

zoom: double

the zoom factor for the destination

Returns:

void

Set the zoom factor for the destination.

to_string

std::stringto_string()

Returns:

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

Returns a string representation of this RemoteDestination.