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

Signals | |
void | canceled (KJob *job) |
void | connected (KIO::Job *job) |
Public Member Functions | |
void | addMetaData (const QMap< QString, QString > &values) |
void | addMetaData (const QString &key, const QString &value) |
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) |
KDE_DEPRECATED void | showErrorDialog (QWidget *parent=0) |
void | start () |
JobUiDelegate * | ui () const |
virtual | ~Job () |
Protected Member Functions | |
virtual bool | addSubjob (KJob *job) |
virtual bool | doKill () |
virtual bool | doResume () |
virtual bool | doSuspend () |
Job (JobPrivate &dd) | |
Job () | |
virtual bool | removeSubjob (KJob *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( KJob * ) ), this, SLOT( slotResult( KJob * ) ) );
(other connects, specific to the job)
And slotResult is usually at least:
- See also:
- KIO::Scheduler
Definition at line 95 of file jobclasses.h.
Constructor & Destructor Documentation
Member Function Documentation
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()
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()
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.
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 414 of file global.cpp.
bool Job::doKill | ( | ) | [protected, virtual] |
Abort this job.
This kills all subjobs and deletes the job.
Reimplemented from KJob.
Reimplemented in KIO::SimpleJob.
bool Job::doResume | ( | ) | [protected, virtual] |
Resume this job.
- See also:
- suspend
Reimplemented from KJob.
Reimplemented in KIO::SimpleJob, KIO::TransferJob, and KIO::FileCopyJob.
bool Job::doSuspend | ( | ) | [protected, virtual] |
Suspend this job.
- See also:
- resume
Reimplemented from KJob.
Reimplemented in KIO::CopyJob, KIO::SimpleJob, and KIO::FileCopyJob.
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 Job::showErrorDialog. 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 KJob.
Definition at line 157 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()
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()
MetaData Job::metaData | ( | ) | const |
MetaData Job::outgoingMetaData | ( | ) | const |
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
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.
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()
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
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->ui()->setWindow(parent) and job->ui()->showErrorMessage() instead
void KIO::Job::start | ( | ) | [inline, virtual] |
Implements KJob.
Definition at line 104 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
The documentation for this class was generated from the following files: