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
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
	SignJob (QObject *parent)
Protected Member Functions inherited from Kleo::Job
	Job (QObject *parent)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Slots inherited from Kleo::Job
virtual void	slotCancel ()=0
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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 71 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