blob: 10cdd6899c1dc99930eaba8314d93f13425383c1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/****************************************************************************
** Copyright (C) 2001-2010 Klaralvdalens Datakonsult AB. All rights reserved.
**
** This file is part of the KD Tools library.
**
** Licensees holding valid commercial KD Tools licenses may use this file in
** accordance with the KD Tools Commercial License Agreement provided with
** the Software.
**
**
** This file may be distributed and/or modified under the terms of the
** GNU Lesser General Public License version 2 and version 3 as published by the
** Free Software Foundation and appearing in the file LICENSE.LGPL included.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** Contact info@kdab.com if any conditions of this licensing are not
** clear to you.
**
**********************************************************************/
#ifndef __KDTOOLS_CORE_KDJOB_H__
#define __KDTOOLS_CORE_KDJOB_H__
#include <QObject>
#include <KDToolsCore/pimpl_ptr.h>
class KDTOOLSCORE_EXPORT KDJob : public QObject {
Q_OBJECT
Q_PROPERTY( bool autoDelete READ autoDelete WRITE setAutoDelete )
public:
explicit KDJob( QObject* parent=0 );
~KDJob();
enum Error {
NoError=0,
Canceled=1,
UserDefinedError=128
};
enum Capability {
NoCapabilities=0x0,
Cancelable=0x1
};
Q_DECLARE_FLAGS(Capabilities, Capability)
int error() const;
QString errorString() const;
bool autoDelete() const;
void setAutoDelete( bool autoDelete );
Capabilities capabilities() const;
bool hasCapability( Capability c ) const;
void waitForStarted();
void waitForFinished();
quint64 totalAmount() const;
quint64 processedAmount() const;
public Q_SLOTS:
void start();
void cancel();
Q_SIGNALS:
void infoMessage( KDJob*, const QString& );
Q_SIGNALS:
#ifndef Q_MOC_RUN
private: // make signals private unless moc runs
#endif
void started( KDJob* );
void finished( KDJob* );
void progress( KDJob* job, quint64 processed, quint64 total );
protected:
virtual void doStart() = 0;
virtual void doCancel();
void setCapabilities( Capabilities c );
void setTotalAmount( quint64 amount );
void setProcessedAmount( quint64 amount );
void setError( int error );
void setErrorString( const QString& errorString );
void emitFinished();
void emitFinishedWithError( int error, const QString& errorString );
private:
class Private;
friend class ::KDJob::Private;
kdtools::pimpl_ptr<Private> d;
Q_PRIVATE_SLOT( d, void delayedStart() )
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KDJob::Capabilities)
#endif // __KDTOOLS_CORE_KDJOB_H__
|