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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
This file is part of the KDE project
SPDX-FileCopyrightText: 2006 Kevin Ottens <ervin@kde.org>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KCOMPOUNDJOB_H
#define KCOMPOUNDJOB_H
#include <util/utilexport.h>
#include <KJob>
#include <QList>
namespace KDevCoreAddons
{
class KCompoundJobPrivate;
/**
* @class KCompoundJob kcompoundjob.h KCompoundJob
*
* The base class for all jobs able to be composed of one
* or more subjobs.
*/
class KDEVPLATFORMUTIL_EXPORT KCompoundJob : public KJob
{
Q_OBJECT
public:
/**
* Creates a new KCompoundJob object.
*
* @param parent the parent QObject
*/
explicit KCompoundJob(QObject *parent = nullptr);
/**
* Destroys a KCompoundJob object.
*/
~KCompoundJob() override;
protected:
/**
* Add a job that has to be finished before a result
* is emitted. This has obviously to be called before
* the finished() signal has been emitted by the job.
*
* Note that the compound job takes ownership of @p job
*
* @param job the subjob to add
* @return true if the job has been added correctly, false otherwise
*/
virtual bool addSubjob(KJob *job);
/**
* Mark a sub job as being done.
*
* The ownership of @p job is passed on to the caller.
*
* @param job the subjob to remove
* @return true if the job has been removed correctly, false otherwise
*/
virtual bool removeSubjob(KJob *job);
/**
* Checks if this job has subjobs running.
*
* @return true if we still have subjobs running, false otherwise
*/
bool hasSubjobs() const;
/**
* Retrieves the list of the subjobs.
*
* @return the full list of sub jobs
*/
const QList<KJob *> &subjobs() const;
/**
* Clears the list of subjobs.
*
* Note that this will *not* delete the subjobs.
* Ownership of the subjobs is passed on to the caller.
*/
virtual void clearSubjobs();
protected Q_SLOTS:
/**
* Called whenever a subjob finishes.
* Default implementation checks for errors and propagates
* to parent job, and in all cases it calls removeSubjob.
*
* @param job the subjob
*/
virtual void subjobFinished(KJob *job);
/**
* Forward signal from subjob.
*
* @param job the subjob
* @param message the info message
* @see infoMessage()
*/
virtual void subjobInfoMessage(KJob *job, const QString &message);
protected:
std::unique_ptr<KCompoundJobPrivate> const d_ptr;
KCompoundJob(KCompoundJobPrivate &dd, QObject *parent);
private:
Q_DECLARE_PRIVATE(KCompoundJob)
};
} // namespace KDevCoreAddons
#endif
|
