You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdepim/certmanager/lib/kleo/specialjob.h

88 lines
2.9 KiB

/*
specialjob.h
This file is part of libkleopatra, the KDE keymanagement library
Copyright (c) 2004 Klar<EFBFBD>lvdalens Datakonsult AB
Libkleopatra 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.
Libkleopatra 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 TQt library by Trolltech AS, Norway (or with modified versions
of TQt that use the same license as TQt), 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
TQt. 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_SPECIALJOB_H__
#define __KLEO_SPECIALJOB_H__
#include "job.h"
namespace GpgME {
class Error;
}
namespace Kleo {
/**
@short An abstract base class for protocol-specific jobs
To use a SpecialJob, first obtain an instance from the
CryptoBackend implementation, connect 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 SpecialJob
instance will have schedules its own destruction with a call to
TQObject::deleteLater().
After result() is emitted, the SpecialJob will schedule its own
destruction by calling TQObject::deleteLater().
Parameters are set using the TQt property system. More general, or
constructor parameters are given in the call to
Kleo::CryptoBackend::Protocol::specialJob().
The result is made available through the result signal, and
through the read-only result property, the latter of which needs
to be defined in each SpecialJob subclass.
*/
class SpecialJob : public Job {
TQ_OBJECT
protected:
SpecialJob( TQObject * parent, const char * name );
public:
~SpecialJob();
/**
Starts the special operation.
*/
virtual GpgME::Error start() = 0;
virtual GpgME::Error exec() = 0;
signals:
void result( const GpgME::Error & result, const TQVariant & data );
};
}
#endif // __KLEO_SPECIALJOB_H__