#include <kgpggeneratekey.h>

Inheritance diagram for KGpgGenerateKey:

Public Types
enum	ts_generatekey { TS_INVALID_NAME = 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
	KGpgGenerateKey (QObject *parent, const QString &name, const QString &email, const QString &comment, const KgpgCore::KgpgKeyAlgo &algorithm, const uint size, const unsigned int expire=0, const char expireunit= 'd', const KgpgCore::KgpgSubKeyType capabilities=0)

virtual	~KGpgGenerateKey ()

QString	getEmail () const

QString	getFingerprint () const

QString	getName () const

QString	gpgErrorMessage () const

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

Protected Member Functions
virtual void	finish ()

virtual void	newPassphraseEntered ()

virtual bool	nextLine (const QString &line)

virtual void	postStart ()

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)

virtual ts_boolanswer	confirmOverwrite (KUrl &currentFile)

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 bool	passphraseReceived ()

virtual bool	passphraseRequested ()

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

generate a new key pair

Definition at line 28 of file kgpggeneratekey.h.

Member Enumeration Documentation

enum KGpgGenerateKey::ts_generatekey

Enumerator
TS_INVALID_NAME	the owners name is not accepted by GnuPG

Definition at line 34 of file kgpggeneratekey.h.

Constructor & Destructor Documentation

KGpgGenerateKey::KGpgGenerateKey	(	QObject *	parent,
		const QString &	name,
		const QString &	email,
		const QString &	comment,
		const KgpgCore::KgpgKeyAlgo &	algorithm,
		const uint	size,
		const unsigned int	expire = `0`,
		const char	expireunit = `'d'`,
		const KgpgCore::KgpgSubKeyType	capabilities = `0`
	)

KGpgGenerateKey's constructor.

Parameters

parent	parent object
name	the name of the key, it is also the user's name.
email	email MUST be a valid email address or an empty string.
comment	is a comment, it can be an empty string
algorithm	this is the type of the key, RSA or DSA & ELGAMAL (

See also: Kgpg::KeyAlgo ).

Parameters

size	this is the length of the key (1024, 2048, ...)
expire	defines the key expiry time together with expireunit, 0 for unlimited key lifetime
expireunit	is the unit of the number given as expire. Valid units are 'd', 'w', 'm' and 'y'. The unit is ignored if expire is 0.
capabilities	capabilities for the primary key

Definition at line 23 of file kgpggeneratekey.cpp.

KGpgGenerateKey::~KGpgGenerateKey ( )

virtual

Definition at line 48 of file kgpggeneratekey.cpp.

Member Function Documentation

void KGpgGenerateKey::finish ( )

protectedvirtual

Called when the gpg process finishes.

You may reimplement this member if you need to do some special operations after process completion. The provided one simply does nothing which should be enough for most cases.

Reimplemented from KGpgTransaction.

Definition at line 201 of file kgpggeneratekey.cpp.

QString KGpgGenerateKey::getEmail ( ) const

Definition at line 249 of file kgpggeneratekey.cpp.

QString KGpgGenerateKey::getFingerprint ( ) const

return the fingerprint of the generated key

Definition at line 255 of file kgpggeneratekey.cpp.

QString KGpgGenerateKey::getName ( ) const

Definition at line 243 of file kgpggeneratekey.cpp.

QString KGpgGenerateKey::gpgErrorMessage ( ) const

get error output of GnuPG

Returns: the messages GnuPG printed to standard error

This will only return data after the done() signal has been emitted.

Definition at line 261 of file kgpggeneratekey.cpp.

void KGpgGenerateKey::newPassphraseEntered ( )

protectedvirtual

called when the user entered a new passphrase

This is called after askNewPassphrase() was called, the user has entered a new passphrase and it was sent to the GnuPG process.

The default implementation does nothing.

Reimplemented from KGpgTransaction.

Definition at line 236 of file kgpggeneratekey.cpp.

bool KGpgGenerateKey::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.

Implements KGpgTransaction.

Definition at line 149 of file kgpggeneratekey.cpp.

void KGpgGenerateKey::postStart ( )

protectedvirtual

Called when the gpg process is up and running.

This functions is connected to the started() signal of the gpg process.

Reimplemented from KGpgTransaction.

Definition at line 70 of file kgpggeneratekey.cpp.

bool KGpgGenerateKey::preStart ( )

protectedvirtual

Called before the gpg process is started.

Returns: true if the process should be started

You may reimplement this member if you need to do some special operations before the process is started. The command line of the process may be modified for the last time here.

When you notice that some values passed are invalid or the transaction does not need to be run for some other reason you should call setSuccess() to set the return value and return false. In this case the process is not started but the value is immediately returned.

Reimplemented from KGpgTransaction.

Definition at line 53 of file kgpggeneratekey.cpp.

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

kgpg

Public Types

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