qt: Undeprecate API that I find useful
[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 by Bundesamt für Sicherheit in der Informationstechnik
7     Software engineering by Intevation GmbH
8
9     QGpgME is free software; you can redistribute it and/or
10     modify it under the terms of the GNU General Public License as
11     published by the Free Software Foundation; either version 2 of the
12     License, or (at your option) any later version.
13
14     QGpgME is distributed in the hope that it will be useful,
15     but WITHOUT ANY WARRANTY; without even the implied warranty of
16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17     General Public License for more details.
18
19     You should have received a copy of the GNU General Public License
20     along with this program; if not, write to the Free Software
21     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22
23     In addition, as a special exception, the copyright holders give
24     permission to link the code of this program with any edition of
25     the Qt library by Trolltech AS, Norway (or with modified versions
26     of Qt that use the same license as Qt), and distribute linked
27     combinations including the two.  You must obey the GNU General
28     Public License in all respects for all of the code used other than
29     Qt.  If you modify this file, you may extend this exception to
30     your version of the file, but you are not obligated to do so.  If
31     you do not wish to do so, delete this exception statement from
32     your version.
33 */
34
35 #ifndef __KLEO_DOWNLOADJOB_H__
36 #define __KLEO_DOWNLOADJOB_H__
37
38 #include "job.h"
39
40 #include <QtCore/QByteArray>
41
42 #include <memory>
43
44 namespace GpgME
45 {
46 class Error;
47 }
48
49 class QStringList;
50 class QIODevice;
51 class QByteArray;
52
53 namespace QGpgME
54 {
55
56 /**
57    @short An abstract base class for asynchronous downloaders
58
59    To use a DownloadJob, first obtain an instance from the
60    CryptoBackend implementation, connect the progress() and result()
61    signals to suitable slots and then start the download with a call
62    to start(). This call might fail, in which case the DownloadJob
63    instance will have scheduled it's own destruction with a call to
64    QObject::deleteLater().
65
66    After result() is emitted, the DownloadJob will schedule it's own
67    destruction by calling QObject::deleteLater().
68 */
69 class QGPGME_EXPORT DownloadJob : public Job
70 {
71     Q_OBJECT
72 protected:
73     explicit DownloadJob(QObject *parent);
74 public:
75     ~DownloadJob();
76
77     /**
78        Starts the download operation. \a fingerprint is the
79        fingerprint of the key to download. If \a fingerprint is empty,
80        contains only whitespace or anything other than a fingerprint,
81        the result is undefined.
82
83        Output is written to \a keyData, if given. Otherwise, it is
84        passed as the second argument of result().
85     */
86     virtual GpgME::Error start(const QByteArray &fingerprint,
87                                const std::shared_ptr<QIODevice> &keyData) = 0;
88
89     /**
90        Starts the download operation. \a fingerprints is a list of
91        fingerprints used to specify the list of keys downloaded. Empty
92        patterns are ignored. If \a fingerprints is empty, contains
93        only empty strings or anything other than fingerprints, the
94        result is undefined.
95     */
96     virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start(const QStringList &fingerprints) = 0;
97
98 Q_SIGNALS:
99     void result(const GpgME::Error &result, const QByteArray &keyData, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
100 };
101
102 }
103
104 #endif // __KLEO_DOWNLOADJOB_H__