lang/qt/src/job.h

   1 /*
   2     job.h
   3
   4     This file is part of qgpgme, the Qt API binding for gpgme
   5     Copyright (c) 2004 Klarälvdalens Datakonsult AB
   6     Copyright (c) 2016 Intevation GmbH
   7
   8     QGpgME is free software; you can redistribute it and/or
   9     modify it under the terms of the GNU General Public License as
  10     published by the Free Software Foundation; either version 2 of the
  11     License, or (at your option) any later version.
  12
  13     QGpgME is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16     General Public License for more details.
  17
  18     You should have received a copy of the GNU General Public License
  19     along with this program; if not, write to the Free Software
  20     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21
  22     In addition, as a special exception, the copyright holders give
  23     permission to link the code of this program with any edition of
  24     the Qt library by Trolltech AS, Norway (or with modified versions
  25     of Qt that use the same license as Qt), and distribute linked
  26     combinations including the two.  You must obey the GNU General
  27     Public License in all respects for all of the code used other than
  28     Qt.  If you modify this file, you may extend this exception to
  29     your version of the file, but you are not obligated to do so.  If
  30     you do not wish to do so, delete this exception statement from
  31     your version.
  32 */
  33
  34 #ifndef __KLEO_JOB_H__
  35 #define __KLEO_JOB_H__
  36
  37 #include "qgpgme_export.h"
  38
  39 #include <QObject>
  40 #include <QString>
  41 #include <QMap>
  42
  43 #ifdef BUILDING_QGPGME
  44 # include "error.h"
  45 #else
  46 # include <gpgme++/error.h>
  47 #endif
  48
  49 class QWidget;
  50
  51 namespace QGpgME
  52 {
  53
  54 /**
  55    @short An abstract base class for asynchronous crypto operations
  56
  57    During the operation, you might receive progress updates through
  58    the progress() signal as they arrive, but an implementation is
  59    free to not send progress information. You should show a busy
  60    progressbar until the first progress() signal is received.
  61
  62    The done() signal is emitted _before_ the result() signals of
  63    subclasses and should be used to hide and/or reset progress bars,
  64    not to learn of the end of the operation. Use the result()
  65    signals for that.
  66
  67    To cancel the operation, simply call slotCancel(). The result()
  68    signal of subclasses will still be emitted, though, and will
  69    carry the information that the operation was canceled.
  70 */
  71 class QGPGME_EXPORT Job : public QObject
  72 {
  73     Q_OBJECT
  74 protected:
  75     explicit Job(QObject *parent);
  76 public:
  77     ~Job();
  78
  79     virtual QString auditLogAsHtml() const;
  80     virtual GpgME::Error auditLogError() const;
  81     bool isAuditLogSupported() const;
  82
  83     /** Get the underlying context to set some additional options for a job.
  84      *
  85      * This is intended to provide more flexibility on configuring jobs before
  86      * they are started.
  87      * The context is still owned by the thread, do not delete it.
  88      *
  89      * This is a static method that takes the job as argument.
  90      *
  91      * This function may not be called for running jobs.
  92      *
  93      * @returns the context used by the job job or null.
  94      */
  95     static GpgME::Context *context(Job *job);
  96
  97 public Q_SLOTS:
  98     virtual void slotCancel() = 0;
  99
 100 Q_SIGNALS:
 101     void progress(const QString &what, int current, int total);
 102     void done();
 103 };
 104
 105 extern QMap <Job *, GpgME::Context *> g_context_map;
 106 }
 107
 108 #endif // __KLEO_JOB_H__