KCompositeJob Class Reference

#include <kcompositejob.h>

Inheritance diagram for KCompositeJob:

Public Member Functions
	KCompositeJob (QObject *parent=0)
virtual	~KCompositeJob ()
Public Member Functions inherited from KJob
	KJob (QObject *parent=0)
virtual	~KJob ()
Capabilities	capabilities () const
int	error () const
virtual QString	errorString () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isSuspended () const
unsigned long	percent () const
qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setUiDelegate (KJobUiDelegate *delegate)
virtual void	start ()=0
qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () const

Protected Slots
virtual void	slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
virtual void	slotResult (KJob *job)

Protected Member Functions
	KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
virtual bool	addSubjob (KJob *job)
void	clearSubjobs ()
bool	hasSubjobs ()
virtual bool	removeSubjob (KJob *job)
const QList< KJob * > &	subjobs () const
Protected Member Functions inherited from KJob
	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)
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	setTotalAmount (Unit unit, qulonglong amount)

Additional Inherited Members
Public Types inherited from KJob
enum	{ NoError = 0, KilledJobError = 1, UserDefinedError = 100 }
enum	Capability { NoCapabilities = 0x0000, Killable = 0x0001, Suspendable = 0x0002 }
enum	KillVerbosity { Quietly, EmitResult }
enum	Unit { Bytes, Files, Directories }
Public Slots inherited from KJob
bool	kill (KillVerbosity verbosity=Quietly)
bool	resume ()
bool	suspend ()
Signals inherited from KJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=qMakePair(QString(), QString()), const QPair< QString, QString > &field2=qMakePair(QString(), QString()))
void	finished (KJob *job)
void	infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
void	percent (KJob *job, unsigned long percent)
void	processedAmount (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	totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
void	totalSize (KJob *job, qulonglong size)
void	warning (KJob *job, const QString &plain, const QString &rich=QString())
Protected Attributes inherited from KJob
KJobPrivate *const	d_ptr

Detailed Description

The base class for all jobs able to be composed of one or more subjobs.

Definition at line 33 of file kcompositejob.h.

Constructor & Destructor Documentation

KCompositeJob::KCompositeJob ( QObject *  parent = 0 )

explicit

Creates a new KCompositeJob object.

Parameters

parent

the parent QObject

Definition at line 31 of file kcompositejob.cpp.

KCompositeJob::~KCompositeJob ( )

virtual

Destroys a KCompositeJob object.

Definition at line 41 of file kcompositejob.cpp.

KCompositeJob::KCompositeJob ( KCompositeJobPrivate &  dd, QObject *  parent  )

protected

Definition at line 36 of file kcompositejob.cpp.

Member Function Documentation

bool KCompositeJob::addSubjob ( KJob *  job )

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

Definition at line 45 of file kcompositejob.cpp.

void KCompositeJob::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 90 of file kcompositejob.cpp.

bool KCompositeJob::hasSubjobs ( )

protected

Checks if this job has subjobs running.

Returns

true if we still have subjobs running, false otherwise

Definition at line 80 of file kcompositejob.cpp.

bool KCompositeJob::removeSubjob ( KJob *  job )

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

Definition at line 65 of file kcompositejob.cpp.

void KCompositeJob::slotInfoMessage ( KJob *  job, const QString &  plain, const QString &  rich  )

protectedvirtualslot

Forward signal from subjob.

Parameters

job	the subjob
plain	the info message in plain text version
rich	the info message in rich text version

See also

infoMessage()

Definition at line 113 of file kcompositejob.cpp.

void KCompositeJob::slotResult ( KJob *  job )

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 99 of file kcompositejob.cpp.

const QList< KJob * > & KCompositeJob::subjobs ( ) const

protected

Retrieves the list of the subjobs.

Returns

the full list of sub jobs

Definition at line 85 of file kcompositejob.cpp.

---

The documentation for this class was generated from the following files:

• kcompositejob.h
• kcompositejob.cpp