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

An abstract base class for asynchronous crypto operations. More...

#include <job.h>

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

Public Slots

virtual void slotCancel ()=0
 

Signals

void progress (const QString &what, int current, int total)
 
void done ()
 

Public Member Functions

virtual QString auditLogAsHtml () const
 
virtual GpgME::Error auditLogError () const
 
bool isAuditLogSupported () const
 

Static Public Member Functions

static GpgME::Context * context (Job *job)
 

Protected Member Functions

 Job (QObject *parent)
 

Detailed Description

An abstract base class for asynchronous crypto operations.

During the operation, you might receive progress updates through the progress() signal as they arrive, but an implementation is free to not send progress information. You should show a busy progressbar until the first progress() signal is received.

The done() signal is emitted before the result() signals of subclasses and should be used to hide and/or reset progress bars, not to learn of the end of the operation. Use the result() signals for that.

To cancel the operation, simply call slotCancel(). The result() signal of subclasses will still be emitted, though, and will carry the information that the operation was canceled.

Member Function Documentation

◆ context()

GpgME::Context * QGpgME::Job::context ( QGpgME::Job job)
static

Get the underlying context to set some additional options for a job.

This is intended to provide more flexibility on configuring jobs before they are started. The context is still owned by the thread, do not delete it.

This is a static method that takes the job as argument.

This function may not be called for running jobs.

Returns
the context used by the job job or null.

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