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