KGpgKeyserverSearchTransaction Class Reference

#include <kgpgkeyserversearchtransaction.h>

Inheritance diagram for KGpgKeyserverSearchTransaction:

Signals
void	newKey (QStringList lines)
Signals inherited from KGpgTransaction
void	done (int result)
void	infoProgress (qulonglong processedAmount, qulonglong totalAmount)
void	statusMessage (const QString &msg)

Public Member Functions
	KGpgKeyserverSearchTransaction (QObject *parent, const QString &keyserver, const QString &pattern, const bool withProgress=false, const QString &proxy=QString())
virtual	~KGpgKeyserverSearchTransaction ()
void	setPattern (const QString &pattern)
Public Member Functions inherited from KGpgKeyserverTransaction
virtual	~KGpgKeyserverTransaction ()
void	setKeyserver (const QString &server)
void	setProgressEnable (const bool b)
void	setProxy (const QString &proxy)
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)

Protected Member Functions
virtual void	finish ()
virtual bool	nextLine (const QString &line)
virtual bool	preStart ()
Protected Member Functions inherited from KGpgKeyserverTransaction
	KGpgKeyserverTransaction (QObject *parent, const QString &keyserver, const bool withProgress=false, const QString &proxy=QString())
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 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)

Additional Inherited Members
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 }

Detailed Description

base class for transactions downloading from key servers

Definition at line 26 of file kgpgkeyserversearchtransaction.h.

Constructor & Destructor Documentation

KGpgKeyserverSearchTransaction::KGpgKeyserverSearchTransaction	(	QObject *	parent,
		const QString &	keyserver,
		const QString &	pattern,
		const bool	withProgress = false,
		const QString &	proxy = QString()
	)

construct a new search on the given keyserver

Parameters

parent	object that owns the transaction
keyserver	keyserver to work with
pattern	the search pattern
withProgress	show a progress window with cancel button
proxy	http proxy to use

You should call this from the childrens constructor to set up everything properly

Definition at line 16 of file kgpgkeyserversearchtransaction.cpp.

KGpgKeyserverSearchTransaction::~KGpgKeyserverSearchTransaction ( )

virtual

Definition at line 25 of file kgpgkeyserversearchtransaction.cpp.

Member Function Documentation

void KGpgKeyserverSearchTransaction::finish ( )

protectedvirtual

needed to submit the last search result

Reimplemented from KGpgKeyserverTransaction.

Definition at line 64 of file kgpgkeyserversearchtransaction.cpp.

void KGpgKeyserverSearchTransaction::newKey ( QStringList  lines )

signal

emitted every time a new key is completed

Parameters

lines

the lines that belong to that key

bool KGpgKeyserverSearchTransaction::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 39 of file kgpgkeyserversearchtransaction.cpp.

bool KGpgKeyserverSearchTransaction::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 KGpgKeyserverTransaction.

Definition at line 30 of file kgpgkeyserversearchtransaction.cpp.

void KGpgKeyserverSearchTransaction::setPattern

(

const QString &

pattern

)

Definition at line 73 of file kgpgkeyserversearchtransaction.cpp.

---

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

• kgpgkeyserversearchtransaction.h
• kgpgkeyserversearchtransaction.cpp