Kleo::EncryptJob Class Reference

#include <encryptjob.h>

Inheritance diagram for Kleo::EncryptJob:

Signals
void	result (const GpgME::EncryptionResult &result, const QByteArray &cipherText, 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
	~EncryptJob ()
virtual GpgME::EncryptionResult	exec (const std::vector< GpgME::Key > &recipients, const QByteArray &plainText, bool alwaysTrust, QByteArray &cipherText)=0
virtual void	setOutputIsBase64Encoded (bool)=0
virtual KDE_DEPRECATED GpgME::Error	start (const std::vector< GpgME::Key > &recipients, const QByteArray &plainText, bool alwaysTrust=false)=0
virtual void	start (const std::vector< GpgME::Key > &recipients, const boost::shared_ptr< QIODevice > &plainText, const boost::shared_ptr< QIODevice > &cipherText=boost::shared_ptr< QIODevice >(), bool alwaysTrust=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
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
	EncryptJob (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 encrypters.

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

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

Definition at line 69 of file encryptjob.h.

Constructor & Destructor Documentation

Kleo::EncryptJob::EncryptJob ( QObject *  parent )

explicitprotected

Kleo::EncryptJob::~EncryptJob

(

)

Member Function Documentation

virtual GpgME::EncryptionResult Kleo::EncryptJob::exec ( const std::vector< GpgME::Key > &  recipients, const QByteArray &  plainText, bool  alwaysTrust, QByteArray &  cipherText  )

pure virtual

Implemented in Kleo::QGpgMEEncryptJob.

void Kleo::EncryptJob::result ( const GpgME::EncryptionResult &  result, const QByteArray &  cipherText, const QString &  auditLogAsHtml = QString(), const GpgME::Error &  auditLogError = GpgME::Error()  )

signal

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

pure virtual

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

Implemented in Kleo::QGpgMEEncryptJob.

virtual KDE_DEPRECATED GpgME::Error Kleo::EncryptJob::start ( const std::vector< GpgME::Key > &  recipients, const QByteArray &  plainText, bool  alwaysTrust = false  )

pure virtual

Starts the encryption operation.

recipients is the a list of keys to encrypt plainText to. Empty (null) keys are ignored. If recipients is empty, performs symmetric (passphrase) encryption.

If alwaysTrust is true, validity checking for the keys will not be performed, but full validity assumed for all keys without further checks.

Implemented in Kleo::QGpgMEEncryptJob.

virtual void Kleo::EncryptJob::start ( const std::vector< GpgME::Key > &  recipients, const boost::shared_ptr< QIODevice > &  plainText, const boost::shared_ptr< QIODevice > &  cipherText = boost::shared_ptr< QIODevice >(), bool  alwaysTrust = false  )

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 cipherText is non-null, the ciphertext is written there. Otherwise, it will be delivered in the second argument of result().

Exceptions

GpgME::Exception

if starting fails

Implemented in Kleo::QGpgMEEncryptJob.

---

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

• encryptjob.h