QGpgME  10.3.4.0000000
Qt API for GpgME
Signals | Public Member Functions | Protected Member Functions | List of all members
QGpgME::SignJob Class Referenceabstract

An abstract base class for asynchronous signing. More...

#include <signjob.h>

Inheritance diagram for QGpgME::SignJob:
Inheritance graph
[legend]
Collaboration diagram for QGpgME::SignJob:
Collaboration graph
[legend]

Signals

void result (const GpgME::SigningResult &result, const QByteArray &signature, const QString &auditLogAsHtml=QString(), const GpgME::Error &auditLogError=GpgME::Error())
 
- Signals inherited from QGpgME::Job
void progress (const QString &what, int current, int total)
 
void done ()
 

Public Member Functions

virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start (const std::vector< GpgME::Key > &signers, const QByteArray &plainText, GpgME::SignatureMode mode)=0
 
virtual void start (const std::vector< GpgME::Key > &signers, const std::shared_ptr< QIODevice > &plainText, const std::shared_ptr< QIODevice > &signature, GpgME::SignatureMode mode)=0
 
virtual GpgME::SigningResult exec (const std::vector< GpgME::Key > &signers, const QByteArray &plainText, GpgME::SignatureMode mode, QByteArray &signature)=0
 
virtual void setOutputIsBase64Encoded (bool)=0
 
- Public Member Functions inherited from QGpgME::Job
virtual QString auditLogAsHtml () const
 
virtual GpgME::Error auditLogError () const
 
bool isAuditLogSupported () const
 

Protected Member Functions

 SignJob (QObject *parent)
 
- Protected Member Functions inherited from QGpgME::Job
 Job (QObject *parent)
 

Additional Inherited Members

- Public Slots inherited from QGpgME::Job
virtual void slotCancel ()=0
 
- Static Public Member Functions inherited from QGpgME::Job
static GpgME::Context * context (Job *job)
 

Detailed Description

An abstract base class for asynchronous signing.

To use a SignJob, first obtain an instance from the CryptoBackend implementation, connect the progress() and result() signals to suitable slots and then start the signing with a call to start(). This call might fail, in which case the SignJob instance will have scheduled it's own destruction with a call to QObject::deleteLater().

After result() is emitted, the SignJob will schedule it's own destruction by calling QObject::deleteLater().

Member Function Documentation

◆ setOutputIsBase64Encoded()

virtual void QGpgME::SignJob::setOutputIsBase64Encoded ( bool  )
pure virtual

This is a hack to request BASE64 output (instead of whatever comes out normally).

Implemented in QGpgME::QGpgMESignJob.

◆ start() [1/2]

virtual QGPGME_DEPRECATED_EXPORT GpgME::Error QGpgME::SignJob::start ( const std::vector< GpgME::Key > &  signers,
const QByteArray &  plainText,
GpgME::SignatureMode  mode 
)
pure virtual

Starts the signing operation. signers is the list of keys to sign plainText with. Empty (null) keys are ignored.

Implemented in QGpgME::QGpgMESignJob.

◆ start() [2/2]

virtual void QGpgME::SignJob::start ( const std::vector< GpgME::Key > &  signers,
const std::shared_ptr< QIODevice > &  plainText,
const std::shared_ptr< QIODevice > &  signature,
GpgME::SignatureMode  mode 
)
pure virtual

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

If signature is non-null the signature is written there. Otherwise, it will be delivered in the second argument of result().

Exceptions
GpgME::Exceptionif starting fails

Implemented in QGpgME::QGpgMESignJob.


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