KGpgTextOrFileTransaction Class Reference

#include <kgpgtextorfiletransaction.h>

Inheritance diagram for KGpgTextOrFileTransaction:

Public Types
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
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)

Protected Member Functions
	KGpgTextOrFileTransaction (QObject *parent=0, const QString &text=QString(), const bool allowChaining=false)
	KGpgTextOrFileTransaction (QObject *parent, const KUrl::List &files, const bool allowChaining=false)
virtual QStringList	command () const =0
virtual void	finish ()
const KUrl::List &	getInputFiles () const
virtual bool	nextLine (const QString &line)
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 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
Signals inherited from KGpgTransaction
void	done (int result)
void	infoProgress (qulonglong processedAmount, qulonglong totalAmount)
void	statusMessage (const QString &msg)

Detailed Description

feed a text or file through gpg

Definition at line 29 of file kgpgtextorfiletransaction.h.

Member Enumeration Documentation

enum KGpgTextOrFileTransaction::ts_import

additional status codes for KGpgImport

Enumerator
TS_KIO_FAILED	download of remote file failed

Definition at line 38 of file kgpgtextorfiletransaction.h.

Constructor & Destructor Documentation

KGpgTextOrFileTransaction::KGpgTextOrFileTransaction ( QObject *  parent = 0, const QString &  text = QString(), const bool  allowChaining = false  )

explicitprotected

work with given text

Parameters

parent	parent object
text	text to work with

Definition at line 23 of file kgpgtextorfiletransaction.cpp.

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

protected

work with given file(s)

Parameters

parent	parent object
keys	list of file locations to work with

Definition at line 29 of file kgpgtextorfiletransaction.cpp.

KGpgTextOrFileTransaction::~KGpgTextOrFileTransaction ( )

virtual

destructor

Definition at line 35 of file kgpgtextorfiletransaction.cpp.

Member Function Documentation

virtual QStringList KGpgTextOrFileTransaction::command ( ) const

protectedpure virtual

Implemented in KGpgImport, KGpgEncrypt, KGpgVerify, KGpgDecrypt, and KGpgSignText.

void KGpgTextOrFileTransaction::finish ( )

protectedvirtual

implement special handling for GnuPG return codes

Reimplemented from KGpgTransaction.

Reimplemented in KGpgVerify.

Definition at line 151 of file kgpgtextorfiletransaction.cpp.

const KUrl::List & KGpgTextOrFileTransaction::getInputFiles ( ) const

protected

Definition at line 176 of file kgpgtextorfiletransaction.cpp.

const QStringList & KGpgTextOrFileTransaction::getMessages

(

)

const

get gpg info message

Returns

the raw messages from gpg during the operation

Definition at line 159 of file kgpgtextorfiletransaction.cpp.

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

Reimplemented in KGpgEncrypt, KGpgVerify, and KGpgDecrypt.

Definition at line 143 of file kgpgtextorfiletransaction.cpp.

bool KGpgTextOrFileTransaction::preStart ( )

protectedvirtual

construct the command line of the process

Reimplemented from KGpgTransaction.

Definition at line 86 of file kgpgtextorfiletransaction.cpp.

void KGpgTextOrFileTransaction::setText

(

const QString &

text

)

set text to work with

Parameters

text	text to work with

Definition at line 41 of file kgpgtextorfiletransaction.cpp.

void KGpgTextOrFileTransaction::setUrls

(

const KUrl::List &

files

)

set file locations to work with

Parameters

keys	list of file locations to work with

Definition at line 79 of file kgpgtextorfiletransaction.cpp.

---

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

• kgpgtextorfiletransaction.h
• kgpgtextorfiletransaction.cpp