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

An abstract base class to sign keys asynchronously. More...

#include <signkeyjob.h>

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

Signals

void result (const GpgME::Error &result, 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 GpgME::Error start (const GpgME::Key &keyToSign)=0
 
virtual void setUserIDsToSign (const std::vector< unsigned int > &idsToSign)=0
 
virtual void setCheckLevel (unsigned int checkLevel)=0
 
virtual void setExportable (bool exportable)=0
 
virtual void setSigningKey (const GpgME::Key &key)=0
 
virtual void setNonRevocable (bool nonRevocable)=0
 
- Public Member Functions inherited from QGpgME::Job
virtual QString auditLogAsHtml () const
 
virtual GpgME::Error auditLogError () const
 
bool isAuditLogSupported () const
 

Protected Member Functions

 SignKeyJob (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 to sign keys asynchronously.

To use a SignKeyJob, first obtain an instance from the CryptoBackend implementation, connect the 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 ChangeExpiryJob instance will have scheduled it's own destruction with a call to QObject::deleteLater().

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

Member Function Documentation

◆ setCheckLevel()

virtual void QGpgME::SignKeyJob::setCheckLevel ( unsigned int  checkLevel)
pure virtual

sets the check level

Parameters
thecheck level, ranges from 0 (no claim) and 3 (extensively checked), default is 0

Implemented in QGpgME::QGpgMESignKeyJob.

◆ setExportable()

virtual void QGpgME::SignKeyJob::setExportable ( bool  exportable)
pure virtual

sets whether the signature should be exportable, or local only. default is local.

Implemented in QGpgME::QGpgMESignKeyJob.

◆ setNonRevocable()

virtual void QGpgME::SignKeyJob::setNonRevocable ( bool  nonRevocable)
pure virtual

if set, the created signature won't be revocable. By default signatures can be revoked.

Implemented in QGpgME::QGpgMESignKeyJob.

◆ setSigningKey()

virtual void QGpgME::SignKeyJob::setSigningKey ( const GpgME::Key &  key)
pure virtual

sets an alternate signing key

Implemented in QGpgME::QGpgMESignKeyJob.

◆ setUserIDsToSign()

virtual void QGpgME::SignKeyJob::setUserIDsToSign ( const std::vector< unsigned int > &  idsToSign)
pure virtual

If explicitly specified, only the listed user IDs will be signed. Otherwise all user IDs are signed.

Parameters
listof user ID indexes (of the key to be signed).

Implemented in QGpgME::QGpgMESignKeyJob.

◆ start()

virtual GpgME::Error QGpgME::SignKeyJob::start ( const GpgME::Key &  keyToSign)
pure virtual

Starts the key signing operation. key is the key to sign.

Parameters
keyToSignthe key to be signed
idsToSignthe user IDs to sign
signingKeythe secret key to use for signing
optionthe signing mode, either local or exportable

Implemented in QGpgME::QGpgMESignKeyJob.


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