Cpp / Qt: Reduce boost usage (memory and tuple)
[gpgme.git] / lang / qt / src / deletejob.h
1 /*
2     deletejob.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_DELETEJOB_H__
35 #define __KLEO_DELETEJOB_H__
36
37 #include "job.h"
38
39 namespace GpgME
40 {
41 class Error;
42 class Key;
43 }
44
45 namespace QGpgME
46 {
47
48 /**
49    @short An abstract base class for asynchronous deleters
50
51    To use a DeleteJob, first obtain an instance from the
52    CryptoBackend implementation, connect the progress() and result()
53    signals to suitable slots and then start the delete with a call
54    to start(). This call might fail, in which case the DeleteJob
55    instance will have scheduled it's own destruction with a call to
56    QObject::deleteLater().
57
58    After result() is emitted, the DeleteJob will schedule it's own
59    destruction by calling QObject::deleteLater().
60 */
61 class DeleteJob : public Job
62 {
63     Q_OBJECT
64 protected:
65     explicit DeleteJob(QObject *parent);
66 public:
67     ~DeleteJob();
68
69     /**
70        Starts the delete operation. \a key represents the key to
71        delete, \a allowSecretKeyDeletion specifies if a key may also
72        be deleted if the secret key part is available, too.
73     */
74     virtual GpgME::Error start(const GpgME::Key &key, bool allowSecretKeyDeletion = false) = 0;
75
76 Q_SIGNALS:
77     void result(const GpgME::Error &result, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
78 };
79
80 }
81
82 #endif // __KLEO_DELETEJOB_H__