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