Kleo::SignJob Class Reference

#include <signjob.h>

Inheritance diagram for Kleo::SignJob:

Signals
void	result (const GpgME::SigningResult &result, const QByteArray &signature, 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
	~SignJob ()
virtual GpgME::SigningResult	exec (const std::vector< GpgME::Key > &signers, const QByteArray &plainText, GpgME::SignatureMode mode, QByteArray &signature)=0
virtual void	setOutputIsBase64Encoded (bool)=0
virtual KDE_DEPRECATED GpgME::Error	start (const std::vector< GpgME::Key > &signers, const QByteArray &plainText, GpgME::SignatureMode mode)=0
virtual void	start (const std::vector< GpgME::Key > &signers, const boost::shared_ptr< QIODevice > &plainText, const boost::shared_ptr< QIODevice > &signature, GpgME::SignatureMode mode)=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
	SignJob (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 signing.

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

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

Definition at line 69 of file signjob.h.

Constructor & Destructor Documentation

Kleo::SignJob::SignJob ( QObject *  parent )

explicitprotected

Kleo::SignJob::~SignJob

(

)

Member Function Documentation

virtual GpgME::SigningResult Kleo::SignJob::exec ( const std::vector< GpgME::Key > &  signers, const QByteArray &  plainText, GpgME::SignatureMode  mode, QByteArray &  signature  )

pure virtual

Implemented in Kleo::QGpgMESignJob.

void Kleo::SignJob::result ( const GpgME::SigningResult &  result, const QByteArray &  signature, const QString &  auditLogAsHtml = QString(), const GpgME::Error &  auditLogError = GpgME::Error()  )

signal

virtual void Kleo::SignJob::setOutputIsBase64Encoded ( bool  )

pure virtual

This is a hack to request BASE64 output (instead of whatever comes out normally).

Implemented in Kleo::QGpgMESignJob.

virtual KDE_DEPRECATED GpgME::Error Kleo::SignJob::start ( const std::vector< GpgME::Key > &  signers, const QByteArray &  plainText, GpgME::SignatureMode  mode  )

pure virtual

Starts the signing operation.

signers is the list of keys to sign plainText with. Empty (null) keys are ignored.

Implemented in Kleo::QGpgMESignJob.

virtual void Kleo::SignJob::start ( const std::vector< GpgME::Key > &  signers, const boost::shared_ptr< QIODevice > &  plainText, const boost::shared_ptr< QIODevice > &  signature, GpgME::SignatureMode  mode  )

pure virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

If signature is non-null the signature is written there. Otherwise, it will be delivered in the second argument of result().

Exceptions

GpgME::Exception

if starting fails

Implemented in Kleo::QGpgMESignJob.

---

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

• signjob.h