• 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
KGpgKeyserverTransaction Class Reference

#include <kgpgkeyservertransaction.h>

Inheritance diagram for KGpgKeyserverTransaction:
Inheritance graph
[legend]

Public Member Functions

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

 KGpgKeyserverTransaction (QObject *parent, const QString &keyserver, const bool withProgress=false, const QString &proxy=QString())
 
virtual void finish ()
 
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 nextLine (const QString &line)=0
 
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
}
 
- Signals inherited from KGpgTransaction
void done (int result)
 
void infoProgress (qulonglong processedAmount, qulonglong totalAmount)
 
void statusMessage (const QString &msg)
 

Detailed Description

base class for transactions involving key servers

Definition at line 27 of file kgpgkeyservertransaction.h.

Constructor & Destructor Documentation

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

construct a new transaction for the given keyserver

Parameters
parentobject that owns the transaction
keyserverkeyserver to work with
withProgressshow a progress window with cancel button
proxyhttp proxy to use

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

If the progress window is enabled and parent is an QWidget it is set as the parent of the progress window.

Definition at line 21 of file kgpgkeyservertransaction.cpp.

KGpgKeyserverTransaction::~KGpgKeyserverTransaction ( )
virtual

Definition at line 39 of file kgpgkeyservertransaction.cpp.

Member Function Documentation

void KGpgKeyserverTransaction::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.

Reimplemented in KGpgKeyserverSearchTransaction.

Definition at line 61 of file kgpgkeyservertransaction.cpp.

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

Reimplemented in KGpgSendKeys, KGpgKeyserverSearchTransaction, and KGpgKeyserverGetTransaction.

Definition at line 68 of file kgpgkeyservertransaction.cpp.

void KGpgKeyserverTransaction::setKeyserver ( const QString &  server)

set the keyserver

Parameters
serverkeyserver to work with

Definition at line 45 of file kgpgkeyservertransaction.cpp.

void KGpgKeyserverTransaction::setProgressEnable ( const bool  b)

activate the progress window

Parameters
bnew activation status

Definition at line 87 of file kgpgkeyservertransaction.cpp.

void KGpgKeyserverTransaction::setProxy ( const QString &  proxy)

set the http proxy

Parameters
proxyhttp proxy to use

If the server is set to an empty value no proxy is used.

Definition at line 53 of file kgpgkeyservertransaction.cpp.


The documentation for this class was generated from the following files:
  • kgpgkeyservertransaction.h
  • kgpgkeyservertransaction.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:07:52 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
  • kremotecontrol
  • ktimer
  • kwallet
  • superkaramba
  • 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