4c1ee981d8d2f52a1f17ecf4e16617b3f1c0d46f
[gpgme.git] / lang / qt / src / downloadjob.h
1 /*
2     downloadjob.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_DOWNLOADJOB_H__
35 #define __KLEO_DOWNLOADJOB_H__
36
37 #include "job.h"
38
39 #include <QtCore/QByteArray>
40
41 namespace GpgME
42 {
43 class Error;
44 }
45
46 namespace boost
47 {
48 template <typename T> class shared_ptr;
49 }
50
51 class QStringList;
52 class QIODevice;
53 class QByteArray;
54
55 namespace QGpgME
56 {
57
58 /**
59    @short An abstract base class for asynchronous downloaders
60
61    To use a DownloadJob, first obtain an instance from the
62    CryptoBackend implementation, connect the progress() and result()
63    signals to suitable slots and then start the download with a call
64    to start(). This call might fail, in which case the DownloadJob
65    instance will have scheduled it's own destruction with a call to
66    QObject::deleteLater().
67
68    After result() is emitted, the DownloadJob will schedule it's own
69    destruction by calling QObject::deleteLater().
70 */
71 class QGPGME_EXPORT DownloadJob : public Job
72 {
73     Q_OBJECT
74 protected:
75     explicit DownloadJob(QObject *parent);
76 public:
77     ~DownloadJob();
78
79     /**
80        Starts the download operation. \a fingerprint is the
81        fingerprint of the key to download. If \a fingerprint is empty,
82        contains only whitespace or anything other than a fingerprint,
83        the result is undefined.
84
85        Output is written to \a keyData, if given. Otherwise, it is
86        passed as the second argument of result().
87     */
88     virtual GpgME::Error start(const QByteArray &fingerprint,
89                                const boost::shared_ptr<QIODevice> &keyData) = 0;
90
91     /**
92        Starts the download operation. \a fingerprints is a list of
93        fingerprints used to specify the list of keys downloaded. Empty
94        patterns are ignored. If \a fingerprints is empty, contains
95        only empty strings or anything other than fingerprints, the
96        result is undefined.
97     */
98     virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start(const QStringList &fingerprints) = 0;
99
100 Q_SIGNALS:
101     void result(const GpgME::Error &result, const QByteArray &keyData, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
102 };
103
104 }
105
106 #endif // __KLEO_DOWNLOADJOB_H__