• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KIO

  • KIO
  • Job
Signals | Public Member Functions | Protected Member Functions
KIO::Job Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::Job:
KCompositeJob KJob QObject KIO::ChmodJob KIO::CopyJob KIO::DeleteJob KIO::DirectorySizeJob KIO::FileCopyJob KIO::MetaInfoJob KIO::PreviewJob KIO::SimpleJob

List of all members.

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())
- Signals inherited from KJob

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 KJob
qulonglong processedAmount (Unit unit) const
qulonglong totalAmount (Unit unit) 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 KJob
void setProcessedAmount (Unit unit, qulonglong amount)
void setTotalAmount (Unit unit, qulonglong amount)

Additional Inherited Members

- Public Types inherited from KCompositeJob
enum  Capability
enum  KillVerbosity
enum  Unit
- Public Types inherited from KJob
- Public Slots inherited from KCompositeJob
bool kill (KillVerbosity verbosity=Quietly)
bool resume ()
bool suspend ()
- Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=Quietly)
- Public Attributes inherited from KCompositeJob
 Bytes
 Directories
 EmitResult
 Files
 Killable
 KilledJobError
 NoCapabilities
 NoError
 Quietly
 Suspendable
 UserDefinedError
- Public Attributes inherited from KJob
- Protected Slots inherited from KCompositeJob
virtual void slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
virtual void slotResult (KJob *job)
- Protected Attributes inherited from KCompositeJob
KJobPrivate *const d_ptr
- Protected Attributes inherited from KJob

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->ui()->showErrorMessage();
See also:
KIO::Scheduler

Definition at line 94 of file jobclasses.h.


Constructor & Destructor Documentation

Job::Job ( )
protected

Definition at line 75 of file job.cpp.

Job::Job ( JobPrivate &  dd)
protected

Definition at line 80 of file job.cpp.

Job::~Job ( )
virtual

Definition at line 85 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:
keythe key of the meta data
valuethe value of the meta data
See also:
setMetaData()
mergeMetaData()

Definition at line 263 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:
valuesthe meta data to add
See also:
setMetaData()
mergeMetaData()

Definition at line 268 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:
jobthe subjob to add

Reimplemented from KCompositeJob.

Definition at line 94 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:
jobthe 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:
jobthe 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:
reqUrlthe request URL that generated this error message
methodthe 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 174 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 195 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 185 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 ui()->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 229 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:
valuesthe meta data to merge
See also:
setMetaData()
addMetaData()

Definition at line 276 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 247 of file job.cpp.

MetaData Job::outgoingMetaData ( ) const

. For the scheduler. Do not use.

Definition at line 286 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 242 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:
keythe 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 252 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:
jobthe subjob to remove

Reimplemented from KCompositeJob.

Definition at line 117 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:
metaDatathe meta data to set
See also:
addMetaData()
mergeMetaData()

Definition at line 257 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:
parentJobthe new parent job

Definition at line 234 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:
parentthe parent widget for the dialog box, can be 0 for top-level
Deprecated:
you should use job->ui()->setWindow(parent) and job->ui()->showErrorMessage() instead

Definition at line 215 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 89 of file job.cpp.


The documentation for this class was generated from the following files:
  • jobclasses.h
  • global.cpp
  • job.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 16 2013 11:48:02 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal