qt: Undeprecate API that I find useful
[gpgme.git] / lang / qt / src / adduseridjob.h
1 /*
2     adduseridjob.h
3
4     This file is part of qgpgme, the Qt API binding for gpgme
5     Copyright (c) 2008 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_ADDUSERIDJOB_H__
36 #define __KLEO_ADDUSERIDJOB_H__
37
38 #include "job.h"
39
40 #include <QtCore/QString>
41
42 namespace GpgME
43 {
44 class Error;
45 class Key;
46 }
47
48 namespace QGpgME
49 {
50
51 /**
52    @short An abstract base class to asynchronously add UIDs to OpenPGP keys
53
54    To use a AddUserIDJob, first obtain an instance from the
55    CryptoBackend implementation, connect the progress() and result()
56    signals to suitable slots and then start the job with a call
57    to start(). This call might fail, in which case the AddUserIDJob
58    instance will have scheduled it's own destruction with a call to
59    QObject::deleteLater().
60
61    After result() is emitted, the AddUserIDJob will schedule it's own
62    destruction by calling QObject::deleteLater().
63 */
64 class QGPGME_EXPORT AddUserIDJob : public Job
65 {
66     Q_OBJECT
67 protected:
68     explicit AddUserIDJob(QObject *parent);
69 public:
70     ~AddUserIDJob();
71
72     /**
73        Starts the operation. \a key is the key to add the UID to. \a
74        name, \a email and \a comment are the components of the user id.
75     */
76     virtual GpgME::Error start(const GpgME::Key &key, const QString &name,
77                                const QString &email, const QString &comment = QString()) = 0;
78
79 Q_SIGNALS:
80     void result(const GpgME::Error &result, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
81 };
82
83 }
84
85 #endif // __KLEO_ADDUSERIDJOB_H__