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

An abstract base class for protocol-specific jobs. More...

#include <specialjob.h>

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

Signals

void result (const GpgME::Error &result, const QVariant &data)
 
- Signals inherited from QGpgME::Job
void progress (const QString &what, int current, int total)
 
void done ()
 

Public Member Functions

virtual GpgME::Error start ()=0
 
virtual GpgME::Error exec ()=0
 
- Public Member Functions inherited from QGpgME::Job
virtual QString auditLogAsHtml () const
 
virtual GpgME::Error auditLogError () const
 
bool isAuditLogSupported () const
 

Protected Member Functions

 SpecialJob (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 protocol-specific jobs.

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

After result() is emitted, the SpecialJob will schedule its own destruction by calling QObject::deleteLater().

Parameters are set using the Qt property system. More general, or constructor parameters are given in the call to QGpgME::Protocol::specialJob().

The result is made available through the result signal, and through the read-only result property, the latter of which needs to be defined in each SpecialJob subclass.

Member Function Documentation

◆ start()

virtual GpgME::Error QGpgME::SpecialJob::start ( )
pure virtual

Starts the special operation.


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