qt, cpp: Enable dll build for windows
[gpgme.git] / lang / qt / src / listallkeysjob.h
1 /*
2     listallkeysjob.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_LISTALLKEYSJOB_H__
35 #define __KLEO_LISTALLKEYSJOB_H__
36
37 #include "job.h"
38 #include "qgpgme_export.h"
39
40 #ifdef BUILDING_QGPGME
41 # include "key.h"
42 #else
43 # include <gpgme++/key.h>
44 #endif
45
46 #include <vector>
47
48 namespace GpgME
49 {
50 class Error;
51 class KeyListResult;
52 }
53
54 namespace QGpgME
55 {
56
57 /**
58    @short An abstract base class for asynchronously listing all keys
59
60    To use a ListAllKeysJob, first obtain an instance from the
61    CryptoBackend implementation, connect the progress()
62    and result() signals to suitable slots and then start the key
63    listing with a call to start(). This call might fail, in which
64    case the ListAllKeysJob instance will have schedules it's own
65    destruction with a call to QObject::deleteLater().
66
67    After result() is emitted, the ListAllKeysJob will schedule it's
68    own destruction by calling QObject::deleteLater().
69
70    This is potentially much faster than a KeyListJob with empty
71    pattern.
72 */
73 class QGPGME_EXPORT ListAllKeysJob : public Job
74 {
75     Q_OBJECT
76 protected:
77     explicit ListAllKeysJob(QObject *parent);
78
79 public:
80     ~ListAllKeysJob();
81
82     /**
83       Starts the listallkeys operation.  In general, all keys are
84       returned (however, the backend is free to truncate the result
85       and should do so; when this happens, it will be reported by the
86       result object).
87
88       If \a mergeKeys is true, secret keys are merged into public
89       keys.
90     */
91     virtual GpgME::Error start(bool mergeKeys = false) = 0;
92
93     /**
94        Synchronous version of start().
95     */
96     virtual GpgME::KeyListResult exec(std::vector<GpgME::Key> &pub, std::vector<GpgME::Key> &sec, bool mergeKeys = false) = 0;
97
98 Q_SIGNALS:
99     void result(const GpgME::KeyListResult &result, const std::vector<GpgME::Key> &pub = std::vector<GpgME::Key>(), const std::vector<GpgME::Key> &sec = std::vector<GpgME::Key>(), const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
100 };
101
102 }
103
104 #endif // __KLEO_LISTALLKEYSJOB_H__