qt, cpp: Enable dll build for windows
[gpgme.git] / lang / qt / src / multideletejob.h
1 /*
2     multideletejob.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_MULTIDELETEJOB_H__
35 #define __KLEO_MULTIDELETEJOB_H__
36
37 #include "qgpgme_export.h"
38 #include "job.h"
39 #include "protocol.h"
40
41 #include <QPointer>
42
43 #include <vector>
44
45 namespace GpgME
46 {
47 class Error;
48 class Key;
49 }
50
51 namespace QGpgME
52 {
53 class DeleteJob;
54 }
55
56 namespace QGpgME
57 {
58
59 /**
60    @short A convenience class bundling together multiple DeleteJobs.
61
62    To use a MultiDeleteJob, pass it a CryptoBackend implementation,
63    connect the progress() and result() signals to suitable slots and
64    then start the delete with a call to start(). This call might
65    fail, in which case the MultiDeleteJob instance will have scheduled
66    it's own destruction with a call to QObject::deleteLater().
67
68    After result() is emitted, the MultiDeleteJob will schedule it's own
69    destruction by calling QObject::deleteLater().
70 */
71 class QGPGME_EXPORT MultiDeleteJob : public Job
72 {
73     Q_OBJECT
74 public:
75     explicit MultiDeleteJob(const Protocol *protocol);
76     ~MultiDeleteJob();
77
78     /**
79        Starts the delete operation. \a keys is the list of keys to
80        delete, \a allowSecretKeyDeletion specifies if a key may also
81        be deleted if the secret key part is available, too.
82     */
83     GpgME::Error start(const std::vector<GpgME::Key> &keys, bool allowSecretKeyDeletion = false);
84
85     /* from Job */
86     void slotCancel() Q_DECL_OVERRIDE;
87
88 Q_SIGNALS:
89     void result(const GpgME::Error &result, const GpgME::Key &errorKey);
90
91 private Q_SLOTS:
92     void slotResult(const GpgME::Error &);
93
94 private:
95     GpgME::Error startAJob();
96
97 private:
98     const Protocol *mProtocol;
99     QPointer<DeleteJob> mJob;
100     std::vector<GpgME::Key> mKeys;
101     std::vector<GpgME::Key>::const_iterator mIt;
102     bool mAllowSecretKeyDeletion;
103 };
104
105 }
106
107 #endif // __KLEO_MULTIDELETEJOB_H__