#include <kgpgencrypt.h>

Inheritance diagram for KGpgEncrypt:

Public Types
enum	EncryptOption { DefaultEncryption = 0, AsciiArmored = 0x1, AllowUntrustedEncryption = 0x2, HideKeyId = 0x4 }

Public Types inherited from KGpgTextOrFileTransaction
enum	ts_import { TS_KIO_FAILED = TS_COMMON_END + 1 }

Public Types inherited from KGpgTransaction
enum	ts_boolanswer { BA_UNKNOWN = 0, BA_YES = 1, BA_NO = 2 }

enum	ts_hintType { HT_KEYEXPIRED = 0, HT_SIGEXPIRED = 1, HT_NOSECKEY = 2, HT_ENCTO = 3 }

enum	ts_transaction { TS_OK = 0, TS_BAD_PASSPHRASE = 1, TS_MSG_SEQUENCE = 2, TS_USER_ABORTED = 3, TS_INVALID_EMAIL = 4, TS_INPUT_PROCESS_ERROR = 5, TS_COMMON_END = 100 }

Public Member Functions
	KGpgEncrypt (QObject *parent, const QStringList &userIds=QStringList(), const QString &text=QString(), const EncryptOptions &options=DefaultEncryption, const QStringList &extraOptions=QStringList())

	KGpgEncrypt (QObject *parent, const QStringList &userIds, const KUrl::List &files, const EncryptOptions &options=DefaultEncryption, const QStringList &extraOptions=QStringList())

virtual	~KGpgEncrypt ()

QStringList	encryptedText () const

	Q_DECLARE_FLAGS (EncryptOptions, EncryptOption)

Public Member Functions inherited from KGpgTextOrFileTransaction
virtual	~KGpgTextOrFileTransaction ()

const QStringList &	getMessages () const

void	setText (const QString &text)

void	setUrls (const KUrl::List &files)

Public Member Functions inherited from KGpgTransaction
	KGpgTransaction (QObject *parent=0, const bool allowChaining=false)

virtual	~KGpgTransaction ()

void	clearInputTransaction ()

const QString &	getDescription () const

bool	hasInputTransaction () const

void	kill ()

void	setGnuPGHome (const QString &home)

void	setInputTransaction (KGpgTransaction *ta)

void	start ()

int	waitForFinished (const int msecs=-1)

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

Static Public Member Functions
static QString	encryptExtension (const bool ascii)

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)

Protected Member Functions
virtual QStringList	command () const

virtual ts_boolanswer	confirmOverwrite (KUrl &currentFile)

virtual bool	nextLine (const QString &line)

Protected Member Functions inherited from KGpgTextOrFileTransaction
	KGpgTextOrFileTransaction (QObject *parent=0, const QString &text=QString(), const bool allowChaining=false)

	KGpgTextOrFileTransaction (QObject *parent, const KUrl::List &files, const bool allowChaining=false)

virtual void	finish ()

const KUrl::List &	getInputFiles () const

virtual bool	preStart ()

Protected Member Functions inherited from KGpgTransaction
int	addArgument (const QString &arg)

void	addArgumentRef (int *ref)

int	addArguments (const QStringList &args)

void	addIdHint (QString txt)

void	askNewPassphrase (const QString &text)

bool	askPassphrase (const QString &message=QString())

virtual ts_boolanswer	boolQuestion (const QString &line)

QString	getIdHints () const

GPGProc *	getProcess ()

int	getSuccess () const

virtual bool	hintLine (const ts_hintType hint, const QString &args)

void	insertArgument (const int pos, const QString &arg)

void	insertArguments (const int pos, const QStringList &args)

virtual void	newPassphraseEntered ()

virtual bool	passphraseReceived ()

virtual bool	passphraseRequested ()

virtual void	postStart ()

void	replaceArgument (const int pos, const QString &arg)

void	setDescription (const QString &description)

void	setSuccess (const int v)

void	unexpectedLine (const QString &line)

void	waitForInputTransaction ()

void	write (const QByteArray &a, const bool lf=true)

