Classes
class	Annotation

class	AnnotationAppearance

class	AsyncObject

class	CaretAnnotation

class	CertificateInfo

class	Document

class	EmbeddedFile

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	RichMediaAnnotation

class	ScreenAnnotation

class	SignatureAnnotation

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 }

Functions
std::optional< CryptoSignBackend > POPPLER_QT6_EXPORT	activeCryptoSignBackend ()

bool POPPLER_QT6_EXPORT	arePgpSignaturesAllowed ()

QVector< CryptoSignBackend > POPPLER_QT6_EXPORT	availableCryptoSignBackends ()

QDateTime	convertDate (const char *dateString)

QVector< CertificateInfo > POPPLER_QT6_EXPORT	getAvailableSigningCertificates ()

QString POPPLER_QT6_EXPORT	getNSSDir ()

bool POPPLER_QT6_EXPORT	hasCryptoSignBackendFeature (CryptoSignBackend, CryptoSignBackendFeature)

bool POPPLER_QT6_DEPRECATED POPPLER_QT6_EXPORT	hasNSSSupport ()

bool	isCmsAvailable ()

bool	isOverprintPreviewAvailable ()

	Q_DECLARE_OPERATORS_FOR_FLAGS (CertificateInfo::KeyUsageExtensions) class SignatureValidationInfoPrivate

bool POPPLER_QT6_EXPORT	setActiveCryptoSignBackend (CryptoSignBackend backend)

void	setDebugErrorFunction (PopplerDebugFunc debugFunction, const QVariant &closure)

void POPPLER_QT6_EXPORT	setNSSDir (const QString &pathURL)

void POPPLER_QT6_EXPORT	setNSSPasswordCallback (const std::function< char (const char )> &f)

void POPPLER_QT6_EXPORT	setPgpSignaturesAllowed (bool allowed)

Detailed Description

The Poppler Qt6 binding.

Typedef Documentation

◆ PopplerDebugFunc

using Poppler::PopplerDebugFunc = typedef 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.

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.

Function Documentation

◆ activeCryptoSignBackend()

std::optional< CryptoSignBackend > POPPLER_QT6_EXPORT 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_QT6_EXPORT Poppler::arePgpSignaturesAllowed ( )

Returns: if pgp signatures are allowed.

Since: 25.03

◆ availableCryptoSignBackends()

QVector< CryptoSignBackend > POPPLER_QT6_EXPORT Poppler::availableCryptoSignBackends ( )

The available compiled-in backends.

Since: 23.06

◆ getAvailableSigningCertificates()

QVector< CertificateInfo > POPPLER_QT6_EXPORT Poppler::getAvailableSigningCertificates ( )

Return vector of suitable signing certificates.

Since: 21.01

◆ getNSSDir()

QString POPPLER_QT6_EXPORT Poppler::getNSSDir ( )

Gets the current NSS CertDB directory.

Since: 21.01

◆ hasCryptoSignBackendFeature()

bool POPPLER_QT6_EXPORT Poppler::hasCryptoSignBackendFeature	(	CryptoSignBackend	,
		CryptoSignBackendFeature
	)

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

Since: 23.06

◆ hasNSSSupport()

bool POPPLER_QT6_DEPRECATED POPPLER_QT6_EXPORT Poppler::hasNSSSupport ( )

Returns is poppler was compiled with NSS support.

Deprecated:: Use availableBackends instead

Since: 21.01

◆ setActiveCryptoSignBackend()

bool POPPLER_QT6_EXPORT 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

◆ setNSSDir()

void POPPLER_QT6_EXPORT 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_QT6_EXPORT Poppler::setNSSPasswordCallback ( const std::function< char *(const char *)> & f )

Sets the callback for NSS password requests.

Since: 21.01

◆ setPgpSignaturesAllowed()

void POPPLER_QT6_EXPORT Poppler::setPgpSignaturesAllowed ( bool allowed )

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