qt: Add missing header redirection
[gpgme.git] / lang / qt / src / keyformailboxjob.h
1 /*
2     keyformailboxjob.h
3
4     This file is part of qgpgme, the Qt API binding for gpgme
5     Copyright (c) 2016 Intevation GmbH
6
7     QGpgME is free software; you can redistribute it and/or
8     modify it under the terms of the GNU General Public License as
9     published by the Free Software Foundation; either version 2 of the
10     License, or (at your option) any later version.
11
12     QGpgME is distributed in the hope that it will be useful,
13     but WITHOUT ANY WARRANTY; without even the implied warranty of
14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15     General Public License for more details.
16
17     You should have received a copy of the GNU General Public License
18     along with this program; if not, write to the Free Software
19     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
20
21     In addition, as a special exception, the copyright holders give
22     permission to link the code of this program with any edition of
23     the Qt library by Trolltech AS, Norway (or with modified versions
24     of Qt that use the same license as Qt), and distribute linked
25     combinations including the two.  You must obey the GNU General
26     Public License in all respects for all of the code used other than
27     Qt.  If you modify this file, you may extend this exception to
28     your version of the file, but you are not obligated to do so.  If
29     you do not wish to do so, delete this exception statement from
30     your version.
31 */
32 #ifndef __KLEO_KEYFORMAILBOX_H__
33 #define __KLEO_KEYFORMAILBOX_H__
34
35 #include <QString>
36
37 #include "job.h"
38
39 #ifdef BUILDING_QGPGME
40 # include "key.h"
41 #else
42 # include <gpgme++/key.h>
43 #endif
44
45 namespace GpgME
46 {
47 class Error;
48 class KeyListResult;
49 }
50
51 namespace QGpgME
52 {
53
54 /**
55    @short Get the best key to use for a Mailbox
56
57    To use the keyformailboxjob, first obtain an instance from the
58    CryptoBackend and either exec it or start and
59    conncet the result() signals to a suitable slot.
60    The job will be automatically deleted in which
61    case the KeylistJob instance will have schedules it's own
62    destruction with a call to QObject::deleteLater().
63
64    The best key is defined as the key with a UID that has an
65    E-Mail that matches the mailbox provided. If multiple
66    keys are found the one with the highest validity is returned.
67
68    After result() is emitted, the
69    KeyListJob will schedule it's own destruction by calling
70    QObject::deleteLater().
71 */
72 class QGPGME_EXPORT KeyForMailboxJob: public Job
73 {
74     Q_OBJECT
75 protected:
76     explicit KeyForMailboxJob(QObject *parent);
77
78 public:
79     ~KeyForMailboxJob();
80
81     /**
82       Starts the operation. \a mailbox is the mailbox to
83       look for.
84
85       The result is the same as for the LocateKeysJob.
86
87       If \a canEncrypt is true, only keys that have a subkey for encryption
88       usage are returned. Use this if you need to select a
89       key for signing.
90     */
91     virtual GpgME::Error start(const QString &mailbox, bool canEncrypt = true) = 0;
92
93     virtual GpgME::KeyListResult exec(const QString &mailbox, bool canEncrypt, GpgME::Key &key, GpgME::UserID &uid) = 0;
94
95 Q_SIGNALS:
96     /** The result. \a Key is the key found or a Null key.
97      *
98      * The userid is the uid where the mailbox matches.
99      *
100      * The auditlog params are always null / empty.
101      */
102     void result(const GpgME::KeyListResult &result, const GpgME::Key &key, const GpgME::UserID &uid, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
103 };
104
105 }
106 #endif