void	write (const int i)

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
Signals inherited from KGpgTransaction
void	done (int result)

void	infoProgress (qulonglong processedAmount, qulonglong totalAmount)

void	statusMessage (const QString &msg)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

encrypt the given text or files

Definition at line 30 of file kgpgencrypt.h.

Member Enumeration Documentation

enum KGpgEncrypt::EncryptOption

Enumerator
DefaultEncryption	use whatever GnuPGs defaults are
AsciiArmored	output the data as printable ASCII as opposed to binary data
AllowUntrustedEncryption	allow encryption with untrusted keys, ignored for symmetric encryption
HideKeyId	remove anything that shows which key ids this data is encrypted to, ignored for symmetric encryption

Definition at line 36 of file kgpgencrypt.h.

Constructor & Destructor Documentation

KGpgEncrypt::KGpgEncrypt	(	QObject *	parent,
		const QStringList &	userIds = `QStringList()`,
		const QString &	text = `QString()`,
		const EncryptOptions &	options = `DefaultEncryption`,
		const QStringList &	extraOptions = `QStringList()`
	)

explicit

encrypt given text

Parameters

parent	parent object
userIds	ids to encrypt to or empty list to use symmetric encryption with passphrase
text	text to encrypt
options	encryption options

Definition at line 32 of file kgpgencrypt.cpp.

KGpgEncrypt::KGpgEncrypt	(	QObject *	parent,
		const QStringList &	userIds,
		const KUrl::List &	files,
		const EncryptOptions &	options = `DefaultEncryption`,
		const QStringList &	extraOptions = `QStringList()`
	)

encrypt file(s)

Parameters

parent	parent object
userIds	ids to encrypt to or empty list to use symmetric encryption with passphrase
files	list of file locations to encrypt
options	encryption options

Definition at line 43 of file kgpgencrypt.cpp.

KGpgEncrypt::~KGpgEncrypt ( )

virtual

destructor

Definition at line 54 of file kgpgencrypt.cpp.

Member Function Documentation

QStringList KGpgEncrypt::command ( ) const

protectedvirtual

Implements KGpgTextOrFileTransaction.

Definition at line 59 of file kgpgencrypt.cpp.

KGpgTransaction::ts_boolanswer KGpgEncrypt::confirmOverwrite ( KUrl & currentFile )

protectedvirtual

called when GnuPG asks for confirmation for overwriting a file

Parameters

currentFile fill in the current filename for the user dialog

Returns: what to answer to GnuPG

Return values

BA_YES	file will be overwritten, is ignored
BA_NO	file will not be overwritten, if currentFile is given this will automatically be provided as alternative to GnuPG
BA_UNKNOWN	ask the user for a choice or abort, currentFile is provided to the user as a hint about the original filename, if currentFile is empty the transaction is aborted

The default implementation will just return BA_UNKNOWN without setting a filename, causing a sequence error.

Reimplemented from KGpgTransaction.

Definition at line 119 of file kgpgencrypt.cpp.

QStringList KGpgEncrypt::encryptedText ( ) const

get decryption result

Returns: decrypted text

Definition at line 81 of file kgpgencrypt.cpp.

QString KGpgEncrypt::encryptExtension ( const bool ascii )

static

return the preferred extension for encrypted files

Parameters

ascii if the file is encrypted with ASCII armor

Returns: the file extension with leading dot

Definition at line 132 of file kgpgencrypt.cpp.

bool KGpgEncrypt::nextLine ( const QString & line )

protectedvirtual

Called for every line the gpg process writes.

Parameters

line	the input from the process

Returns: true if "quit" should be sent to process

You need to implement this member to get a usable subclass.

When this function returns true "quit" is written to the process.

Reimplemented from KGpgTextOrFileTransaction.

Definition at line 96 of file kgpgencrypt.cpp.

KGpgEncrypt::Q_DECLARE_FLAGS	(	EncryptOptions	,
		EncryptOption
	)

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

kgpg

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kgpg

kdeutils API Reference

Search