Qt: Add static factor methods for protocol
[gpgme.git] / lang / qt / src / decryptjob.h
1 /*
2     decryptjob.h
3
4     This file is part of qgpgme, the Qt API binding for gpgme
5     Copyright (c) 2004, 2007 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_DECRYPTJOB_H__
35 #define __KLEO_DECRYPTJOB_H__
36
37 #include "job.h"
38
39 #include <boost/shared_ptr.hpp>
40
41 class QByteArray;
42 class QIODevice;
43
44 namespace GpgME
45 {
46 class Error;
47 class DecryptionResult;
48 }
49
50 namespace QGpgME
51 {
52
53 /**
54    @short An abstract base class for asynchronous decrypters
55
56    To use a DecryptJob, first obtain an instance from the
57    CryptoBackend implementation, connect the progress() and result()
58    signals to suitable slots and then start the decryption with a
59    call to start(). This call might fail, in which case the
60    DecryptJob instance will have scheduled it's own destruction with
61    a call to QObject::deleteLater().
62
63    After result() is emitted, the DecryptJob will schedule it's own
64    destruction by calling QObject::deleteLater().
65 */
66 class QGPGME_EXPORT DecryptJob : public Job
67 {
68     Q_OBJECT
69 protected:
70     explicit DecryptJob(QObject *parent);
71 public:
72     ~DecryptJob();
73
74     /**
75        Starts the decryption operation. \a cipherText is the data to
76        decrypt.
77     */
78     virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start(const QByteArray &cipherText) = 0;
79
80     /*!
81       \overload
82
83       If \a plainText is non-null, the plaintext is written
84       there. Otherwise, it will be delivered in the second argument
85       of result().
86
87       \throws GpgME::Exception if starting fails
88     */
89     virtual void start(const boost::shared_ptr<QIODevice> &cipherText, const boost::shared_ptr<QIODevice> &plainText = boost::shared_ptr<QIODevice>()) = 0;
90
91     virtual GpgME::DecryptionResult exec(const QByteArray &cipherText,
92                                          QByteArray &plainText) = 0;
93
94 Q_SIGNALS:
95     void result(const GpgME::DecryptionResult &result, const QByteArray &plainText, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
96 };
97
98 }
99
100 #endif // __KLEO_DECRYPTJOB_H__