Kleo::ListAllKeysJob Class Reference

#include <listallkeysjob.h>

Inheritance diagram for Kleo::ListAllKeysJob:

Signals
void	result (const GpgME::KeyListResult &result, const std::vector< GpgME::Key > &pub=std::vector< GpgME::Key >(), const std::vector< GpgME::Key > &sec=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
	~ListAllKeysJob ()
virtual GpgME::KeyListResult	exec (std::vector< GpgME::Key > &pub, std::vector< GpgME::Key > &sec, bool mergeKeys=false)=0
virtual GpgME::Error	start (bool mergeKeys=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
	ListAllKeysJob (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 asynchronously listing all keys.

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

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

This is potentially much faster than a KeyListJob with empty pattern.

Definition at line 67 of file listallkeysjob.h.

Constructor & Destructor Documentation

Kleo::ListAllKeysJob::ListAllKeysJob ( QObject *  parent )

explicitprotected

Kleo::ListAllKeysJob::~ListAllKeysJob

(

)

Member Function Documentation

virtual GpgME::KeyListResult Kleo::ListAllKeysJob::exec ( std::vector< GpgME::Key > &  pub, std::vector< GpgME::Key > &  sec, bool  mergeKeys = false  )

pure virtual

Synchronous version of start().

Implemented in Kleo::QGpgMEListAllKeysJob.

void Kleo::ListAllKeysJob::result ( const GpgME::KeyListResult &  result, const std::vector< GpgME::Key > &  pub = std::vector< GpgME::Key >(), const std::vector< GpgME::Key > &  sec = std::vector< GpgME::Key >(), const QString &  auditLogAsHtml = QString(), const GpgME::Error &  auditLogError = GpgME::Error()  )

signal

virtual GpgME::Error Kleo::ListAllKeysJob::start ( bool  mergeKeys = false )

pure virtual

Starts the listallkeys operation.

In general, 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 result object).

If mergeKeys is true, secret keys are merged into public keys.

Implemented in Kleo::QGpgMEListAllKeysJob.

---

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

• listallkeysjob.h