qt: Fix filename handling in cryptoconfig
[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 by Bundesamt für Sicherheit in der Informationstechnik
6     Software engineering by 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 #ifndef __KLEO_KEYFORMAILBOX_H__
34 #define __KLEO_KEYFORMAILBOX_H__
35
36 #include <QString>
37
38 #include "job.h"
39
40 #ifdef BUILDING_QGPGME
41 # include "key.h"
42 #else
43 # include <gpgme++/key.h>
44 #endif
45
46 namespace GpgME
47 {
48 class Error;
49 class KeyListResult;
50 }
51
52 namespace QGpgME
53 {
54
55 /**
56    @short Get the best key to use for a Mailbox
57
58    To use the keyformailboxjob, first obtain an instance from the
59    CryptoBackend and either exec it or start and
60    conncet the result() signals to a suitable slot.
61    The job will be automatically deleted in which
62    case the KeylistJob instance will have schedules it's own
63    destruction with a call to QObject::deleteLater().
64
65    The best key is defined as the key with a UID that has an
66    E-Mail that matches the mailbox provided. If multiple
67    keys are found the one with the highest validity is returned.
68
69    After result() is emitted, the
70    KeyListJob will schedule it's own destruction by calling
71    QObject::deleteLater().
72 */
73 class QGPGME_EXPORT KeyForMailboxJob: public Job
74 {
75     Q_OBJECT
76 protected:
77     explicit KeyForMailboxJob(QObject *parent);
78
79 public:
80     ~KeyForMailboxJob();
81
82     /**
83       Starts the operation. \a mailbox is the mailbox to
84       look for.
85
86       The result is the same as for the LocateKeysJob.
87
88       If \a canEncrypt is true, only keys that have a subkey for encryption
89       usage are returned. Use this if you need to select a
90       key for signing.
91     */
92     virtual GpgME::Error start(const QString &mailbox, bool canEncrypt = true) = 0;
93
94     virtual GpgME::KeyListResult exec(const QString &mailbox, bool canEncrypt, GpgME::Key &key, GpgME::UserID &uid) = 0;
95
96 Q_SIGNALS:
97     /** The result. \a Key is the key found or a Null key.
98      *
99      * The userid is the uid where the mailbox matches.
100      *
101      * The auditlog params are always null / empty.
102      */
103     void result(const GpgME::KeyListResult &result, const GpgME::Key &key, const GpgME::UserID &uid, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
104 };
105
106 }
107 #endif