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