KIO::Job Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::Job:

Signals
void	canceled (KJob *job)
void	connected (KIO::Job *job)
Signals inherited from KCompositeJob
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())

Public Member Functions
virtual	~Job ()
void	addMetaData (const QString &key, const QString &value)
void	addMetaData (const QMap< QString, QString > &values)
QStringList	detailedErrorStrings (const KUrl *reqUrl=0L, int method=-1) const
QString	errorString () const
bool	isInteractive () const
void	mergeMetaData (const QMap< QString, QString > &values)
MetaData	metaData () const
MetaData	outgoingMetaData () const
Job *	parentJob () const
QString	queryMetaData (const QString &key)
void	setMetaData (const KIO::MetaData &metaData)
void	setParentJob (Job *parentJob)
void	showErrorDialog (QWidget *parent=0)
void	start ()
JobUiDelegate *	ui () const
Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=0)
virtual	~KCompositeJob ()
virtual	~KJob ()
Capabilities	capabilities () const
int	error () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isSuspended () const
	KJob (QObject *parent=0)
unsigned long	percent () const
qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setUiDelegate (KJobUiDelegate *delegate)
qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
	Job ()
	Job (JobPrivate &dd)
virtual bool	addSubjob (KJob *job)
virtual bool	doKill ()
virtual bool	doResume ()
virtual bool	doSuspend ()
virtual bool	removeSubjob (KJob *job)
Protected Member Functions inherited from KCompositeJob
	KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
void	clearSubjobs ()
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void	emitResult ()
void	emitSpeed (unsigned long speed)
bool	hasSubjobs ()
	KJob (KJobPrivate &dd, QObject *parent)
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)
const QList< KJob * > &	subjobs () const
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from KCompositeJob
enum	Capability
enum	KillVerbosity
enum	Unit
Public Slots inherited from KCompositeJob
bool	kill (KillVerbosity verbosity=Quietly)
bool	resume ()
bool	suspend ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
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)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
virtual void	slotResult (KJob *job)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Protected Attributes inherited from KCompositeJob
KJobPrivate *const	d_ptr
Properties inherited from QObject
	objectName

Detailed Description

The base class for all jobs.

For all jobs created in an application, the code looks like

KIO::Job * job = KIO::someoperation( some parameters );
connect( job, SIGNAL( result( KJob * ) ),
         this, SLOT( slotResult( KJob * ) ) );

(other connects, specific to the job)

And slotResult is usually at least:

if ( job->error() )
    job->uiDelegate()->showErrorMessage();

See also

KIO::Scheduler

Definition at line 94 of file jobclasses.h.

Constructor & Destructor Documentation

Job::Job ( )

protected

Definition at line 76 of file job.cpp.

Job::Job ( JobPrivate &  dd )

protected

Definition at line 81 of file job.cpp.

Job::~Job ( )

virtual

Definition at line 86 of file job.cpp.

Member Function Documentation

void Job::addMetaData	(	const QString &	key,
		const QString &	value
	)

Add key/value pair to the meta data that is sent to the slave.

Parameters

key	the key of the meta data
value	the value of the meta data

See also

setMetaData()

mergeMetaData()

Definition at line 264 of file job.cpp.

void Job::addMetaData

(

const QMap< QString, QString > &

values

)

Add key/value pairs to the meta data that is sent to the slave.

If a certain key already existed, it will be overridden.

Parameters

values

the meta data to add

See also

setMetaData()

mergeMetaData()

Definition at line 269 of file job.cpp.

bool Job::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 finish signal is emitted by the slave.

Parameters

job	the subjob to add

Reimplemented from KCompositeJob.

Definition at line 95 of file job.cpp.

void KIO::Job::canceled ( KJob *  job )

signal

Deprecated:

. Don't use ! Emitted when the job is canceled. Signal result() is emitted as well, and error() is, in this case, ERR_USER_CANCELED.

Parameters

job	the job that emitted this signal

void KIO::Job::connected ( KIO::Job *  job )

signal

Emitted when the slave successfully connected to the host.

There is no guarantee the slave will send this, and this is currently unused (in the applications).

Parameters

job	the job that emitted this signal

QStringList KIO::Job::detailedErrorStrings	(	const KUrl *	reqUrl = 0L,
		int	method = -1
	)		const

Converts an error code and a non-i18n error message into i18n strings suitable for presentation in a detailed error message box.

Parameters

reqUrl	the request URL that generated this error message
method	the method that generated this error message (unimplemented)

Returns

the following strings: caption, error + description, causes+solutions

Definition at line 419 of file global.cpp.

bool Job::doKill ( )

protectedvirtual

