Poppler Qt5 25.08.90
Classes | Public Types | Public Member Functions | List of all members
Poppler::PDFConverter Class Reference

#include <poppler-qt5.h>

Inheritance diagram for Poppler::PDFConverter:
Inheritance graph
[legend]
Collaboration diagram for Poppler::PDFConverter:
Collaboration graph
[legend]

Classes

class  NewSignatureData
 

Public Types

enum  PDFOption { WithChanges = 0x00000001 }
 
enum  SigningResult {
  SigningSuccess , FieldAlreadySigned , GenericSigningError , InternalError ,
  KeyMissing , WriteFailed , UserCancelled , BadPassphrase
}
 
- Public Types inherited from Poppler::BaseConverter
enum  Error { NoError , FileLockedError , OpenOutputError , NotSupportedInputFileError }
 

Public Member Functions

bool convert () override
 
ErrorString lastSigningErrorDetails () const
 
SigningResult lastSigningResult () const
 
PDFOptions pdfOptions () const
 
void setPDFOptions (PDFOptions options)
 
bool sign (const NewSignatureData &data)
 
 ~PDFConverter () override
 
- Public Member Functions inherited from Poppler::BaseConverter
Error lastError () const
 
void setOutputDevice (QIODevice *device)
 
void setOutputFileName (const QString &outputFileName)
 
virtual ~BaseConverter ()
 

Detailed Description

Converts a PDF to PDF (thus saves a copy of the document).

Since
0.8

Member Enumeration Documentation

◆ PDFOption

Options for the PDF export.

Enumerator
WithChanges 

The changes done to the document are saved as well.

◆ SigningResult

Since
25.07

BIC/SIC: Merge with SigningResult in poppler-converter and in poppler-annotation and poppler-form

Enumerator
SigningSuccess 

No error.

FieldAlreadySigned 

Trying to sign a field that is already signed.

GenericSigningError 

Unclassified error.

InternalError 

Unexpected error, likely a bug in poppler.

KeyMissing 

Key not found (Either the input key is not from the list or the available keys has changed underneath)

WriteFailed 

Write failed (permissions, faulty disk, ...)

UserCancelled 

User cancelled the process.

BadPassphrase 

User entered bad passphrase.

Member Function Documentation

◆ convert()

bool Poppler::PDFConverter::convert ( )
overridevirtual

Does the conversion.

Returns
whether the conversion succeeded

Implements Poppler::BaseConverter.

◆ lastSigningErrorDetails()

ErrorString Poppler::PDFConverter::lastSigningErrorDetails ( ) const

A string with a string that might offer more details of the signing result failure.

Note
the string here is likely not super useful for end users, but might give more details to a trained supporter / bug triager
Since
25.07

◆ lastSigningResult()

SigningResult Poppler::PDFConverter::lastSigningResult ( ) const

The last signing result, mostly relevant if sign returns false.

Since
25.07

◆ sign()

bool Poppler::PDFConverter::sign ( const NewSignatureData data)

Sign PDF at given Annotation / signature form.

Parameters
datanew signature data
Returns
whether the signing succeeded
Since
21.01

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