KCompositeJob
#include <KCompositeJob>
Public Member Functions | |
KCompositeJob (QObject *parent=nullptr) | |
~KCompositeJob () override | |
Public Member Functions inherited from KJob | |
KJob (QObject *parent=nullptr) | |
~KJob () override | |
Capabilities | capabilities () const |
qint64 | elapsedTime () const |
int | error () const |
virtual QString | errorString () const |
QString | errorText () const |
bool | exec () |
bool | isAutoDelete () const |
bool | isFinishedNotificationHidden () const |
bool | isStartedWithExec () const |
bool | isSuspended () const |
unsigned long | percent () const |
Q_SCRIPTABLE qulonglong | processedAmount (Unit unit) const |
void | setAutoDelete (bool autodelete) |
void | setFinishedNotificationHidden (bool hide=true) |
void | setUiDelegate (KJobUiDelegate *delegate) |
virtual Q_SCRIPTABLE void | start ()=0 |
Q_SCRIPTABLE qulonglong | totalAmount (Unit unit) const |
KJobUiDelegate * | uiDelegate () const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Protected Slots | |
virtual void | slotInfoMessage (KJob *job, const QString &message) |
virtual void | slotResult (KJob *job) |
Protected Member Functions | |
KCOREADDONS_NO_EXPORT | KCompositeJob (KCompositeJobPrivate &dd, QObject *parent) |
virtual bool | addSubjob (KJob *job) |
void | clearSubjobs () |
bool | hasSubjobs () const |
virtual bool | removeSubjob (KJob *job) |
const QList< KJob * > & | subjobs () const |
Protected Member Functions inherited from KJob | |
KCOREADDONS_NO_EXPORT | KJob (KJobPrivate &dd, QObject *parent) |
virtual bool | doKill () |
virtual bool | doResume () |
virtual bool | doSuspend () |
void | emitPercent (qulonglong processedAmount, qulonglong totalAmount) |
void | emitResult () |
void | emitSpeed (unsigned long speed) |
bool | isFinished () const |
void | setCapabilities (Capabilities capabilities) |
void | setError (int errorCode) |
void | setErrorText (const QString &errorText) |
void | setPercent (unsigned long percentage) |
void | setProcessedAmount (Unit unit, qulonglong amount) |
void | setProgressUnit (Unit unit) |
void | setTotalAmount (Unit unit, qulonglong amount) |
void | startElapsedTimer () |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Additional Inherited Members | |
Public Types inherited from KJob | |
enum | { NoError = 0 , KilledJobError = 1 , UserDefinedError = 100 } |
typedef QFlags< Capability > | Capabilities |
enum | Capability { NoCapabilities = 0x0000 , Killable = 0x0001 , Suspendable = 0x0002 } |
enum | KillVerbosity { Quietly , EmitResult } |
enum | Unit { Bytes = 0 , Files , Directories , Items , UnitsCount } |
Public Types inherited from QObject | |
typedef | QObjectList |
Properties inherited from KJob | |
Capabilities | capabilities |
int | error |
QString | errorString |
QString | errorText |
ulong | percent |
Properties inherited from QObject | |
objectName | |
Signals inherited from KJob | |
void | description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >()) |
void | finished (KJob *job) |
void | infoMessage (KJob *job, const QString &message) |
void | percentChanged (KJob *job, unsigned long percent) |
void | processedAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount) |
void | processedSize (KJob *job, qulonglong size) |
void | result (KJob *job) |
void | resumed (KJob *job) |
void | speed (KJob *job, unsigned long speed) |
void | suspended (KJob *job) |
void | totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount) |
void | totalSize (KJob *job, qulonglong size) |
void | warning (KJob *job, const QString &message) |
Public Slots inherited from KJob | |
bool | kill (KJob::KillVerbosity verbosity=KJob::Quietly) |
bool | resume () |
bool | suspend () |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Protected Attributes inherited from KJob | |
std::unique_ptr< KJobPrivate > const | d_ptr |
Detailed Description
The base class for all jobs able to be composed of one or more subjobs.
Definition at line 24 of file kcompositejob.h.
Constructor & Destructor Documentation
◆ KCompositeJob() [1/2]
|
explicit |
Creates a new KCompositeJob object.
- Parameters
-
parent the parent QObject
Definition at line 20 of file kcompositejob.cpp.
◆ ~KCompositeJob()
|
override |
Destroys a KCompositeJob object.
Definition at line 30 of file kcompositejob.cpp.
◆ KCompositeJob() [2/2]
|
protected |
Definition at line 25 of file kcompositejob.cpp.
Member Function Documentation
◆ addSubjob()
|
protectedvirtual |
Add a job that has to be finished before a result is emitted.
This has obviously to be called before the result has been emitted by the job.
Note that the composite job takes ownership of job
- Parameters
-
job the subjob to add
- Returns
- true if the job has been added correctly, false otherwise
Reimplemented in Akonadi::Job, Akonadi::TransactionSequence, KIO::Job, and MessageComposer::ContentJobBase.
Definition at line 34 of file kcompositejob.cpp.
◆ clearSubjobs()
|
protected |
Clears the list of subjobs.
Note that this will not delete the subjobs. Ownership of the subjobs is passed on to the caller.
Definition at line 74 of file kcompositejob.cpp.
◆ hasSubjobs()
|
protected |
Checks if this job has subjobs running.
- Returns
- true if we still have subjobs running, false otherwise
Definition at line 64 of file kcompositejob.cpp.
◆ removeSubjob()
|
protectedvirtual |
Mark a sub job as being done.
The ownership of job
is passed on to the caller.
- Parameters
-
job the subjob to remove
- Returns
- true if the job has been removed correctly, false otherwise
Reimplemented in Akonadi::Job, and KIO::Job.
Definition at line 51 of file kcompositejob.cpp.
◆ slotInfoMessage
Forward signal from subjob.
- Parameters
-
job the subjob message the info message
- See also
- infoMessage()
Definition at line 100 of file kcompositejob.cpp.
◆ slotResult
|
protectedvirtualslot |
Called whenever a subjob finishes.
Default implementation checks for errors and propagates to parent job, and in all cases it calls removeSubjob.
- Parameters
-
job the subjob
Definition at line 85 of file kcompositejob.cpp.
◆ subjobs()
Retrieves the list of the subjobs.
- Returns
- the full list of sub jobs
Definition at line 69 of file kcompositejob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:04:24 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.