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

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

#include <encryptjob.h>

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

Signals

void result (const GpgME::EncryptionResult &result, const QByteArray &cipherText, 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 > &recipients, const QByteArray &plainText, bool alwaysTrust=false)=0
 
virtual void start (const std::vector< GpgME::Key > &recipients, const std::shared_ptr< QIODevice > &plainText, const std::shared_ptr< QIODevice > &cipherText=std::shared_ptr< QIODevice >(), bool alwaysTrust=false)=0
 
virtual GpgME::EncryptionResult exec (const std::vector< GpgME::Key > &recipients, const QByteArray &plainText, bool alwaysTrust, QByteArray &cipherText)=0
 
virtual void setOutputIsBase64Encoded (bool)=0
 
virtual void start (const std::vector< GpgME::Key > &recipients, const std::shared_ptr< QIODevice > &plainText, const std::shared_ptr< QIODevice > &cipherText=std::shared_ptr< QIODevice >(), const GpgME::Context::EncryptionFlags flags=GpgME::Context::None)=0
 
virtual GpgME::EncryptionResult exec (const std::vector< GpgME::Key > &recipients, const QByteArray &plainText, const GpgME::Context::EncryptionFlags flags, QByteArray &cipherText)=0
 
- Public Member Functions inherited from QGpgME::Job
virtual QString auditLogAsHtml () const
 
virtual GpgME::Error auditLogError () const
 
bool isAuditLogSupported () const
 

Protected Member Functions

 EncryptJob (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 encrypters.

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

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

Member Function Documentation

◆ exec()

virtual GpgME::EncryptionResult QGpgME::EncryptJob::exec ( const std::vector< GpgME::Key > &  recipients,
const QByteArray &  plainText,
const GpgME::Context::EncryptionFlags  flags,
QByteArray &  cipherText 
)
pure virtual

Like exec but with an additional argument for EncryptionFlags for more flexibility.

Implemented in QGpgME::QGpgMEEncryptJob.

◆ setOutputIsBase64Encoded()

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

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

Implemented in QGpgME::QGpgMEEncryptJob.

◆ start() [1/3]

virtual QGPGME_DEPRECATED_EXPORT GpgME::Error QGpgME::EncryptJob::start ( const std::vector< GpgME::Key > &  recipients,
const QByteArray &  plainText,
bool  alwaysTrust = false 
)
pure virtual

Starts the encryption operation. recipients is the a list of keys to encrypt plainText to. Empty (null) keys are ignored. If recipients is empty, performs symmetric (passphrase) encryption.

If alwaysTrust is true, validity checking for the keys will not be performed, but full validity assumed for all keys without further checks.

Implemented in QGpgME::QGpgMEEncryptJob.

◆ start() [2/3]

virtual void QGpgME::EncryptJob::start ( const std::vector< GpgME::Key > &  recipients,
const std::shared_ptr< QIODevice > &  plainText,
const std::shared_ptr< QIODevice > &  cipherText = std::shared_ptr< QIODevice >(),
bool  alwaysTrust = false 
)
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 cipherText is non-null, the ciphertext is written there. Otherwise, it will be delivered in the second argument of result().

Exceptions
GpgME::Exceptionif starting fails

Implemented in QGpgME::QGpgMEEncryptJob.

◆ start() [3/3]

virtual void QGpgME::EncryptJob::start ( const std::vector< GpgME::Key > &  recipients,
const std::shared_ptr< QIODevice > &  plainText,
const std::shared_ptr< QIODevice > &  cipherText = std::shared_ptr< QIODevice >(),
const GpgME::Context::EncryptionFlags  flags = GpgME::Context::None 
)
pure virtual

Like start but with an additional argument for EncryptionFlags for more flexibility.

Implemented in QGpgME::QGpgMEEncryptJob.


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