QGpgME  10.3.4.0000000
Qt API for GpgME
Public Member Functions | List of all members
QGpgME::HierarchicalKeyListJob Class Reference

A convenience job that additionally fetches all available issuers. More...

#include <hierarchicalkeylistjob.h>

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

Public Member Functions

 HierarchicalKeyListJob (const Protocol *protocol, bool remote=false, bool includeSigs=false, bool validating=false)
 
GpgME::Error start (const QStringList &patterns, bool secretOnly=false) Q_DECL_OVERRIDE
 
GpgME::KeyListResult exec (const QStringList &patterns, bool secretOnly, std::vector< GpgME::Key > &keys) Q_DECL_OVERRIDE
 
- Public Member Functions inherited from QGpgME::KeyListJob
virtual void addMode (GpgME::KeyListMode mode)=0
 
- Public Member Functions inherited from QGpgME::Job
virtual QString auditLogAsHtml () const
 
virtual GpgME::Error auditLogError () const
 
bool isAuditLogSupported () const
 

Additional Inherited Members

- Public Slots inherited from QGpgME::Job
virtual void slotCancel ()=0
 
- Signals inherited from QGpgME::KeyListJob
void nextKey (const GpgME::Key &key)
 
void result (const GpgME::KeyListResult &result, const std::vector< GpgME::Key > &keys=std::vector< GpgME::Key >(), 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 ()
 
- Static Public Member Functions inherited from QGpgME::Job
static GpgME::Context * context (Job *job)
 
- Protected Member Functions inherited from QGpgME::KeyListJob
 KeyListJob (QObject *parent)
 
- Protected Member Functions inherited from QGpgME::Job
 Job (QObject *parent)
 

Detailed Description

A convenience job that additionally fetches all available issuers.

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

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

Member Function Documentation

◆ start()

GpgME::Error QGpgME::HierarchicalKeyListJob::start ( const QStringList &  patterns,
bool  secretOnly = false 
)
virtual

Starts the keylist operation. patterns is a list of patterns used to restrict the list of keys returned. Empty patterns are ignored. patterns must not be empty or contain only empty patterns; use the normal KeyListJob for a full listing.

The secretOnly parameter is ignored by HierarchicalKeyListJob and must be set to false.

Implements QGpgME::KeyListJob.


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