qt: Add generic flag support for keylistjobs
[gpgme.git] / lang / qt / src / keylistjob.h
1 /*
2     keylistjob.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_KEYLISTJOB_H__
35 #define __KLEO_KEYLISTJOB_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 class QStringList;
55
56 namespace QGpgME
57 {
58
59 /**
60    @short An abstract base class for asynchronous key listers
61
62    To use a KeyListJob, first obtain an instance from the
63    CryptoBackend implementation, connect the nextKey(), progress()
64    and result() signals to suitable slots and then start the key
65    listing with a call to start(). This call might fail, in which
66    case the KeylistJob instance will have schedules it's own
67    destruction with a call to QObject::deleteLater().
68
69    During keylisting, you will receive new key objects through the
70    nextKey() signal as they arrive. After result() is emitted, the
71    KeyListJob will schedule it's own destruction by calling
72    QObject::deleteLater().
73 */
74 class QGPGME_EXPORT KeyListJob : public Job
75 {
76     Q_OBJECT
77 protected:
78     explicit KeyListJob(QObject *parent);
79
80 public:
81     ~KeyListJob();
82
83     /**
84       Starts the keylist operation. \a pattern is a list of patterns
85       used to restrict the list of keys returned. Empty patterns are
86       ignored. If \a pattern is empty or contains only empty strings,
87       all keys are returned (however, the backend is free to truncate
88       the result and should do so; when this happens, it will be
89       reported by the reult object).
90
91       If \a secretOnly is true, only keys for which the secret key is
92       also available are returned. Use this if you need to select a
93       key for signing.
94     */
95     virtual GpgME::Error start(const QStringList &patterns, bool secretOnly = false) = 0;
96
97     virtual GpgME::KeyListResult exec(const QStringList &patterns, bool secretOnly, std::vector<GpgME::Key> &keys) = 0;
98
99     /** Add a flag to the keylistmode used. */
100     virtual void addMode(GpgME::KeyListMode mode) = 0;
101
102 Q_SIGNALS:
103     void nextKey(const GpgME::Key &key);
104     void result(const GpgME::KeyListResult &result, const std::vector<GpgME::Key> &keys = std::vector<GpgME::Key>(), const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
105 };
106
107 }
108
109 #endif // __KLEO_KEYLISTJOB_H__