KIO::Job Class Reference
The base class for all jobs. More...
#include <jobclasses.h>
Inheritance diagram for KIO::Job:

Signals | |
void | result (KIO::Job *job) |
Emitted when the job is finished, in any case (completed, canceled, failed...). | |
void | canceled (KIO::Job *job) |
Emitted when the job is canceled. | |
void | infoMessage (KIO::Job *, const QString &msg) |
Emitted to display information about this job, as sent by the slave. | |
void | connected (KIO::Job *) |
Emitted when the slave successfully connected to the host. | |
void | percent (KIO::Job *job, unsigned long percent) |
Progress signal showing the overall progress of the job This is valid for any kind of job, and allows using a a progress bar very easily. | |
void | totalSize (KIO::Job *, KIO::filesize_t size) |
Emitted when we know the size of this job (data size for transfers, number of entries for listings). | |
void | processedSize (KIO::Job *, KIO::filesize_t size) |
Regularly emitted to show the progress of this job (current data size for transfers, entries listed). | |
void | speed (KIO::Job *, unsigned long bytes_per_second) |
Emitted to display information about the speed of this job. | |
Public Methods | |
virtual void | kill (bool quietly=true) |
Abort this job. | |
int | error () const |
int | progressId () const |
const QString & | errorText () const |
QString | errorString () const |
Converts an error code and a non-i18n error message into an error message in the current language. | |
QStringList | 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. | |
void | showErrorDialog (QWidget *parent=0L) |
Display a dialog box to inform the user of the error given by this job. | |
void | setAutoErrorHandlingEnabled (bool enable, QWidget *parentWidget=0) |
Enable or disable the automatic error handling. | |
bool | isAutoErrorHandlingEnabled () const |
Returns whether automatic error handling is enabled or disabled. | |
void | setWindow (QWidget *window) |
Associate this job with a window given by window . | |
QWidget * | window () const |
Returns the window this job is associated with. | |
void | setParentJob (Job *parentJob) |
Set the parent Job. | |
Job * | parentJob () const |
void | setMetaData (const KIO::MetaData &) |
Set meta data to be sent to the slave. | |
void | addMetaData (const QString &key, const QString &value) |
Add key/value pair to the meta data that is sent to the slave. | |
void | addMetaData (const QMap< QString, QString > &values) |
Add key/value pairs to the meta data that is sent to the slave. | |
void | mergeMetaData (const QMap< QString, QString > &values) |
Add key/value pairs to the meta data that is sent to the slave. | |
MetaData | metaData () const |
Get meta data received from the slave. | |
QString | queryMetaData (const QString &key) |
Query meta data received from the slave. | |
Protected Slots | |
virtual void | slotResult (KIO::Job *job) |
Called whenever a subjob finishes. | |
void | slotSpeed (KIO::Job *, unsigned long bytes_per_second) |
Forward signal from subjob. | |
void | slotInfoMessage (KIO::Job *, const QString &) |
Forward signal from subjob. | |
void | slotSpeedTimeout () |
Remove speed information. | |
Protected Methods | |
virtual void | addSubjob (Job *job, bool inheritMetaData=true) |
Add a job that has to be finished before a result is emitted. | |
virtual void | removeSubjob (Job *job) |
Mark a sub job as being done. | |
void | emitPercent (KIO::filesize_t processedSize, KIO::filesize_t totalSize) |
Utility function for inherited jobs. | |
void | emitSpeed (unsigned long bytes_per_second) |
Utility function for inherited jobs. | |
void | emitResult () |
Utility function to emit the result signal, and suicide this job. |
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( KIO::Job * ) ), this, SLOT( slotResult( KIO::Job * ) ) );(other connects, specific to the job)
And slotResult is usually at least:
if ( job->error() ) job->showErrorDialog( this or 0L );
Definition at line 66 of file jobclasses.h.
Member Function Documentation
|
Abort this job. This kills all subjobs and deletes the job.
Reimplemented in KIO::SimpleJob. Definition at line 187 of file job.cpp. References canceled(), QPtrList< Job >::clear(), QPtrListIterator::current(), emitResult(), Observer::jobFinished(), and Observer::self(). Referenced by KImageFilePreview::clearPreview(), KRun::killJob(), and KIO::ProgressBase::slotStop(). |
|
Definition at line 91 of file jobclasses.h. Referenced by KIO::PreviewJob::slotResult(), KIO::DeleteJob::slotResult(), KIO::FileCopyJob::slotResult(), KIO::TransferJob::slotResult(), slotResult(), and KIO::ChmodJob::slotResult(). |
|
Definition at line 96 of file jobclasses.h. Referenced by Observer::open_RenameDlg(), Observer::open_SkipDlg(), and Observer::slotTransferring(). |
|
Definition at line 104 of file jobclasses.h. Referenced by KIO::FileCopyJob::slotResult(), KIO::TransferJob::slotResult(), slotResult(), and KIO::ChmodJob::slotResult(). |
|
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 Definition at line 173 of file global.cpp. Referenced by showErrorDialog(). |
|
Converts an error code and a non-i18n error message into i18n strings suitable for presentation in a detailed error message box.
Returns strings: caption, error + description, causes+solutions Definition at line 383 of file global.cpp. References QString::arg(), QDateTime::currentDateTime(), KStdAccel::description(), KLocale::formatDateTime(), QString::fromLatin1(), KURL::htmlURL(), QStringList::join(), KGlobal::locale(), and KURL::protocol(). Referenced by showErrorDialog(). |
|
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.
Definition at line 242 of file job.cpp. References KLocale::defaultLanguage(), detailedErrorStrings(), errorString(), KGlobal::locale(), KMessageBox::queuedDetailedError(), and KMessageBox::queuedMessageBox(). Referenced by emitResult(), and KDirLister::handleError(). |
|
Enable or disable the automatic error handling. When automatic error handling is enabled and an error occurs, then showErrorDialog is called with the specified parentWidget (if supplied) , right before the emission of the result signal. The default is false. See also isAutoErrorHandlingEnabled , showErrorDialog
Definition at line 269 of file job.cpp. Referenced by KDirOperator::del(). |
|
Returns whether automatic error handling is enabled or disabled. See also setAutoErrorHandlingEnabled . |
|
Associate this job with a window given by
Definition at line 280 of file job.cpp. References KIO::Scheduler::registerWindow(). |
|
Returns the window this job is associated with.
|
|
Set the parent Job. One example use of this is when FileCopyJob calls open_RenameDlg, it must pass the correct progress ID of the parent CopyJob (to hide the progress dialog).
|
|
Definition at line 298 of file job.cpp. Referenced by KIO::FileCopyJob::slotCanResume(). |
|
Set meta data to be sent to the slave.
|
|
Add key/value pair to the meta data that is sent to the slave.
Definition at line 320 of file job.cpp. References QMap< QString, QString >::insert(), and KStdAccel::key(). Referenced by KIO::get(), KIO::FileCopyJob::slotCanResume(), and KIO::TransferJob::slotFinished(). |
|
Add key/value pairs to the meta data that is sent to the slave. If a certain key already existed, it will be overridden. Definition at line 325 of file job.cpp. References QMap::begin(), QMapConstIterator::data(), QMap::end(), QMap< QString, QString >::insert(), and QMapConstIterator::key(). |
|
Add key/value pairs to the meta data that is sent to the slave. If a certain key already existed, it will remain unchanged. Definition at line 332 of file job.cpp. References QMap::begin(), QMapConstIterator::data(), QMap::end(), QMap< QString, QString >::insert(), and QMapConstIterator::key(). Referenced by addSubjob(). |
|
Get meta data received from the slave. (Valid when first data is received and/or slave is finished) |
|
Query meta data received from the slave. (Valid when first data is received and/or slave is finished) Definition at line 308 of file job.cpp. References QMap< QString, QString >::contains(), and KStdAccel::key(). Referenced by KIO::TransferJob::slotFinished(). |
|
Emitted when the job is finished, in any case (completed, canceled, failed...). Use error to know the result. Referenced by addSubjob(), KIO::PreviewJob::availablePlugins(), KIO::MetaInfoJob::availablePlugins(), emitResult(), KIO::PreviewJob::supportedMimeTypes(), and KIO::MetaInfoJob::supportedMimeTypes(). |
|
Emitted when the job is canceled.
Referenced by kill(). |
|
Emitted to display information about this job, as sent by the slave. Examples of message are "Resolving host", "Connecting to host...", etc. Referenced by addSubjob(), KIO::SimpleJob::slotInfoMessage(), and slotInfoMessage(). |
|
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). Referenced by KIO::SimpleJob::slotConnected(). |
|
Progress signal showing the overall progress of the job This is valid for any kind of job, and allows using a a progress bar very easily. (see KProgress). Note that this signal is not emitted for finished jobs (i.e. percent is never 100). Referenced by emitPercent(), KIO::FileCopyJob::slotPercent(), and KIO::DeleteJob::slotProcessedSize(). |
|
Emitted when we know the size of this job (data size for transfers, number of entries for listings).
Referenced by emitPercent(), KIO::FileCopyJob::slotTotalSize(), and KIO::SimpleJob::slotTotalSize(). |
|
Regularly emitted to show the progress of this job (current data size for transfers, entries listed).
Referenced by KIO::DeleteJob::slotProcessedSize(), KIO::FileCopyJob::slotProcessedSize(), and KIO::SimpleJob::slotProcessedSize(). |
|
Emitted to display information about the speed of this job.
Referenced by addSubjob(), emitSpeed(), and slotSpeedTimeout(). |
|
Called whenever a subjob finishes. Default implementation checks for errors and propagates to parent job, then calls removeSubjob. Override if you don't want subjobs errors to be propagated. Reimplemented in KDirSize, KIO::ChmodJob, KIO::TransferJob, KIO::FileCopyJob, KIO::DeleteJob, KIO::MetaInfoJob, and KIO::PreviewJob. Definition at line 208 of file job.cpp. References error(), errorText(), and removeSubjob(). Referenced by addSubjob(), and KDirSize::slotResult(). |
|
Forward signal from subjob.
Definition at line 220 of file job.cpp. References emitSpeed(). Referenced by addSubjob(). |
|
Forward signal from subjob.
Definition at line 226 of file job.cpp. References infoMessage(). Referenced by addSubjob(). |
|
Remove speed information.
Definition at line 231 of file job.cpp. References speed(), and QTimer::stop(). Referenced by emitSpeed(). |
|
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.
If Definition at line 121 of file job.cpp. References QPtrList< Job >::append(), QObject::connect(), infoMessage(), mergeMetaData(), result(), slotInfoMessage(), slotResult(), slotSpeed(), and speed(). Referenced by KIO::FileCopyJob::slotCanResume(), KIO::DeleteJob::slotResult(), and KIO::FileCopyJob::slotResult(). |
|
Mark a sub job as being done. If it's the last to wait on the job will emit a result - jobs with two steps might want to override slotResult in order to avoid calling this method. Definition at line 140 of file job.cpp. References emitResult(), QPtrList< Job >::isEmpty(), and QPtrList< Job >::remove(). Referenced by KIO::FileCopyJob::slotResult(), and slotResult(). |
|
Utility function for inherited jobs. Emits the percent signal if bigger than m_percent, after calculating it from the parameters. Definition at line 148 of file job.cpp. References percent(), and totalSize(). Referenced by KIO::FileCopyJob::slotProcessedSize(), and KIO::SimpleJob::slotProcessedSize(). |
|
Utility function for inherited jobs. Emits the speed signal and starts the timer for removing that info Definition at line 164 of file job.cpp. References QObject::connect(), slotSpeedTimeout(), speed(), and QTimer::start(). Referenced by KIO::SimpleJob::slotSpeed(), and slotSpeed(). |
|
Utility function to emit the result signal, and suicide this job. It first tells the observer to hide the progress dialog for this job. Definition at line 176 of file job.cpp. References Observer::jobFinished(), result(), Observer::self(), and showErrorDialog(). Referenced by kill(), KIO::MetaInfoJob::MetaInfoJob(), removeSubjob(), KIO::FileCopyJob::slotCanResume(), KIO::SimpleJob::slotFinished(), KIO::FileCopyJob::slotResult(), KIO::TransferJob::slotResult(), and KIO::ChmodJob::slotResult(). |
The documentation for this class was generated from the following files: