#include <poppler-qt6.h>

Classes
struct	PdfVersion

Public Types
enum	DocumentAdditionalActionsType { CloseDocument , SaveDocumentStart , SaveDocumentFinish , PrintDocumentStart , PrintDocumentFinish }

enum	FormType { NoForm , AcroForm , XfaForm }

enum	PageLayout { NoLayout , SinglePage , OneColumn , TwoColumnLeft , TwoColumnRight , TwoPageLeft , TwoPageRight }

enum	PageMode { UseNone , UseOutlines , UseThumbs , FullScreen , UseOC , UseAttach }

enum	RenderBackend { SplashBackend , QPainterBackend }

enum	RenderHint { Antialiasing = 0x00000001 , TextAntialiasing = 0x00000002 , TextHinting = 0x00000004 , TextSlightHinting = 0x00000008 , OverprintPreview = 0x00000010 , ThinLineSolid = 0x00000020 , ThinLineShape = 0x00000040 , IgnorePaperColor = 0x00000080 , HideAnnotations = 0x00000100 }

Public Member Functions
std::unique_ptr< Link >	additionalAction (DocumentAdditionalActionsType type) const

void	applyResetFormsLink (const LinkResetForm &link)

QString	author () const

void *	colorDisplayProfile () const

void *	colorRgbProfile () const

QDateTime	creationDate () const

QString	creator () const

QDateTime	date (const QString &type) const

QList< EmbeddedFile * >	embeddedFiles () const

QByteArray	fontData (const FontInfo &fi) const

QList< FontInfo >	fonts () const

QVector< int >	formCalculateOrder () const

FormType	formType () const

bool	getPdfId (QByteArray permanentId, QByteArray updateId) const

PdfVersion	getPdfVersion () const

bool	hasEmbeddedFiles () const

bool	hasOptionalContent () const

QString	info (const QString &type) const

QStringList	infoKeys () const

bool	isEncrypted () const

bool	isLinearized () const

bool	isLocked () const

QString	keywords () const

std::unique_ptr< LinkDestination >	linkDestination (const QString &name)

QString	metadata () const

QDateTime	modificationDate () const

std::unique_ptr< FontIterator >	newFontIterator (int startPage=0) const

int	numPages () const

bool	okToAddNotes () const

bool	okToAssemble () const

bool	okToChange () const

bool	okToCopy () const

bool	okToCreateFormFields () const

bool	okToExtractForAccessibility () const

bool	okToFillForm () const

bool	okToPrint () const

bool	okToPrintHighRes () const

OptContentModel *	optionalContentModel ()

QVector< OutlineItem >	outline () const

std::unique_ptr< Page >	page (const QString &label) const

std::unique_ptr< Page >	page (int index) const

PageLayout	pageLayout () const

PageMode	pageMode () const

QColor	paperColor () const

std::unique_ptr< PDFConverter >	pdfConverter () const

QString	producer () const

std::unique_ptr< PSConverter >	psConverter () const

bool	removeInfo ()

RenderBackend	renderBackend () const

RenderHints	renderHints () const

QStringList	scripts () const

bool	setAuthor (const QString &val)

void	setColorDisplayProfile (void *outputProfileA)

void	setColorDisplayProfileName (const QString &name)

bool	setCreationDate (const QDateTime &val)

bool	setCreator (const QString &val)

bool	setDate (const QString &key, const QDateTime &val)

bool	setInfo (const QString &key, const QString &val)

bool	setKeywords (const QString &val)

bool	setModificationDate (const QDateTime &val)

void	setPaperColor (const QColor &color)

bool	setProducer (const QString &val)

void	setRenderBackend (RenderBackend backend)

void	setRenderHint (RenderHint hint, bool on=true)

bool	setSubject (const QString &val)

bool	setTitle (const QString &val)

void	setXRefReconstructedCallback (const std::function< void()> &callback)

std::vector< std::unique_ptr< FormFieldSignature > >	signatures () const

QString	subject () const

Qt::LayoutDirection	textDirection () const

QString	title () const

bool	unlock (const QByteArray &ownerPassword, const QByteArray &userPassword)

bool	xrefWasReconstructed () const

	~Document ()

Static Public Member Functions
static QSet< RenderBackend >	availableRenderBackends ()

static std::unique_ptr< Document >	load (const QString &filePath, const QByteArray &ownerPassword=QByteArray(), const QByteArray &userPassword=QByteArray())

static std::unique_ptr< Document >	load (QIODevice *device, const QByteArray &ownerPassword=QByteArray(), const QByteArray &userPassword=QByteArray())

static std::unique_ptr< Document >	loadFromData (const QByteArray &fileContents, const QByteArray &ownerPassword=QByteArray(), const QByteArray &userPassword=QByteArray())

Detailed Description

PDF document.

The Document class represents a PDF document: its pages, and all the global properties, metadata, etc.

Ownership of the returned objects

All the functions that returns class pointers create new object, and the responsibility of those is given to the caller.

The only exception is Page::transition().

Loading

To get a Document, you have to load it via the load() & loadFromData() functions.

In all the functions that have passwords as arguments, they must be Latin1 encoded. If you have a password that is a UTF-8 string, you need to use QString::toLatin1() (or similar) to convert the password first. If you have a UTF-8 character array, consider converting it to a QString first (QString::fromUtf8(), or similar) before converting to Latin1 encoding.

Rendering

To render pages of a document, you have different Document functions to set various options.

Backends

Poppler offers a different backends for rendering the pages. Currently there are two backends (see RenderBackend), but only the Splash engine works well and has been tested.

The available rendering backends can be discovered via availableRenderBackends(). The current rendering backend can be changed using setRenderBackend(). Please note that setting a backend not listed in the available ones will always result in null QImage's.

Color management support

Poppler, if compiled with this support, provides functions to handle color profiles.

To know whether the Poppler version you are using has support for color management, you can query Poppler::isCmsAvailable(). In case it is not available, all the color management-related functions will either do nothing or return null.

Member Enumeration Documentation

◆ DocumentAdditionalActionsType

enum Poppler::Document::DocumentAdditionalActionsType

Describes the flags for additional document actions i.e.

for executing document scripts at different events. This flag is used by additionalAction method to return the particular Link.

Since: 24.07

Enumerator
CloseDocument	Performed before closing the document.
SaveDocumentStart	Performed before saving the document.
SaveDocumentFinish	Performed after saving the document.
PrintDocumentStart	Performed before printing the document.
PrintDocumentFinish	Performed after printing the document.

◆ FormType

enum Poppler::Document::FormType

Form types.

Enumerator
NoForm	Document doesn't contain forms.
AcroForm	AcroForm.
XfaForm	Adobe XML Forms Architecture (XFA), currently unsupported.

◆ PageLayout

enum Poppler::Document::PageLayout

The page layout.

Enumerator
NoLayout	Layout not specified.
SinglePage	Display a single page.
OneColumn	Display a single column of pages.
TwoColumnLeft	Display the pages in two columns, with odd-numbered pages on the left.
TwoColumnRight	Display the pages in two columns, with odd-numbered pages on the right.
TwoPageLeft	Display the pages two at a time, with odd-numbered pages on the left.
TwoPageRight	Display the pages two at a time, with odd-numbered pages on the right.

◆ PageMode

enum Poppler::Document::PageMode

The page mode.

Enumerator
UseNone	No mode - neither document outline nor thumbnail images are visible.
UseOutlines	Document outline visible.
UseThumbs	Thumbnail images visible.
FullScreen	Fullscreen mode (no menubar, windows controls etc)
UseOC	Optional content group panel visible.
UseAttach	Attachments panel visible.

◆ RenderBackend

enum Poppler::Document::RenderBackend

The render backends available.

Enumerator
SplashBackend	Splash backend.
QPainterBackend	Qt backend.

◆ RenderHint

enum Poppler::Document::RenderHint

The render hints available.

Enumerator
Antialiasing	Antialiasing for graphics.
TextAntialiasing	Antialiasing for text.
TextHinting	Hinting for text.
TextSlightHinting	Lighter hinting for text when combined with TextHinting.
OverprintPreview	Overprint preview.
ThinLineSolid	Enhance thin lines solid.
ThinLineShape	Enhance thin lines shape. Wins over ThinLineSolid.
IgnorePaperColor	Do not compose with the paper color.
HideAnnotations	Do not render annotations.

Member Function Documentation

◆ additionalAction()

std::unique_ptr< Link > Poppler::Document::additionalAction ( DocumentAdditionalActionsType type ) const

Returns the additional action of the given type for the document or 0 if no action has been defined.

Since: 24.07

◆ applyResetFormsLink()

void Poppler::Document::applyResetFormsLink ( const LinkResetForm & link )

Resets the form with the details contained in the link.

Since: 24.07

◆ colorDisplayProfile()

void * Poppler::Document::colorDisplayProfile ( ) const

Return the current display profile.

Returns: a cmsHPROFILE of the LCMS library.

Note: The returned profile stays a property of poppler and shall NOT be closed by the user. It's existence is guaranteed for as long as this instance of the Document class is not deleted.

◆ colorRgbProfile()

void * Poppler::Document::colorRgbProfile ( ) const

Return the current RGB profile.

Returns: a cmsHPROFILE of the LCMS library.

Note: The returned profile stays a property of poppler and shall NOT be closed by the user. It's existence is guaranteed for as long as this instance of the Document class is not deleted.

◆ date()

QDateTime Poppler::Document::date ( const QString & type ) const

   The date associated with the document

   You would use this method with something like:
   \code

QDateTime created = m_doc->date("CreationDate"); QDateTime modified = m_doc->date("ModDate");

The available dates are:

CreationDate: the date of creation of the document
ModDate: the date of the last change in the document

Parameters

type	the type of date that is required

◆ embeddedFiles()

QList< EmbeddedFile * > Poppler::Document::embeddedFiles ( ) const

The documents embedded within the PDF document.

Note: there are two types of embedded document - this call only accesses documents that are embedded at the document level.; The ownership of the EmbeddedFile objects remain with the callee.

◆ fonts()

QList< FontInfo > Poppler::Document::fonts ( ) const

The fonts within the PDF document.

This is a shorthand for getting all the fonts at once.

Note: this can take a very long time to run with a large document. You may wish to use a FontIterator if you have more than say 20 pages

See also: newFontIterator()

◆ getPdfId()

bool Poppler::Document::getPdfId	(	QByteArray *	permanentId,
		QByteArray *	updateId
	)		const

The PDF identifiers.

Parameters

permanentId	an optional pointer to a variable where store the permanent ID of the document
updateId	an optional pointer to a variable where store the update ID of the document

Returns: whether the document has the IDs

◆ getPdfVersion()

PdfVersion Poppler::Document::getPdfVersion ( ) const

The version of the PDF specification that the document conforms to.

Since: 21.08

◆ hasOptionalContent()

bool Poppler::Document::hasOptionalContent ( ) const

Test whether this document has "optional content".

Optional content is used to optionally turn on (display) and turn off (not display) some elements of the document. The most common use of this is for layers in design applications, but it can be used for a range of things, such as not including some content in printing, and displaying content in the appropriate language.

◆ info()

QString Poppler::Document::info ( const QString & type ) const

   Get specified information associated with the document

   You would use this method with something like:
   \code

QString title = m_doc->info("Title"); QString subject = m_doc->info("Subject");

In addition to Title and Subject, other information that may be available include Author, Keywords, Creator and Producer.

Parameters

type	the information that is required

See also: infoKeys() to get a list of the available keys

◆ isLinearized()

bool Poppler::Document::isLinearized ( ) const

Test if the document is linearised.

In some cases, this is called "fast web view", since it is mostly an optimisation for viewing over the Web.

◆ linkDestination()

std::unique_ptr< LinkDestination > Poppler::Document::linkDestination ( const QString & name )

Tries to resolve the named destination name.

Note: this operation starts a search through the whole document

Returns: a new LinkDestination object if the named destination was actually found, or empty unique pointer otherwise

◆ load() [1/2]

static std::unique_ptr< Document > Poppler::Document::load	(	const QString &	filePath,
		const QByteArray &	ownerPassword = `QByteArray()`,
		const QByteArray &	userPassword = `QByteArray()`
	)

static

Load the document from a file on disk.

Parameters

filePath	the name (and path, if required) of the file to load
ownerPassword	the Latin1-encoded owner password to use in loading the file
userPassword	the Latin1-encoded user ("open") password to use in loading the file

Returns: the loaded document, or empty unique pointer on error

Warning: The returning document may be locked if a password is required to open the file, and one is not provided (as the userPassword).

◆ load() [2/2]

static std::unique_ptr< Document > Poppler::Document::load	(	QIODevice *	device,
		const QByteArray &	ownerPassword = `QByteArray()`,
		const QByteArray &	userPassword = `QByteArray()`
	)

static

Load the document from a device.

Parameters

device	the device of the data to load
ownerPassword	the Latin1-encoded owner password to use in loading the file
userPassword	the Latin1-encoded user ("open") password to use in loading the file

Returns: the loaded document, or empty unique pointer on error

Note: if the file is on disk it is recommended to use the other load overload since it is less resource intensive

Warning: The returning document may be locked if a password is required to open the file, and one is not provided (as the userPassword).

◆ loadFromData()

static std::unique_ptr< Document > Poppler::Document::loadFromData	(	const QByteArray &	fileContents,
		const QByteArray &	ownerPassword = `QByteArray()`,
		const QByteArray &	userPassword = `QByteArray()`
	)

static

Load the document from memory.

Parameters

fileContents	the file contents. They are copied so there is no need to keep the byte array around for the full life time of the document.
ownerPassword	the Latin1-encoded owner password to use in loading the file
userPassword	the Latin1-encoded user ("open") password to use in loading the file

Returns: the loaded document, or empty unique pointer on error

Warning: The returning document may be locked if a password is required to open the file, and one is not provided (as the userPassword).

◆ newFontIterator()

std::unique_ptr< FontIterator > Poppler::Document::newFontIterator ( int startPage = 0 ) const

Creates a new FontIterator object for font scanning.

The new iterator can be used for reading the font information of the document, reading page by page.

Parameters

startPage the initial page from which start reading fonts

See also: fonts()

◆ okToAssemble()

bool Poppler::Document::okToAssemble ( ) const

Test if the permissions on the document allow it to be "assembled" - insertion, rotation and deletion of pages; or creation of bookmarks and thumbnail images.

Note: this can be true even if okToChange() is false

◆ okToChange()

bool Poppler::Document::okToChange ( ) const

Test if the permissions on the document allow it to be changed.

Note: depending on the type of change, it may be more appropriate to check other properties as well.

◆ okToFillForm()

bool Poppler::Document::okToFillForm ( ) const

Test if the permissions on the document allow interactive form fields (including signature fields) to be completed.

Note: this can be true even if okToAddNotes() is false - this means that only form completion is permitted.

◆ optionalContentModel()

OptContentModel * Poppler::Document::optionalContentModel ( )

Itemviews model for optional content.

The model is owned by the document.

◆ outline()

QVector< OutlineItem > Poppler::Document::outline ( ) const

Gets the outline of the document.

Returns: a vector of outline items, empty if there are none

◆ page() [1/2]