Abort this job.

This kills all subjobs and deletes the job.

Reimplemented from KCompositeJob.

Reimplemented in KIO::SimpleJob.

Definition at line 175 of file job.cpp.

bool Job::doResume ( )

protectedvirtual

Resume this job.

See also

suspend

Reimplemented from KCompositeJob.

Reimplemented in KIO::FileCopyJob, KIO::TransferJob, and KIO::SimpleJob.

Definition at line 196 of file job.cpp.

bool Job::doSuspend ( )

protectedvirtual

Suspend this job.

See also

resume

Reimplemented from KCompositeJob.

Reimplemented in KIO::FileCopyJob, KIO::SimpleJob, and KIO::CopyJob.

Definition at line 186 of file job.cpp.

QString KIO::Job::errorString ( ) const

virtual

Converts an error code and a non-i18n error message into an error message in the current language.

The low level (non-i18n) error message (usually a url) is put into the translated error message using %1.

Example for errid == ERR_CANNOT_OPEN_FOR_READING:

i18n( "Could not read\n%1" ).arg( errortext );

Use this to display the error yourself, but for a dialog box use uiDelegate()->showErrorMessage(). Do not call it if error() is not 0.

Returns

the error message and if there is no error, a message telling the user that the app is broken, so check with error() whether there is an error

Reimplemented from KCompositeJob.

Definition at line 159 of file global.cpp.

bool Job::isInteractive

(

)

const

Returns whether the user should be asked about things when the job is unsure, like whether to overwrite existing files etc.

Returns

true if user interactions are enabled (true by default), false if setUiDelegate(0) was called.

See also

setUiDelegate()

Definition at line 230 of file job.cpp.

void Job::mergeMetaData

(

const QMap< QString, QString > &

values

)

Add key/value pairs to the meta data that is sent to the slave.

If a certain key already existed, it will remain unchanged.

Parameters

values

the meta data to merge

See also

setMetaData()

addMetaData()

Definition at line 277 of file job.cpp.

MetaData Job::metaData

(

)

const

Get meta data received from the slave.

(Valid when first data is received and/or slave is finished)

Returns

the job's meta data

Definition at line 248 of file job.cpp.

MetaData Job::outgoingMetaData

(

)

const

. For the scheduler. Do not use.

Definition at line 287 of file job.cpp.

Job * Job::parentJob

(

)

const

Returns the parent job, if there is one.

Returns

the parent job, or 0 if there is none

See also

setParentJob

Definition at line 243 of file job.cpp.

QString Job::queryMetaData

(

const QString &

key

)

Query meta data received from the slave.

(Valid when first data is received and/or slave is finished)

Parameters

key	the key of the meta data to retrieve

Returns

the value of the meta data, or QString() if the key does not exist

Definition at line 253 of file job.cpp.

bool Job::removeSubjob ( KJob *  job )

protectedvirtual

Mark a sub job as being done.

KDE4 change: this doesn't terminate the parent job anymore, call emitResult to do that.

Parameters

job	the subjob to remove

Reimplemented from KCompositeJob.

Definition at line 118 of file job.cpp.

void Job::setMetaData

(

const KIO::MetaData &

metaData

)

Set meta data to be sent to the slave, replacing existing meta data.

Parameters

metaData

the meta data to set

See also

addMetaData()

mergeMetaData()

Definition at line 258 of file job.cpp.

void Job::setParentJob

(

Job *

parentJob

)

Set the parent Job.

One example use of this is when FileCopyJob calls RenameDialog::open, it must pass the correct progress ID of the parent CopyJob (to hide the progress dialog). You can set the parent job only once. By default a job does not have a parent job.

Parameters

parentJob

the new parent job

Definition at line 235 of file job.cpp.

void Job::showErrorDialog

(

QWidget *

parent = 0

)

Display a dialog box to inform the user of the error given by this job.

Only call if error is not 0, and only in the slot connected to result.

Parameters

parent

the parent widget for the dialog box, can be 0 for top-level

Deprecated:

you should use job->uiDelegate()->setWindow(parent) and job->uiDelegate()->showErrorMessage() instead

Definition at line 216 of file job.cpp.

void KIO::Job::start ( )

inlinevirtual

Implements KCompositeJob.

Definition at line 103 of file jobclasses.h.

JobUiDelegate * Job::ui

(

)

const

Retrieves the UI delegate of this job.

This method is basically a convenience for static_cast<KIO::JobUiDelegate*>(uiDelegate()).

Returns

the delegate used by the job to communicate with the UI

Definition at line 90 of file job.cpp.

---

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

• jobclasses.h
• global.cpp
• job.cpp