Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KIO::Job Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::Job:

KDirSize KIO::ChmodJob KIO::DeleteJob KIO::FileCopyJob KIO::MetaInfoJob KIO::PreviewJob KIO::SimpleJob List of all members.

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)

Public Methods

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 setParentJob (Job *parentJob)
Job * parentJob () 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 metaData () const
QString queryMetaData (const QString &key)

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 Methods

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

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

void KIO::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.

void KIO::Job::addMetaData (  const QString &    key,
const QString &    value
) 
 

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

virtual void KIO::Job::addSubjob (  Job *    job,
bool    inheritMetaData = true
)  [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.

void KIO::Job::canceled (  KIO::Job *    job )  [signal]
 

Emitted when the job is canceled.

Deprecated:
. Don't use ! Signal result is emitted as well, and error() is, in this case, ERR_USER_CANCELED.

void KIO::Job::connected (  KIO::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).

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.

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

void KIO::Job::emitPercent (  KIO::filesize_t    processedSize,
KIO::filesize_t    totalSize
)  [protected]
 

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

void KIO::Job::emitResult (    )  [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.

void KIO::Job::emitSpeed (  unsigned long    bytes_per_second )  [protected]
 

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

int KIO::Job::error (    )  const [inline]
 

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

Definition at line 91 of file jobclasses.h.

QString KIO::Job::errorString (    ) 
 

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
%1" ).arg( errortext ); Use this to display the error yourself, but for a dialog box use Job::showErrorDialog.

const QString& KIO::Job::errorText (    )  const [inline]
 

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.

Definition at line 104 of file jobclasses.h.

void KIO::Job::infoMessage (  KIO::Job *   ,
const QString &    msg
)  [signal]
 

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

bool KIO::Job::isAutoErrorHandlingEnabled (    ) 
 

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

virtual void KIO::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 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.

Reimplemented in KIO::SimpleJob.

void KIO::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.

MetaData KIO::Job::metaData (    ) 
 

Get meta data received from the slave. (Valid when first data is received and/or slave is finished)

Job* KIO::Job::parentJob (    ) 
 

See also:
setParentJob
Since:
3.1

void KIO::Job::percent (  KIO::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 (i.e. percent is never 100).

void KIO::Job::processedSize (  KIO::Job *   ,
KIO::filesize_t    size
)  [signal]
 

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

int KIO::Job::progressId (    )  const [inline]
 

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

Definition at line 96 of file jobclasses.h.

QString KIO::Job::queryMetaData (  const QString &    key ) 
 

Query meta data received from the slave. (Valid when first data is received and/or slave is finished)

virtual void KIO::Job::removeSubjob (  Job *    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.

void KIO::Job::result (  KIO::Job *    job )  [signal]
 

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

void KIO::Job::setAutoErrorHandlingEnabled (  bool    enable,
QWidget *    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 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

void KIO::Job::setMetaData (  const KIO::MetaData &    ) 
 

Set meta data to be sent to the slave.

void KIO::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).

Since:
3.1

void KIO::Job::setWindow (  QWidget *    window ) 
 

Associate this job with a window given by window.

void KIO::Job::showErrorDialog (  QWidget *    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

void KIO::Job::slotInfoMessage (  KIO::Job *   ,
const QString &   
)  [protected, slot]
 

Forward signal from subjob.

virtual void KIO::Job::slotResult (  KIO::Job *    job )  [protected, 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.

Reimplemented in KDirSize, KIO::ChmodJob, KIO::TransferJob, KIO::FileCopyJob, KIO::DeleteJob, KIO::MetaInfoJob, and KIO::PreviewJob.

void KIO::Job::slotSpeed (  KIO::Job *   ,
unsigned long    bytes_per_second
)  [protected, slot]
 

Forward signal from subjob.

void KIO::Job::slotSpeedTimeout (    )  [protected, slot]
 

Remove speed information.

void KIO::Job::speed (  KIO::Job *   ,
unsigned long    bytes_per_second
)  [signal]
 

Emitted to display information about the speed of this job.

void KIO::Job::totalSize (  KIO::Job *   ,
KIO::filesize_t    size
)  [signal]
 

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

QWidget* KIO::Job::window (    ) 
 

Returns the window this job is associated with.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:33 2003 for kdelibs by doxygen1.2.18