KGpgSignText Class Reference

#include <kgpgsigntext.h>

Inheritance diagram for KGpgSignText:

Public Types
enum	SignOption { DefaultSignature = 0, AsciiArmored = 0x1, DetachedSignature = 0x2 }
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
	KGpgSignText (QObject *parent, const QString &signId, const QString &text=QString(), const SignOptions &options=AsciiArmored, const QStringList &extraOptions=QStringList())
	KGpgSignText (QObject *parent, const QString &signId, const KUrl::List &files, const SignOptions &options=DefaultSignature, const QStringList &extraOptions=QStringList())
virtual	~KGpgSignText ()
	Q_DECLARE_FLAGS (SignOptions, SignOption)
QStringList	signedText () const
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)

Protected Member Functions
virtual QStringList	command () const
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	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

sign the given text or files

Definition at line 29 of file kgpgsigntext.h.

Member Enumeration Documentation

enum KGpgSignText::SignOption

Enumerator
DefaultSignature	use whatever GnuPGs defaults are
AsciiArmored	output the data as printable ASCII as opposed to binary data
DetachedSignature	save the signature in a separate file

Definition at line 35 of file kgpgsigntext.h.

Constructor & Destructor Documentation

KGpgSignText::KGpgSignText	(	QObject *	parent,
		const QString &	signId,
		const QString &	text = QString(),
		const SignOptions &	options = AsciiArmored,
		const QStringList &	extraOptions = QStringList()
	)

sign given text

Parameters

parent	parent object
signId	the key to use for signing
text	text to sign
options	signing options

Definition at line 18 of file kgpgsigntext.cpp.

KGpgSignText::KGpgSignText	(	QObject *	parent,
		const QString &	signId,
		const KUrl::List &	files,
		const SignOptions &	options = DefaultSignature,
		const QStringList &	extraOptions = QStringList()
	)

sign file

Parameters

parent	parent object
signId	the key to use for signing
files	list of file locations to sign (must only be 1 file)
options	signing options

Warning

GnuPG can currently handle only one file per invocation for signing, so files may only contain one single file.

Definition at line 27 of file kgpgsigntext.cpp.

KGpgSignText::~KGpgSignText ( )

virtual

destructor

Definition at line 38 of file kgpgsigntext.cpp.

Member Function Documentation

QStringList KGpgSignText::command ( ) const

protectedvirtual

Implements KGpgTextOrFileTransaction.

Definition at line 43 of file kgpgsigntext.cpp.

KGpgSignText::Q_DECLARE_FLAGS	(	SignOptions	,
		SignOption
	)

QStringList KGpgSignText::signedText

(

)

const

get signing result

Returns

signed text

Definition at line 74 of file kgpgsigntext.cpp.

---

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

• kgpgsigntext.h
• kgpgsigntext.cpp