• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdeutils API Reference
  • KDE Home
  • Contact Us
 

kgpg

Public Member Functions | Protected Member Functions | List of all members
KGpgSignKey Class Reference

#include <kgpgsignkey.h>

Inheritance diagram for KGpgSignKey:
Inheritance graph
[legend]

Public Member Functions

 KGpgSignKey (QObject *parent, const QString &signer, KGpgKeyNode *key, const bool local, const carefulCheck checking)
 
virtual ~KGpgSignKey ()
 
- Public Member Functions inherited from KGpgEditKeyTransaction
virtual ~KGpgEditKeyTransaction ()
 
QString getKeyid () 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
 
- Public Member Functions inherited from KGpgSignTransactionHelper
virtual ~KGpgSignTransactionHelper ()
 
carefulCheck getChecking (void) const
 
const KGpgKeyNode * getKey (void) const
 
bool getLocal (void) const
 
QString getSigner (void) const
 
void setChecking (const carefulCheck level)
 
void setKey (const KGpgKeyNode *node)
 
void setLocal (const bool local)
 
void setSecringFile (const QString &filename)
 
void setSigner (const QString &signer)
 

Protected Member Functions

virtual KGpgTransaction * asTransaction ()
 
virtual ts_boolanswer boolQuestion (const QString &line)
 
virtual bool nextLine (const QString &line)
 
virtual bool passphraseReceived ()
 
virtual void replaceCmd (const QString &cmd)
 
- Protected Member Functions inherited from KGpgEditKeyTransaction
 KGpgEditKeyTransaction (QObject *parent, const QString &keyid, const QString &command, const bool hasValue, const bool autoSave=true)
 
virtual bool preStart ()
 
void replaceCommand (const QString &cmd)
 
void replaceValue (const QString &arg)
 
- 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 confirmOverwrite (KUrl &currentFile)
 
virtual void finish ()
 
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 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)
 
- Protected Member Functions inherited from KGpgSignTransactionHelper
 KGpgSignTransactionHelper (const QString &signer, const bool local, const carefulCheck checking)
 
KGpgTransaction::ts_boolanswer boolQuestion (const QString &line)
 
lineParseResults nextLine (const QString &line)
 

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
}
 
- Public Types inherited from KGpgSignTransactionHelper
enum  carefulCheck { noAnswer = 0, notChecked = 1, normalChecking = 2, carefulChecking = 3 }
 
enum  lineParseResults { handledFalse, handledTrue, notHandled }
 
enum  ts_signuid { TS_ALREADY_SIGNED = KGpgTransaction::TS_COMMON_END + 1 }
 
- 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)
 
- Protected Attributes inherited from KGpgSignTransactionHelper
int m_signerPos
 
- Properties inherited from QObject
 objectName
 

Detailed Description

transaction class to sign all user ids of a key

Definition at line 28 of file kgpgsignkey.h.

Constructor & Destructor Documentation

KGpgSignKey::KGpgSignKey ( QObject *  parent,
const QString &  signer,
KGpgKeyNode *  key,
const bool  local,
const carefulCheck  checking 
)

constructor

Parameters
parentparent object
signerid of the key to sign with
keynode to sign
localif signature should be local (not exportable)
checkinghow carefully the identity of the key owner was checked

See setUid() for description of uid.

Definition at line 18 of file kgpgsignkey.cpp.

KGpgSignKey::~KGpgSignKey ( )
virtual

destructor

Definition at line 34 of file kgpgsignkey.cpp.

Member Function Documentation

KGpgTransaction * KGpgSignKey::asTransaction ( )
protectedvirtual

returns the transaction object to use

This should really be static_cast<>(this) as you should only use this class as one of two anchestors of a transaction.

Implements KGpgSignTransactionHelper.

Definition at line 76 of file kgpgsignkey.cpp.

KGpgTransaction::ts_boolanswer KGpgSignKey::boolQuestion ( const QString &  line)
protectedvirtual

Called for every boolean question GnuPG answers.

Parameters
linethe question GnuPG asked
Returns
what to answer GnuPG

This is called instead of nextLine() if the line contains a boolean question. Returning BA_UNKNOWN will cancel the current transaction and will set the transaction result to TS_MSG_SEQUENCE.

The default implementation will answer BA_UNKNOWN to every question.

Reimplemented from KGpgEditKeyTransaction.

Definition at line 55 of file kgpgsignkey.cpp.

bool KGpgSignKey::nextLine ( const QString &  line)
protectedvirtual

handle standard GnuPG prompts

Parameters
linethe line to handle

By default this handles passphrase questions and quits the operation when GnuPG returns to it's command prompt. The "GOOD_PASSPHRASE" line is not handled here. When you inherit this class and need to handle specific line do them first and then call this method at the end of your method to handle all standard things (if you don't want to handle them yourself). Every line sent here by GnuPG not recognised as command handled here will set a sequence error so be sure to handle your stuff first!

Reimplemented from KGpgEditKeyTransaction.

Definition at line 39 of file kgpgsignkey.cpp.

bool KGpgSignKey::passphraseReceived ( )
protectedvirtual

called when GnuPG accepted the passphrase

Returns
if the input channel to GnuPG should be closed
Return values
trueclose the input channel of the GnuPG process
falsekeep the GnuPG input channel open

This allows a transaction to handle passphrase success in a special way. The default implementation will just return true.

Reimplemented from KGpgTransaction.

Definition at line 69 of file kgpgsignkey.cpp.

void KGpgSignKey::replaceCmd ( const QString &  cmd)
protectedvirtual

replaces the command passed to GnuPG

Parameters
cmdnew command to use

Implements KGpgSignTransactionHelper.

Definition at line 82 of file kgpgsignkey.cpp.


The documentation for this class was generated from the following files:
  • kgpgsignkey.h
  • kgpgsignkey.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:42:08 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kgpg

Skip menu "kgpg"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdeutils API Reference

Skip menu "kdeutils API Reference"
  • ark
  • filelight
  • kcalc
  • kcharselect
  • kdf
  • kfloppy
  • kgpg
  • ktimer
  • kwallet
  • sweeper

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal