#include "poppler/cpp/poppler-destination.h"

Inheritance diagram for poppler::destination:

Public Types
enum	type_enum { unknown , xyz , fit , fit_h , fit_v , fit_r , fit_b , fit_b_h , fit_b_v }

Public Member Functions
	destination (destination &&other) noexcept

	~destination ()

double	bottom () const

bool	is_change_left () const

bool	is_change_top () const

bool	is_change_zoom () const

double	left () const

destination &	operator= (destination &&other) noexcept

int	page_number () const

double	right () const

double	top () const

type_enum	type () const

double	zoom () const

Detailed Description

The information about a destination used in a PDF document.

Member Enumeration Documentation

◆ type_enum

enum poppler::destination::type_enum

The various types of destinations available in a PDF document.

Enumerator
unknown	unknown destination
xyz	go to page with coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom
fit	go to page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically
fit_h	go to 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
fit_v	go to 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
fit_r	go to 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
fit_b	go to page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically
fit_b_h	go to 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
fit_b_v	go to 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

Constructor & Destructor Documentation

◆ ~destination()

destination::~destination ( )

default

Destructor.

◆ destination()

destination::destination ( destination && other )

noexcept

Move constructor.

Member Function Documentation

◆ bottom()

double destination::bottom ( ) const

Returns: the bottom coordinate of the destination

◆ is_change_left()

bool destination::is_change_left ( ) const

Returns: whether left coordinate should be changed

◆ is_change_top()

bool destination::is_change_top ( ) const

Returns: whether top coordinate should be changed

◆ is_change_zoom()

bool destination::is_change_zoom ( ) const

Returns: whether scale factor should be changed

◆ left()

double destination::left ( ) const

Returns: the left coordinate of the destination

◆ operator=()

destination & destination::operator= ( destination && other )

defaultnoexcept

Move assignment operator.

◆ page_number()

int destination::page_number ( ) const

Note: It is necessary not to destruct parent poppler::document before calling this function for the first time.

Returns: the page number of the destination

◆ right()

double destination::right ( ) const

Returns: the right coordinate of the destination

◆ top()

double destination::top ( ) const

Returns: the top coordinate of the destination

◆ type()

destination::type_enum destination::type ( ) const

Returns: the type of the destination

◆ zoom()

double destination::zoom ( ) const

Returns: the scale factor of the destination

Public Types

Public Member Functions