Add QGpgME code from libkleo
[gpgme.git] / 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     Libkleopatra 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     Libkleopatra 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
42 #ifdef BUILDING_QGPGME
43 # include "error.h"
44 #else
45 # include <gpgme++/error.h>
46 #endif
47
48 class QWidget;
49
50 namespace QGpgME
51 {
52
53 /**
54    @short An abstract base class for asynchronous crypto operations
55
56    During the operation, you might receive progress updates through
57    the progress() signal as they arrive, but an implementation is
58    free to not send progress information. You should show a busy
59    progressbar until the first progress() signal is received.
60
61    The done() signal is emitted _before_ the result() signals of
62    subclasses and should be used to hide and/or reset progress bars,
63    not to learn of the end of the operation. Use the result()
64    signals for that.
65
66    To cancel the operation, simply call slotCancel(). The result()
67    signal of subclasses will still be emitted, though, and will
68    carry the information that the operation was canceled.
69 */
70 class QGPGME_EXPORT Job : public QObject
71 {
72     Q_OBJECT
73 protected:
74     explicit Job(QObject *parent);
75 public:
76     ~Job();
77
78     virtual void showErrorDialog(QWidget *parent = Q_NULLPTR, const QString &caption = QString()) const;
79
80     virtual QString auditLogAsHtml() const;
81     virtual GpgME::Error auditLogError() const;
82     bool isAuditLogSupported() const;
83
84 public Q_SLOTS:
85     virtual void slotCancel() = 0;
86
87 Q_SIGNALS:
88     void progress(const QString &what, int current, int total);
89     void done();
90 };
91
92 }
93
94 #endif // __KLEO_JOB_H__