#include <jobclasses.h>
|
enum | { EF_TransferJobAsync = (1 << 0)
, EF_TransferJobNeedData = (1 << 1)
, EF_TransferJobDataSent = (1 << 2)
, EF_ListJobUnrestricted = (1 << 3)
} |
|
|
TQPtrList< Job > | subjobs |
|
int | m_error |
|
TQString | m_errorText |
|
unsigned long | m_percent |
|
int | m_progressId |
|
TQTimer * | m_speedTimer |
|
TQGuardedPtr< TQWidget > | m_window |
|
MetaData | m_outgoingMetaData |
|
MetaData | m_incomingMetaData |
|
The base class for all jobs.
For all jobs created in an application, the code looks like
TDEIO::Job * job = TDEIO::someoperation( some parameters );
The base class for all jobs.
virtual void slotResult(TDEIO::Job *job)
void result(TDEIO::Job *job)
(other connects, specific to the job)
And slotResult is usually at least:
void showErrorDialog(TQWidget *parent=0L)
Display a dialog box to inform the user of the error given by this job.
int error() const
Returns the error code, if there has been an error.
- See also
- TDEIO::Scheduler
-
TDEIO::Slave
Definition at line 67 of file jobclasses.h.
◆ addMetaData() [1/2]
void Job::addMetaData |
( |
const TQMap< TQString, TQString > & |
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 439 of file job.cpp.
◆ addMetaData() [2/2]
void Job::addMetaData |
( |
const TQString & |
key, |
|
|
const TQString & |
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 434 of file job.cpp.
◆ addSubjob()
void Job::addSubjob |
( |
Job * |
job, |
|
|
bool |
inheritMetaData = true |
|
) |
| |
|
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 |
inheritMetaData | if true, the subjob will inherit the meta data from this job. |
Definition at line 183 of file job.cpp.
◆ canceled
@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 |
◆ connected
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 |
◆ detailedErrorStrings()
TDEIO_EXPORT TQStringList TDEIO::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 478 of file global.cpp.
◆ emitPercent()
Utility function for inherited jobs.
Emits the percent signal if bigger than m_percent,
after calculating it from the parameters.
- Parameters
-
processedSize | the processed size in bytes |
totalSize | the total size in bytes |
Definition at line 221 of file job.cpp.
◆ emitResult()
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 249 of file job.cpp.
◆ emitSpeed()
void Job::emitSpeed |
( |
unsigned long |
speed | ) |
|
|
protected |
Utility function for inherited jobs.
Emits the speed signal and starts the timer for removing that info
- Parameters
-
speed | the speed in bytes/s |
Definition at line 237 of file job.cpp.
◆ error()
int TDEIO::Job::error |
( |
| ) |
const |
|
inline |
Returns the error code, if there has been an error.
Only call this method from the slot connected to result().
- Returns
- the error code for this job, 0 if no error. Error codes are defined in TDEIO::Error.
Definition at line 94 of file jobclasses.h.
◆ errorString()
TDEIO_EXPORT TQString TDEIO::Job::errorString |
( |
| ) |
const |
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
Definition at line 225 of file global.cpp.
◆ errorText()
const TQString& TDEIO::Job::errorText |
( |
| ) |
const |
|
inline |
Returns the error text if there has been an error.
Only call if error is not 0. This is really internal, better use errorString() or errorDialog().
- Returns
- a string to help understand the error, usually the url related to the error. Only valid if error() is not 0.
Definition at line 110 of file jobclasses.h.
◆ getProcessedSize()
◆ infoMessage
void TDEIO::Job::infoMessage |
( |
TDEIO::Job * |
job, |
|
|
const TQString & |
msg |
|
) |
| |
|
signal |
Emitted to display information about this job, as sent by the slave.
Examples of message are "Resolving host", "Connecting to host...", etc.
- Parameters
-
job | the job that emitted this signal |
msg | the info message |
◆ isAutoErrorHandlingEnabled()
bool Job::isAutoErrorHandlingEnabled |
( |
| ) |
const |
◆ isAutoWarningHandlingEnabled()
bool Job::isAutoWarningHandlingEnabled |
( |
| ) |
const |
Returns whether automatic warning handling is enabled or disabled.
See also setAutoWarningHandlingEnabled .
- Returns
- true if automatic warning handling is enabled
- See also
- setAutoWarningHandlingEnabled()
- Since
- 3.5
Definition at line 366 of file job.cpp.
◆ isInteractive()
bool Job::isInteractive |
( |
| ) |
const |
Returns whether message display is enabled or disabled.
- Returns
- true if message display is enabled
- See also
- setInteractive()
- Since
- 3.4.1
Definition at line 376 of file job.cpp.
◆ kill()
void Job::kill |
( |
bool |
quietly = true | ) |
|
|
virtual |
Abort this job.
This kills all subjobs and deletes the job.
- Parameters
-
quietly | if false, Job will emit signal result and ask tdeio_uiserver to close the progress window. quietly is set to true for subjobs. Whether applications should call with true or false depends on whether they rely on result being emitted or not. |
Reimplemented in TDEIO::PreviewJob, and TDEIO::SimpleJob.
Definition at line 260 of file job.cpp.
◆ mergeMetaData()
void Job::mergeMetaData |
( |
const TQMap< TQString, TQString > & |
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 446 of file job.cpp.
◆ metaData()
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 417 of file job.cpp.
◆ parentJob()
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
- Since
- 3.1
Definition at line 412 of file job.cpp.
◆ percent
void TDEIO::Job::percent |
( |
TDEIO::Job * |
job, |
|
|
unsigned long |
percent |
|
) |
| |
|
signal |
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.
- Parameters
-
job | the job that emitted this signal |
percent | the percentage |
◆ processedSize
Regularly emitted to show the progress of this job
(current data size for transfers, entries listed).
- Parameters
-
job | the job that emitted this signal |
size | the processed size in bytes |
◆ progressId()
int TDEIO::Job::progressId |
( |
| ) |
const |
|
inline |
Returns the progress id for this job.
- Returns
- the progress id for this job, as returned by uiserver
Definition at line 100 of file jobclasses.h.
◆ queryMetaData()
TQString Job::queryMetaData |
( |
const TQString & |
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 TQString::null if the
key
does not exist
Definition at line 422 of file job.cpp.
◆ removeSubjob() [1/2]
void Job::removeSubjob |
( |
Job * |
job | ) |
|
|
protectedvirtual |
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.
- Parameters
-
Definition at line 205 of file job.cpp.
◆ removeSubjob() [2/2]
void Job::removeSubjob |
( |
Job * |
job, |
|
|
bool |
mergeMetaData, |
|
|
bool |
emitResultIfLast |
|
) |
| |
|
protected |
Overloaded version of removeSubjob.
- Parameters
-
job | the subjob to remove |
mergeMetaData | if set, the metadata received by the subjob is merged into this job. |
emitResultIfLast | if this was the last subjob, emit result, i.e. terminate this job. |
Definition at line 210 of file job.cpp.
◆ result
Emitted when the job is finished, in any case (completed, canceled,
failed...). Use error to know the result.
- Parameters
-
job | the job that emitted this signal |
◆ setAutoErrorHandlingEnabled()
void Job::setAutoErrorHandlingEnabled |
( |
bool |
enable, |
|
|
TQWidget * |
parentWidget = 0 |
|
) |
| |
Enable or disable the automatic error handling. When automatic
error handling is enabled and an error occurs, then showErrorDialog()
is called with the specified @p parentWidget (if supplied) , right before
the emission of the result signal.
The default is false.
@param enable enable or disable automatic error handling
@param parentWidget the parent widget, passed to showErrorDialog.
Can be 0 for top-level
- See also
- isAutoErrorHandlingEnabled(), showErrorDialog()
Definition at line 342 of file job.cpp.
◆ setAutoWarningHandlingEnabled()
void Job::setAutoWarningHandlingEnabled |
( |
bool |
enable | ) |
|
Enable or disable the automatic warning handling.
When automatic warning handling is enabled and an error occurs, then a message box is displayed with the warning message
The default is true.
See also isAutoWarningHandlingEnabled , showErrorDialog
- Parameters
-
enable | enable or disable automatic warning handling |
- See also
- isAutoWarningHandlingEnabled()
- Since
- 3.5
Definition at line 361 of file job.cpp.
◆ setInteractive()
void Job::setInteractive |
( |
bool |
enable | ) |
|
Enable or disable the message display from the job.
The default is true.
- Parameters
-
enable | enable or disable message display |
- Since
- 3.4.1
Definition at line 371 of file job.cpp.
◆ setMetaData()
◆ setParentJob()
void Job::setParentJob |
( |
Job * |
parentJob | ) |
|
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).
You can set the parent job only once. By default a job does not have a parent job.
- Parameters
-
parentJob | the new parent job |
- Since
- 3.1
Definition at line 405 of file job.cpp.
◆ setProcessedSize()
Set the processed size, does not emit processedSize.
- Since
- 3.2
Definition at line 173 of file job.cpp.
◆ setWindow()
void Job::setWindow |
( |
TQWidget * |
window | ) |
|
Associate this job with a window given by @p window.
- Parameters
-
window | the window to associate to |
- See also
- window()
Definition at line 381 of file job.cpp.
◆ showErrorDialog()
void Job::showErrorDialog |
( |
TQWidget * |
parent = 0L | ) |
|
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 |
Definition at line 315 of file job.cpp.
◆ slotInfoMessage
void Job::slotInfoMessage |
( |
TDEIO::Job * |
job, |
|
|
const TQString & |
msg |
|
) |
| |
|
protectedslot |
Forward signal from subjob.
- Parameters
-
job | the subjob |
msg | the info message |
- See also
- infoMessage()
Definition at line 299 of file job.cpp.
◆ slotResult
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.
- Parameters
-
- See also
- result()
Reimplemented in TDEIO::TransferJob.
Definition at line 281 of file job.cpp.
◆ slotSpeed
void Job::slotSpeed |
( |
TDEIO::Job * |
job, |
|
|
unsigned long |
speed |
|
) |
| |
|
protectedslot |
Forward signal from subjob.
- Parameters
-
job | the subjob |
speed | the speed in bytes/s |
- See also
- speed()
Definition at line 293 of file job.cpp.
◆ slotSpeedTimeout
void Job::slotSpeedTimeout |
( |
| ) |
|
|
protectedslot |
Remove speed information.
Definition at line 304 of file job.cpp.
◆ speed
void TDEIO::Job::speed |
( |
TDEIO::Job * |
job, |
|
|
unsigned long |
speed |
|
) |
| |
|
signal |
Emitted to display information about the speed of this job.
- Parameters
-
job | the job that emitted this signal |
speed | the speed in bytes/s |
◆ totalSize
Emitted when we know the size of this job (data size for transfers,
number of entries for listings).
- Parameters
-
job | the job that emitted this signal |
size | the total size in bytes |
◆ updateUserTimestamp()
void Job::updateUserTimestamp |
( |
unsigned long |
time | ) |
|
Updates the last user action timestamp to the given time.
See TDEApplication::updateUserTimestamp() .
- Since
- 3.5.6
Definition at line 392 of file job.cpp.
◆ warning
void TDEIO::Job::warning |
( |
TDEIO::Job * |
job, |
|
|
const TQString & |
msg |
|
) |
| |
|
signal |
Emitted to display a warning about this job, as sent by the slave.
- Parameters
-
job | the job that emitted this signal |
msg | the info message |
- Since
- 3.5
◆ window()
TQWidget * Job::window |
( |
| ) |
const |
Returns the window this job is associated with.
- Returns
- the associated window
- See also
- setWindow()
Definition at line 387 of file job.cpp.
The documentation for this class was generated from the following files: