gpgme/lang/qt/src/job.h
Ingo Klöcker 18c2c0b250
qt: Support deferred start of jobs
* lang/qt/src/job.cpp, lang/qt/src/job.h (Job::startNow): New method.
* lang/qt/src/job_p.h (JobPrivate::start): New pure virtual method.
* lang/qt/src/qgpgmechangeexpiryjob.cpp
(QGpgMEChangeExpiryJobPrivate::start): New.
* lang/qt/src/qgpgmeencryptjob.cpp (QGpgMEEncryptJobPrivate::start):
New.
* lang/qt/src/qgpgmeimportjob.cpp (QGpgMEImportJobPrivate::start): New.
* lang/qt/src/qgpgmelistallkeysjob.cpp
(QGpgMEListAllKeysJobPrivate::start): New.
* lang/qt/src/qgpgmesignencryptjob.cpp
(QGpgMESignEncryptJobPrivate::start): New.
* lang/qt/src/threadedjobmixin.h (Thread::hasFunction): New method.
(ThreadedJobMixin::run, ThreadedJobMixin::setWorkerFunction): New
methods.
--

startNow() starts a deferred job for which the worker function has been
set before.

GnuPG-bug-id: 6323
2023-01-04 12:16:04 +01:00

117 lines
3.7 KiB
C++

/*
job.h
This file is part of qgpgme, the Qt API binding for gpgme
Copyright (c) 2004 Klarälvdalens Datakonsult AB
Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik
Software engineering by Intevation GmbH
QGpgME is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
QGpgME is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
In addition, as a special exception, the copyright holders give
permission to link the code of this program with any edition of
the Qt library by Trolltech AS, Norway (or with modified versions
of Qt that use the same license as Qt), and distribute linked
combinations including the two. You must obey the GNU General
Public License in all respects for all of the code used other than
Qt. If you modify this file, you may extend this exception to
your version of the file, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from
your version.
*/
#ifndef __KLEO_JOB_H__
#define __KLEO_JOB_H__
#include "qgpgme_export.h"
#include <QObject>
#include <QString>
#include <QMap>
#ifdef BUILDING_QGPGME
# include "error.h"
#else
# include <gpgme++/error.h>
#endif
class QWidget;
namespace QGpgME
{
/**
@short An abstract base class for asynchronous crypto operations
During the operation, you might receive progress updates through
the progress() signal as they arrive, but an implementation is
free to not send progress information. You should show a busy
progressbar until the first progress() signal is received.
The done() signal is emitted _before_ the result() signals of
subclasses and should be used to hide and/or reset progress bars,
not to learn of the end of the operation. Use the result()
signals for that.
To cancel the operation, simply call slotCancel(). The result()
signal of subclasses will still be emitted, though, and will
carry the information that the operation was canceled.
*/
class QGPGME_EXPORT Job : public QObject
{
Q_OBJECT
protected:
explicit Job(QObject *parent);
public:
~Job();
virtual QString auditLogAsHtml() const;
virtual GpgME::Error auditLogError() const;
bool isAuditLogSupported() const;
/** Get the underlying context to set some additional options for a job.
*
* This is intended to provide more flexibility on configuring jobs before
* they are started.
* The context is still owned by the thread, do not delete it.
*
* This is a static method that takes the job as argument.
*
* This function may not be called for running jobs.
*
* @returns the context used by the job job or null.
*/
static GpgME::Context *context(Job *job);
/** Starts a deferred job.
*
* The job needs to have been prepared for a deferred start by calling the
* startLater() function instead of the start() function of a leaf class.
*/
void startNow();
public Q_SLOTS:
virtual void slotCancel() = 0;
Q_SIGNALS:
void progress(const QString &what, int current, int total);
void done();
};
extern QMap <Job *, GpgME::Context *> g_context_map;
}
#endif // __KLEO_JOB_H__