gpgme/lang/qt/src/adduseridjob.h
Andre Heinecke 20b02a7dd4 Qt: Fix library name in Copyright headers
--
Files are not part of libkleopatra anymore.
2016-05-06 14:20:45 +02:00

85 lines
2.9 KiB
C++

/*
adduseridjob.h
This file is part of qgpgme, the Qt API binding for gpgme
Copyright (c) 2008 Klarälvdalens Datakonsult AB
Copyright (c) 2016 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_ADDUSERIDJOB_H__
#define __KLEO_ADDUSERIDJOB_H__
#include "job.h"
#include <QtCore/QString>
namespace GpgME
{
class Error;
class Key;
}
namespace QGpgME
{
/**
@short An abstract base class to asynchronously add UIDs to OpenPGP keys
To use a AddUserIDJob, first obtain an instance from the
CryptoBackend implementation, connect the progress() and result()
signals to suitable slots and then start the job with a call
to start(). This call might fail, in which case the AddUserIDJob
instance will have scheduled it's own destruction with a call to
QObject::deleteLater().
After result() is emitted, the AddUserIDJob will schedule it's own
destruction by calling QObject::deleteLater().
*/
class QGPGME_EXPORT AddUserIDJob : public Job
{
Q_OBJECT
protected:
explicit AddUserIDJob(QObject *parent);
public:
~AddUserIDJob();
/**
Starts the operation. \a key is the key to add the UID to. \a
name, \a email and \a comment are the components of the user id.
*/
virtual GpgME::Error start(const GpgME::Key &key, const QString &name,
const QString &email, const QString &comment = QString()) = 0;
Q_SIGNALS:
void result(const GpgME::Error &result, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
};
}
#endif // __KLEO_ADDUSERIDJOB_H__