Add QGpgME code from libkleo
[gpgme.git] / lang / qt / src / specialjob.h
1 /*
2     specialjob.h
3
4     This file is part of qgpgme, the Qt API binding for gpgme
5     Copyright (c) 2004 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_SPECIALJOB_H__
35 #define __KLEO_SPECIALJOB_H__
36
37 #include "job.h"
38
39 namespace GpgME
40 {
41 class Error;
42 }
43
44 namespace QGpgME
45 {
46
47 /**
48    @short An abstract base class for protocol-specific jobs
49
50    To use a SpecialJob, first obtain an instance from the
51    CryptoBackend implementation, connect progress() and result()
52    signals to suitable slots and then start the job with a call to
53    start(). This call might fail, in which case the SpecialJob
54    instance will have schedules its own destruction with a call to
55    QObject::deleteLater().
56
57    After result() is emitted, the SpecialJob will schedule its own
58    destruction by calling QObject::deleteLater().
59
60    Parameters are set using the Qt property system. More general, or
61    constructor parameters are given in the call to
62    QGpgME::Protocol::specialJob().
63
64    The result is made available through the result signal, and
65    through the read-only result property, the latter of which needs
66    to be defined in each SpecialJob subclass.
67 */
68 class SpecialJob : public Job
69 {
70     Q_OBJECT
71 protected:
72     explicit SpecialJob(QObject *parent);
73
74 public:
75     ~SpecialJob();
76
77     /**
78        Starts the special operation.
79     */
80     virtual GpgME::Error start() = 0;
81
82     virtual GpgME::Error exec() = 0;
83
84 Q_SIGNALS:
85     void result(const GpgME::Error &result, const QVariant &data);
86 };
87
88 }
89
90 #endif // __KLEO_SPECIALJOB_H__