PDF::Dest Class Reference

Represents a destination in a PDF document. More...

#include <pdfsdk/cxx/dest.h>

Inheritance diagram for PDF::Dest:

Public Member Functions
Object	GetPdfObject () const
	Gets the destination PDF object.
PDDestType	GetDestType () const
	Gets the type of the destination.
size_t	GetPageIndex () const
	Gets the page index associated with the destination.
std::vector< float >	GetParams () const
	Gets the parameters associated with the destination.
	Dest (PDDest handle, bool adopt=false) noexcept
	Dest (const Dest &rhs) noexcept
Dest &	operator= (const Dest &rhs) noexcept
	Dest (Dest &&rhs) noexcept
Dest &	operator= (Dest &&rhs) noexcept

Static Public Member Functions
static Dest	CreateFromPdfObject (const Object &object)
	Creates a destination from the PDF object.

Detailed Description

Represents a destination in a PDF document.

The Dest class provides methods to retrieve information about a destination, such as its type, associated PDF object, page index, and parameters.

ISO 32000-2:2020 - 12.3.2 Destinations

Member Function Documentation

CreateFromPdfObject()

static Dest PDF::Dest::CreateFromPdfObject ( const Object & object )

static

Creates a destination from the PDF object.

Parameters

object

The PDF object.

Returns

The destination.

GetDestType()

PDDestType PDF::Dest::GetDestType

(

)

const

Gets the type of the destination.

Returns

The type of the destination.

GetPageIndex()

size_t PDF::Dest::GetPageIndex

(

)

const

Gets the page index associated with the destination.

Returns

The page index associated with the destination. Returns kPDPageIndexNull if the page index is not found.

GetParams()

std::vector< float > PDF::Dest::GetParams

(

)

const

Gets the parameters associated with the destination.

Returns

The parameters associated with the destination.

GetPdfObject()

Object PDF::Dest::GetPdfObject

(

)

const

Gets the destination PDF object.

Returns

The destination PDF object.

---

The documentation for this class was generated from the following file:

• include/pdfsdk/cxx/dest.h