class Job

Public Methods

• virtual  ~Job ()
• virtual void  kill ( bool quietly = true )
• int  error () const
• int  progressId () const
• const QString &  errorText () const
• QString  errorString () const
• QStringList  detailedErrorStrings (const KURL *reqUrl = 0L, int method = -1) const
• void  showErrorDialog ( QWidget * parent = 0L )
• void  setAutoErrorHandlingEnabled ( bool enable, QWidget *parentWidget = 0 )
• bool  isAutoErrorHandlingEnabled () const
• void  setWindow (QWidget *window)
• QWidget * window () const
• void  setMetaData ( const KIO::MetaData &)
• void  addMetaData (const QString &key, const QString &value)
• void  addMetaData (const QMap<QString,QString> &values)
• void  mergeMetaData (const QMap<QString,QString> &values)
• MetaData  outgoingMetaData () const
• MetaData  metaData () const
• QString  queryMetaData (const QString &key)

Signals

• void  result ( KIO::Job *job )
• void  canceled ( KIO::Job *job )
• void  infoMessage ( KIO::Job *, const QString & msg )
• void  connected ( KIO::Job * )
• void  percent ( KIO::Job *job, unsigned long percent )
• void  totalSize ( KIO::Job *, KIO::filesize_t size )
• void  processedSize ( KIO::Job *, KIO::filesize_t size )
• void  speed ( KIO::Job *, unsigned long bytes_per_second )

Protected Methods

•  Job ( bool showProgressInfo )
• virtual void  addSubjob ( Job *job, bool inheritMetaData=true )
• virtual void  removeSubjob ( Job *job )
• void  emitPercent ( KIO::filesize_t processedSize, KIO::filesize_t totalSize )
• void  emitSpeed ( unsigned long bytes_per_second )
• void  emitResult ()
• virtual void  virtual_hook ( int id, void* data )

Protected Slots

• virtual void  slotResult ( KIO::Job *job )
• void  slotSpeed ( KIO::Job*, unsigned long bytes_per_second )
• void  slotInfoMessage ( KIO::Job*, const QString & )
• void  slotSpeedTimeout ()

Protected Members

• QPtrList subjobs
• int m_error
• QString m_errorText
• unsigned long m_percent
• int m_progressId
• QTimer *m_speedTimer
• QGuardedPtr m_window
• MetaData m_outgoingMetaData
• MetaData m_incomingMetaData

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  );

[protected]

[virtual]

[virtual]

Abort this job. This kills all subjobs and deletes the job.

Parameters:

quietly

if false, Job will emit signal result and ask kio_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.

[const]

Returns: the error code for this job, 0 if no error Error codes are defined in KIO::Error. Only call this method from the slot connected to result.

[const]

Returns: the progress id for this job, as returned by uiserver

[const]

Returns: a string to help understand the error, usually the url related to the error. Only call if error is not 0. This is really internal, better use errorString or errorDialog.

[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.

[const]

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

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

Returns strings: caption, error + description, causes+solutions

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

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

Parameters:

enable	enable or disable automatic error handling
parentWidget	the parent widget, passed to showErrorDialog

[const]

Returns whether automatic error handling is enabled or disabled. See also setAutoErrorHandlingEnabled .

Associate this job with a window given by window.

[const]

Returns the window this job is associated with.

Set meta data to be sent to the slave.

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

Add key/value pairs to the meta data that is sent to the slave. If a certain key already existed, it will be overridden.

Add key/value pairs to the meta data that is sent to the slave. If a certain key already existed, it will remain unchanged.

[const]

[const]

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)

[signal]

Emitted when the job is finished, in any case (completed, canceled, failed...). Use error to know the result.

[signal]

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

[signal]

Emitted to display information about this job, as sent by the slave. Examples of message are "Resolving host", "Connecting to host...", etc.

[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).

[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)

[signal]

Emitted when we know the size of this job (data size for transfers, number of entries for listings).

[signal]

Regularly emitted to show the progress of this job (current data size for transfers, entries listed).

[signal]

Emitted to display information about the speed of this job.

[protected slots virtual slot]

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.

[protected slots slot]

Forward signal from subjob.

[protected slots slot]

Forward signal from subjob.

[protected slots slot]

Remove speed information.

[protected virtual]

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 inheritMetaData is true, the subjob will inherit the meta data from this job.

[protected virtual]

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.

[protected]

Utility function for inherited jobs. Emits the percent signal if bigger than m_percent, after calculating it from the parameters.

[protected]

Utility function for inherited jobs. Emits the speed signal and starts the timer for removing that info

[protected]

Utility function to emit the result signal, and suicide this job. It first tells the observer to hide the progress dialog for this job.

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected virtual]