std::unique_ptr< Page > Poppler::Document::page ( const QString & label ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

The intent is that you can pass in a label like "ix" and get the page with that label (which might be in the table of contents), or pass in "1" and get the page that the user expects (which might not be the first page, if there is a title page and a table of contents).

Parameters

label the page label

◆ page() [2/2]

std::unique_ptr< Page > Poppler::Document::page ( int index ) const

Get a specified Page.

Note that this follows the PDF standard of being zero based - if you want the first page, then you need an index of zero.

This function can return empty unique pointer if for some reason the page can't be properly parsed.

Parameters

index the page number index

Warning: The Page object returned by this method internally stores a pointer to the document that it was created from. This pointer will go stale if you delete the Document object. Therefore the Document object needs to be kept alive as long as you want to use the Page object.

◆ pageLayout()

PageLayout Poppler::Document::pageLayout ( ) const

The layout that pages should be shown in when the document is first opened.

This basically describes how pages are shown relative to each other.

◆ pageMode()

PageMode Poppler::Document::pageMode ( ) const

The type of mode that should be used by the application when the document is opened.

Note that while this is called page mode, it is really viewer application mode.

◆ paperColor()

QColor Poppler::Document::paperColor ( ) const

The paper color.

The default color is white.

◆ removeInfo()

bool Poppler::Document::removeInfo ( )

Remove the document's Info dictionary.

Returns: true on success, false on failure

◆ renderBackend()

RenderBackend Poppler::Document::renderBackend ( ) const

The currently set render backend.

The default backend is SplashBackend

◆ scripts()

QStringList Poppler::Document::scripts ( ) const

Document-level JavaScript scripts.

Returns the list of document level JavaScript scripts to be always executed before any other script.

◆ setAuthor()

bool Poppler::Document::setAuthor ( const QString & val )

Set the author of the document to.

Parameters

val

Returns: true on success, false on failure

◆ setColorDisplayProfile()

void Poppler::Document::setColorDisplayProfile ( void * outputProfileA )

Set a color display profile for the current document.

Parameters

outputProfileA is a cmsHPROFILE of the LCMS library.

Note: This should be called before any rendering happens.; It is assumed that poppler takes over the owernship of the corresponding cmsHPROFILE. In particular, it is no longer the caller's responsibility to close the profile after use.

◆ setColorDisplayProfileName()

void Poppler::Document::setColorDisplayProfileName ( const QString & name )

Set a color display profile for the current document.

Parameters

name	is the name of the display profile to set.

Note: This should be called before any rendering happens.

◆ setCreationDate()

bool Poppler::Document::setCreationDate ( const QDateTime & val )

Set the creation date of the document to.

Parameters

val

Returns: true on success, false on failure

◆ setCreator()

bool Poppler::Document::setCreator ( const QString & val )

Set the creator of the document to.

Parameters

val

Returns: true on success, false on failure

◆ setDate()

bool Poppler::Document::setDate	(	const QString &	key,
		const QDateTime &	val
	)

Set the Info dict date entry specified by.

Parameters

key	to
val

Returns: true on success, false on failure

◆ setInfo()

bool Poppler::Document::setInfo	(	const QString &	key,
		const QString &	val
	)

Set the value of the document's Info dictionary entry specified by.

Parameters

key	to
val

Returns: true on success, false on failure

◆ setKeywords()

bool Poppler::Document::setKeywords ( const QString & val )

Set the keywords of the document to.

Parameters

val

Returns: true on success, false on failure

◆ setModificationDate()

bool Poppler::Document::setModificationDate ( const QDateTime & val )

Set the modification date of the document to.

Parameters

val

Returns: true on success, false on failure

◆ setPaperColor()

void Poppler::Document::setPaperColor ( const QColor & color )

Sets the paper color.

Parameters

color the new paper color

◆ setProducer()

bool Poppler::Document::setProducer ( const QString & val )

Set the producer of the document to.

Parameters

val

Returns: true on success, false on failure

◆ setRenderBackend()

void Poppler::Document::setRenderBackend ( RenderBackend backend )

Sets the backend used to render the pages.

Parameters

backend the new rendering backend

◆ setRenderHint()

void Poppler::Document::setRenderHint	(	RenderHint	hint,
		bool	on = `true`
	)

Sets the render hint .

Note: some hints may not be supported by some rendering backends.

Parameters

on	whether the flag should be added or removed.

◆ setSubject()

bool Poppler::Document::setSubject ( const QString & val )

Set the subject of the document to.

Parameters

val

Returns: true on success, false on failure

◆ setTitle()

bool Poppler::Document::setTitle ( const QString & val )

Set the title of the document to.

Parameters

val

Returns: true on success, false on failure

◆ setXRefReconstructedCallback()

void Poppler::Document::setXRefReconstructedCallback ( const std::function< void()> & callback )

Sets the document's XRef reconstruction callback, so whenever a XRef table reconstruction happens the callback will get triggered.

Since: 21.06

◆ signatures()

std::vector< std::unique_ptr< FormFieldSignature > > Poppler::Document::signatures ( ) const

Returns the signatures of this document.

Prefer to use this over getting the signatures for all the pages of the document since there are documents with signatures that don't belong to a given page

◆ unlock()

bool Poppler::Document::unlock	(	const QByteArray &	ownerPassword,
		const QByteArray &	userPassword
	)

Provide the passwords required to unlock the document.

Parameters

ownerPassword	the Latin1-encoded owner password to use in loading the file
userPassword	the Latin1-encoded user ("open") password to use in loading the file

◆ xrefWasReconstructed()

bool Poppler::Document::xrefWasReconstructed ( ) const

Returns whether the document's XRef table has been reconstructed or not.

Since: 21.06

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

poppler-qt6.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Ownership of the returned objects

Loading

Rendering

Backends

Color management support

Member Enumeration Documentation

◆ DocumentAdditionalActionsType

◆ FormType

◆ PageLayout

◆ PageMode

◆ RenderBackend

◆ RenderHint

Member Function Documentation

◆ additionalAction()

◆ applyResetFormsLink()

◆ colorDisplayProfile()

◆ colorRgbProfile()

◆ date()

◆ embeddedFiles()

◆ fonts()

◆ getPdfId()

◆ getPdfVersion()

◆ hasOptionalContent()

◆ info()

◆ isLinearized()

◆ linkDestination()

◆ load() [1/2]

◆ load() [2/2]

◆ loadFromData()

◆ newFontIterator()

◆ okToAssemble()

◆ okToChange()

◆ okToFillForm()

◆ optionalContentModel()

◆ outline()

◆ page() [1/2]

◆ page() [2/2]

◆ pageLayout()

◆ pageMode()

◆ paperColor()

◆ removeInfo()

◆ renderBackend()

◆ scripts()

◆ setAuthor()

◆ setColorDisplayProfile()

◆ setColorDisplayProfileName()

◆ setCreationDate()

◆ setCreator()

◆ setDate()

◆ setInfo()

◆ setKeywords()

◆ setModificationDate()

◆ setPaperColor()

◆ setProducer()

◆ setRenderBackend()

◆ setRenderHint()

◆ setSubject()

◆ setTitle()

◆ setXRefReconstructedCallback()

◆ signatures()

◆ unlock()

◆ xrefWasReconstructed()