Poppler Namespace Reference

Classes
class	Annotation
class	AnnotationAppearance
class	AnnotationUtils
class	AsyncObject
class	BaseConverter
class	CaretAnnotation
class	CertificateInfo
class	Document
class	EmbeddedFile
struct	ErrorString
class	FileAttachmentAnnotation
class	FontInfo
class	FontIterator
class	FormField
class	FormFieldButton
class	FormFieldChoice
class	FormFieldIcon
class	FormFieldSignature
class	FormFieldText
class	GeomAnnotation
class	HighlightAnnotation
class	InkAnnotation
class	LineAnnotation
class	Link
class	LinkAction
class	LinkAnnotation
class	LinkBrowse
class	LinkDestination
class	LinkExecute
class	LinkGoto
class	LinkHide
class	LinkJavaScript
class	LinkMovie
class	LinkOCGState
class	LinkRendition
class	LinkResetForm
class	LinkSound
class	LinkSubmitForm
class	MovieAnnotation
class	MovieObject
class	OptContentModel
class	OutlineItem
class	Page
class	PageTransition
class	PDFConverter
class	PSConverter
class	RichMediaAnnotation
class	ScreenAnnotation
class	SignatureValidationInfo
class	SoundAnnotation
class	SoundObject
class	StampAnnotation
class	TextAnnotation
class	TextBox
class	WidgetAnnotation

Typedefs
using	PopplerDebugFunc = void (*)(const QString & , const QVariant & )

Enumerations
enum class	CryptoSignBackend { NSS , GPG }
enum class	CryptoSignBackendFeature { BackendAsksPassphrase }
enum class	ErrorStringType { ErrorCodeString , UserString }

Functions
std::optional< CryptoSignBackend >	activeCryptoSignBackend ()
bool	arePgpSignaturesAllowed ()
QVector< CryptoSignBackend >	availableCryptoSignBackends ()
QDateTime	convertDate (char *dateString)
QDateTime	convertDate (const char *dateString)
QVector< CertificateInfo >	getAvailableSigningCertificates ()
QString	getNSSDir ()
bool	hasCryptoSignBackendFeature (CryptoSignBackend, CryptoSignBackendFeature)
bool POPPLER_QT5_DEPRECATED	hasNSSSupport ()
bool	isCmsAvailable ()
bool	isOverprintPreviewAvailable ()
bool	setActiveCryptoSignBackend (CryptoSignBackend backend)
void	setDebugErrorFunction (PopplerDebugFunc debugFunction, const QVariant &closure)
void	setNSSDir (const QString &pathURL)
void	setNSSPasswordCallback (const std::function< char *(const char *)> &f)
void	setPgpSignaturesAllowed (bool allowed)

Detailed Description

The Poppler Qt5 binding.

Typedef Documentation

PopplerDebugFunc

using Poppler::PopplerDebugFunc = void (*)(const QString & , const QVariant & )

Debug/error function.

This function type is used for debugging & error output; the first parameter is the actual message, the second is the unaltered closure argument which was passed to the setDebugErrorFunction call.

Since

0.16

Enumeration Type Documentation

CryptoSignBackend

enum class Poppler::CryptoSignBackend

strong

Possible compiled in backends for signature handling.

Since

23.06

CryptoSignBackendFeature

enum class Poppler::CryptoSignBackendFeature

strong

Enumerator
BackendAsksPassphrase	If the backend itself out of band requests passwords or if the host applicaion somehow must do it.

ErrorStringType

enum class Poppler::ErrorStringType

strong

The various types of error strings.

Since

25.07

Enumerator
ErrorCodeString	The string should be treated like a error code. It could be a hex code, a position in the poppler sources or something similar
UserString	The string should be treated as an advanced error message that can be shown to user.

Function Documentation

activeCryptoSignBackend()

std::optional< CryptoSignBackend > Poppler::activeCryptoSignBackend

(

)

Returns current active backend or nullopt if none is active.

Note

there will always be an active backend if there is available backends

Since

23.06

arePgpSignaturesAllowed()

bool Poppler::arePgpSignaturesAllowed

(

)

Returns

if pgp signatures are allowed.

Since

25.03

availableCryptoSignBackends()

QVector< CryptoSignBackend > Poppler::availableCryptoSignBackends

(

)

The available compiled-in backends.

Since

23.06

convertDate()

QDateTime Poppler::convertDate

(

const char *

dateString

)

Conversion from PDF date string format to QDateTime.

Since

0.64

getAvailableSigningCertificates()

QVector< CertificateInfo > Poppler::getAvailableSigningCertificates

(

)

Return vector of suitable signing certificates.

Since

21.01

getNSSDir()

QString Poppler::getNSSDir

(

)

Gets the current NSS CertDB directory.

Since

21.01

hasCryptoSignBackendFeature()

bool Poppler::hasCryptoSignBackendFeature	(	CryptoSignBackend	,
		CryptoSignBackendFeature	)

Queries if a backend supports or not supports a given feature.

Since

23.06

hasNSSSupport()

bool POPPLER_QT5_DEPRECATED Poppler::hasNSSSupport

(

)

Returns is poppler was compiled with NSS support.

Deprecated

Use availableBackends instead

Since

21.01

isCmsAvailable()

bool Poppler::isCmsAvailable

(

)

Whether the color management functions are available.

Since

0.12

isOverprintPreviewAvailable()

bool Poppler::isOverprintPreviewAvailable

(

)

Whether the overprint preview functionality is available.

Since

0.22

setActiveCryptoSignBackend()

bool Poppler::setActiveCryptoSignBackend

(

CryptoSignBackend

backend

)

Sets active backend.

Returns

true on success

Since

23.06

setDebugErrorFunction()

void Poppler::setDebugErrorFunction	(	PopplerDebugFunc	debugFunction,
		const QVariant &	closure )

Set a new debug/error output function.

If not set, by default error and debug messages will be sent to the Qt qDebug() function.

Parameters

debugFunction	the new debug function
closure	user data which will be passes as-is to the debug function

Since

0.16

setNSSDir()

void Poppler::setNSSDir

(

const QString &

pathURL

)

Set a custom NSS CertDB directory.

Needs to be called before doing any other signature operation

Since

21.01

setNSSPasswordCallback()

void Poppler::setNSSPasswordCallback

(

const std::function< char *(const char *)> &

f

)

Sets the callback for NSS password requests.

Since

21.01

setPgpSignaturesAllowed()

void Poppler::setPgpSignaturesAllowed

(

bool

allowed

)

Allow pgp signatures in pdf files (standard-extension, experimental) Not supported for NSS backend.

Parameters

allowed

new value for pgp signatures allowed

Since

25.03