Kleo::KeyListJob Class Reference

#include <keylistjob.h>

Inheritance diagram for Kleo::KeyListJob:

Signals
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 Kleo::Job
void	done ()
void	progress (const QString &what, int current, int total)

Public Member Functions
	~KeyListJob ()
virtual GpgME::KeyListResult	exec (const QStringList &patterns, bool secretOnly, std::vector< GpgME::Key > &keys)=0
virtual GpgME::Error	start (const QStringList &patterns, bool secretOnly=false)=0
Public Member Functions inherited from Kleo::Job
	~Job ()
virtual QString	auditLogAsHtml () const
virtual GpgME::Error	auditLogError () const
bool	isAuditLogSupported () const
virtual void	showErrorDialog (QWidget *parent=0, const QString &caption=QString()) const

Protected Member Functions
	KeyListJob (QObject *parent)
Protected Member Functions inherited from Kleo::Job
	Job (QObject *parent)

Additional Inherited Members
Public Slots inherited from Kleo::Job
virtual void	slotCancel ()=0

Detailed Description

An abstract base class for asynchronous key listers.

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

During keylisting, you will receive new key objects through the nextKey() signal as they arrive. After result() is emitted, the KeyListJob will schedule it's own destruction by calling QObject::deleteLater().

Definition at line 66 of file keylistjob.h.

Constructor & Destructor Documentation

Kleo::KeyListJob::KeyListJob ( QObject *  parent )

explicitprotected

Kleo::KeyListJob::~KeyListJob

(

)

Member Function Documentation

virtual GpgME::KeyListResult Kleo::KeyListJob::exec ( const QStringList &  patterns, bool  secretOnly, std::vector< GpgME::Key > &  keys  )

pure virtual

Implemented in Kleo::HierarchicalKeyListJob, and Kleo::QGpgMEKeyListJob.

void Kleo::KeyListJob::nextKey ( const GpgME::Key &  key )

signal

void Kleo::KeyListJob::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()  )

signal

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

pure virtual

Starts the keylist operation.

pattern is a list of patterns used to restrict the list of keys returned. Empty patterns are ignored. If pattern is empty or contains only empty strings, all keys are returned (however, the backend is free to truncate the result and should do so; when this happens, it will be reported by the reult object).

If secretOnly is true, only keys for which the secret key is also available are returned. Use this if you need to select a key for signing.

Implemented in Kleo::HierarchicalKeyListJob, and Kleo::QGpgMEKeyListJob.

---

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

• keylistjob.h