gpgme/lang/qt/src/refreshkeysjob.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

94 lines
3.1 KiB
C++

/*
refreshkeysjob.h
This file is part of qgpgme, the Qt API binding for gpgme
Copyright (c) 2004 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_REFRESHKEYSJOB_H__
#define __KLEO_REFRESHKEYSJOB_H__
#include "job.h"
#include <vector>
namespace GpgME
{
class Error;
class Key;
}
class QStringList;
namespace QGpgME
{
/**
@short An abstract base class for asynchronous key refreshers.
To use a RefreshKeysJob, first obtain an instance from the
CryptoBackend implementation, connect the progress() and result()
signals to suitable slots and then start the key refresh with a
call to start(). This call might fail, in which case the
RefreshKeysJob instance will have scheduled its own destruction
with a call to QObject::deleteLater().
After result() is emitted, the KeyListJob will schedule it's own
destruction by calling QObject::deleteLater().
*/
class RefreshKeysJob : public Job
{
Q_OBJECT
protected:
explicit RefreshKeysJob(QObject *parent);
public:
~RefreshKeysJob();
/**
Starts the keylist operation. \a pattern is a list of patterns
used to restrict the list of keys returned. Empty patterns are
ignored. If \a pattern is empty or contains only empty strings,
all keys are returned (however, the backend is free to truncate
the result and should do so; when this happens, it will be
reported by the reult object).
If \a secretOnly is true, only keys for which the secret key is
also available are returned. Use this if you need to select a
key for signing.
*/
virtual GpgME::Error start(const QStringList &patterns) = 0;
Q_SIGNALS:
void result(const GpgME::Error &error);
};
}
#endif // __KLEO_REFRESHKEYSJOB_H__