Qt: Add static factor methods for protocol
[gpgme.git] / lang / qt / src / exportjob.h
1 /*
2     exportjob.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 __QGPGME_EXPORTJOB_H__
35 #define __QGPGME_EXPORTJOB_H__
36
37 #include "job.h"
38
39 #include <QtCore/QByteArray>
40
41 namespace GpgME
42 {
43 class Error;
44 }
45
46 class QStringList;
47
48 namespace QGpgME
49 {
50
51 /**
52    @short An abstract base class for asynchronous exporters
53
54    To use a ExportJob, first obtain an instance from the
55    CryptoBackend implementation, connect the progress() and result()
56    signals to suitable slots and then start the export with a call
57    to start(). This call might fail, in which case the ExportJob
58    instance will have scheduled it's own destruction with a call to
59    QObject::deleteLater().
60
61    After result() is emitted, the ExportJob will schedule it's own
62    destruction by calling QObject::deleteLater().
63 */
64 class ExportJob : public Job
65 {
66     Q_OBJECT
67 protected:
68     explicit ExportJob(QObject *parent);
69 public:
70     ~ExportJob();
71
72     /**
73        Starts the export operation. \a patterns is a list of patterns
74        used to restrict the list of keys exported. Empty patterns are
75        ignored. If \a patterns is empty or contains only empty
76        strings, all available keys are exported.
77     */
78     virtual GpgME::Error start(const QStringList &patterns) = 0;
79
80 Q_SIGNALS:
81     void result(const GpgME::Error &result, const QByteArray &keyData, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
82 };
83
84 }
85
86 #endif // __QGPGME_EXPORTJOB_H__