.TH "KIO::Job" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::Job \- The base class for all jobs.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <jobclasses.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
Inherited by \fBKDirSize\fP, \fBKIO::ChmodJob\fP, \fBKIO::CopyJob\fP, \fBKIO::DeleteJob\fP, \fBKIO::FileCopyJob\fP, \fBKIO::MetaInfoJob\fP, \fBKIO::PreviewJob\fP, and \fBKIO::SimpleJob\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBresult\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBcanceled\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBinfoMessage\fP (\fBKIO::Job\fP *job, const \fBQString\fP &msg)"
.br
.ti -1c
.RI "void \fBconnected\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBpercent\fP (\fBKIO::Job\fP *job, unsigned long percent)"
.br
.ti -1c
.RI "void \fBtotalSize\fP (\fBKIO::Job\fP *job, \fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "void \fBprocessedSize\fP (\fBKIO::Job\fP *job, \fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "void \fBspeed\fP (\fBKIO::Job\fP *job, unsigned long bytes_per_second)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBkill\fP (bool quietly=true)"
.br
.ti -1c
.RI "int \fBerror\fP () const "
.br
.ti -1c
.RI "int \fBprogressId\fP () const "
.br
.ti -1c
.RI "const \fBQString\fP & \fBerrorText\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBerrorString\fP () const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBdetailedErrorStrings\fP (const \fBKURL\fP *reqUrl=0L, int method=-1) const "
.br
.ti -1c
.RI "void \fBshowErrorDialog\fP (\fBQWidget\fP *\fBparent\fP=0L)"
.br
.ti -1c
.RI "void \fBsetAutoErrorHandlingEnabled\fP (bool enable, \fBQWidget\fP *parentWidget=0)"
.br
.ti -1c
.RI "bool \fBisAutoErrorHandlingEnabled\fP () const "
.br
.ti -1c
.RI "void \fBsetInteractive\fP (bool enable)"
.br
.ti -1c
.RI "bool \fBisInteractive\fP () const "
.br
.ti -1c
.RI "void \fBsetWindow\fP (\fBQWidget\fP *window)"
.br
.ti -1c
.RI "\fBQWidget\fP * \fBwindow\fP () const "
.br
.ti -1c
.RI "void \fBsetParentJob\fP (\fBJob\fP *parentJob)"
.br
.ti -1c
.RI "\fBJob\fP * \fBparentJob\fP () const "
.br
.ti -1c
.RI "void \fBsetMetaData\fP (const \fBKIO::MetaData\fP &metaData)"
.br
.ti -1c
.RI "void \fBaddMetaData\fP (const \fBQString\fP &key, const \fBQString\fP &value)"
.br
.ti -1c
.RI "void \fBaddMetaData\fP (const \fBQMap\fP< \fBQString\fP, \fBQString\fP > &values)"
.br
.ti -1c
.RI "void \fBmergeMetaData\fP (const \fBQMap\fP< \fBQString\fP, \fBQString\fP > &values)"
.br
.ti -1c
.RI "\fBMetaData\fP \fBoutgoingMetaData\fP () const "
.br
.ti -1c
.RI "\fBMetaData\fP \fBmetaData\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBqueryMetaData\fP (const \fBQString\fP &key)"
.br
.ti -1c
.RI "\fBKIO::filesize_t\fP \fBgetProcessedSize\fP ()"
.br
.in -1c
.SS "Protected Types"

.in +1c
.ti -1c
.RI "enum { \fBEF_TransferJobAsync\fP =  (1 << 0), \fBEF_TransferJobNeedData\fP =  (1 << 1), \fBEF_TransferJobDataSent\fP =  (1 << 2), \fBEF_ListJobUnrestricted\fP =  (1 << 3) }"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "virtual void \fBslotResult\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBslotSpeed\fP (\fBKIO::Job\fP *job, unsigned long bytes_per_second)"
.br
.ti -1c
.RI "void \fBslotInfoMessage\fP (\fBKIO::Job\fP *job, const \fBQString\fP &msg)"
.br
.ti -1c
.RI "void \fBslotSpeedTimeout\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBJob\fP (bool showProgressInfo)"
.br
.ti -1c
.RI "virtual void \fBaddSubjob\fP (\fBJob\fP *job, bool inheritMetaData=true)"
.br
.ti -1c
.RI "virtual void \fBremoveSubjob\fP (\fBJob\fP *job)"
.br
.ti -1c
.RI "void \fBremoveSubjob\fP (\fBJob\fP *job, bool mergeMetaData, bool emitResultIfLast)"
.br
.ti -1c
.RI "void \fBemitPercent\fP (\fBKIO::filesize_t\fP processedSize, \fBKIO::filesize_t\fP totalSize)"
.br
.ti -1c
.RI "void \fBemitSpeed\fP (unsigned long bytes_per_second)"
.br
.ti -1c
.RI "void \fBemitResult\fP ()"
.br
.ti -1c
.RI "void \fBsetProcessedSize\fP (\fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "int & \fBextraFlags\fP ()"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBQPtrList\fP< \fBJob\fP > \fBsubjobs\fP"
.br
.ti -1c
.RI "int \fBm_error\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBm_errorText\fP"
.br
.ti -1c
.RI "unsigned long \fBm_percent\fP"
.br
.ti -1c
.RI "int \fBm_progressId\fP"
.br
.ti -1c
.RI "\fBQTimer\fP * \fBm_speedTimer\fP"
.br
.ti -1c
.RI "\fBQGuardedPtr\fP< \fBQWidget\fP > \fBm_window\fP"
.br
.ti -1c
.RI "\fBMetaData\fP \fBm_outgoingMetaData\fP"
.br
.ti -1c
.RI "\fBMetaData\fP \fBm_incomingMetaData\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The base class for all jobs. 

For all jobs created in an application, the code looks like
.PP
.PP
.nf
   KIO::Job * job = KIO::someoperation( some parameters );
   connect( job, SIGNAL( result( KIO::Job * ) ),
            this, SLOT( slotResult( KIO::Job * ) ) );
.fi
.PP
 (other connects, specific to the job)
.PP
And slotResult is usually at least:
.PP
.PP
.nf
  if ( job->error() )
      job->showErrorDialog( this or 0L  );
.fi
.PP
 
.PP
\fBSee also:\fP
.RS 4
\fBKIO::Scheduler\fP 
.PP
KIO::Slave 
.RE
.PP

.PP
Definition at line 68 of file jobclasses.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual void KIO::Job::kill (bool quietly = \fCtrue\fP)\fC [virtual]\fP"
.PP
Abort this job. 
.PP
This kills all subjobs and deletes the job.
.PP
\fBParameters:\fP
.RS 4
\fIquietly\fP if false, \fBJob\fP will emit signal result and ask kio_uiserver to close the progress window. \fCquietly\fP 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. 
.RE
.PP

.PP
Reimplemented in \fBKIO::SimpleJob\fP.
.PP
Referenced by KImageFilePreview::clearPreview(), KIO::SimpleJob::kill(), and KIO::ProgressBase::slotStop().
.SS "int KIO::Job::error () const\fC [inline]\fP"
.PP
Returns the error code, if there has been an error. 
.PP
Only call this method from the slot connected to \fBresult()\fP. 
.PP
\fBReturns:\fP
.RS 4
the error code for this job, 0 if no error. Error codes are defined in \fBKIO::Error\fP. 
.RE
.PP

.PP
Definition at line 95 of file jobclasses.h.
.PP
Referenced by KIO::DeleteJob::slotResult(), KIO::TransferJob::slotResult(), and KIO::ChmodJob::slotResult().
.SS "int KIO::Job::progressId () const\fC [inline]\fP"
.PP
Returns the progress id for this job. 
.PP
\fBReturns:\fP
.RS 4
the progress id for this job, as returned by uiserver 
.RE
.PP

.PP
Definition at line 101 of file jobclasses.h.
.SS "const \fBQString\fP& KIO::Job::errorText () const\fC [inline]\fP"
.PP
Returns the error text if there has been an error. 
.PP
Only call if error is not 0. This is really internal, better use errorString or errorDialog.
.PP
\fBReturns:\fP
.RS 4
a string to help understand the error, usually the url related to the error. Only valid if \fBerror()\fP is not 0. 
.RE
.PP

.PP
Definition at line 111 of file jobclasses.h.
.SS "KIO_EXPORT \fBQString\fP KIO::Job::errorString () const"
.PP
Converts an error code and a non-i18n error message into an error message in the current language. 
.PP
The low level (non-i18n) error message (usually a url) is put into the translated error message using 1.
.PP
Example for errid == ERR_CANNOT_OPEN_FOR_READING: 
.PP
.nf
   i18n( 'Could not read\n%1' ).arg( errortext );

.fi
.PP
 Use this to display the error yourself, but for a dialog box use \fBJob::showErrorDialog\fP. Do not call it if \fBerror()\fP is not 0. 
.PP
\fBReturns:\fP
.RS 4
the error message and if there is no error, a message telling the user that the app is broken, so check with \fBerror()\fP whether there is an error 
.RE
.PP

.PP
Definition at line 195 of file global.cpp.
.PP
References KIO::buildErrorString().
.SS "KIO_EXPORT \fBQStringList\fP KIO::Job::detailedErrorStrings (const \fBKURL\fP * reqUrl = \fC0L\fP, int method = \fC-1\fP) const"
.PP
Converts an error code and a non-i18n error message into i18n strings suitable for presentation in a detailed error message box. 
.PP
\fBParameters:\fP
.RS 4
\fIreqUrl\fP the request URL that generated this error message 
.br
\fImethod\fP the method that generated this error message (unimplemented) 
.RE
.PP
\fBReturns:\fP
.RS 4
the following strings: caption, error + description, causes+solutions 
.RE
.PP

.PP
Definition at line 445 of file global.cpp.
.PP
References QString::arg(), KLocale::formatDateTime(), QString::fromLatin1(), QString::isNull(), QStringList::join(), KGlobal::locale(), and KIO::rawErrorDetail().
.SS "void KIO::Job::showErrorDialog (\fBQWidget\fP * parent = \fC0L\fP)"
.PP
Display a dialog box to inform the user of the error given by this job. 
.PP
Only call if error is not 0, and only in the slot connected to result. 
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP the parent widget for the dialog box, can be 0 for top-level 
.RE
.PP

.PP
Referenced by KDirLister::handleError().
.SS "void KIO::Job::setAutoErrorHandlingEnabled (bool enable, \fBQWidget\fP * parentWidget = \fC0\fP)"
.PP
Enable or disable the automatic error handling. 
.PP
When automatic error handling is enabled and an error occurs, then \fBshowErrorDialog()\fP is called with the specified \fCparentWidget\fP (if supplied) , right before the emission of the result signal.
.PP
The default is false.
.PP
See also isAutoErrorHandlingEnabled , showErrorDialog
.PP
\fBParameters:\fP
.RS 4
\fIenable\fP enable or disable automatic error handling 
.br
\fIparentWidget\fP the parent widget, passed to showErrorDialog. Can be 0 for top-level 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBisAutoErrorHandlingEnabled()\fP 
.RE
.PP

.PP
Referenced by KDirOperator::del(), and KDirOperator::trash().
.SS "bool KIO::Job::isAutoErrorHandlingEnabled () const"
.PP
Returns whether automatic error handling is enabled or disabled. 
.PP
See also setAutoErrorHandlingEnabled . 
.PP
\fBReturns:\fP
.RS 4
true if automatic error handling is enabled 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetAutoErrorHandlingEnabled()\fP 
.RE
.PP

.SS "void KIO::Job::setInteractive (bool enable)"
.PP
Enable or disable the message display from the job. 
.PP
The default is true. 
.PP
\fBParameters:\fP
.RS 4
\fIenable\fP enable or disable message display 
.RE
.PP
\fBSince:\fP
.RS 4
3.4.1 
.RE
.PP

.PP
Reimplemented in \fBKIO::CopyJob\fP.
.PP
Referenced by KIO::CopyJob::setInteractive().
.SS "bool KIO::Job::isInteractive () const"
.PP
Returns whether message display is enabled or disabled. 
.PP
See also setInteractive . 
.PP
\fBReturns:\fP
.RS 4
true if message display is enabled 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetInteractive()\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.4.1 
.RE
.PP

.SS "void KIO::Job::setWindow (\fBQWidget\fP * window)"
.PP
Associate this job with a window given by \fCwindow\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the window to associate to 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBwindow()\fP 
.RE
.PP

.PP
Referenced by KDirOperator::del(), and KDirOperator::trash().
.SS "\fBQWidget\fP* KIO::Job::window () const"
.PP
Returns the window this job is associated with. 
.PP
\fBReturns:\fP
.RS 4
the associated window 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetWindow()\fP 
.RE
.PP

.SS "void KIO::Job::setParentJob (\fBJob\fP * parentJob)"
.PP
Set the parent \fBJob\fP. 
.PP
One example use of this is when \fBFileCopyJob\fP calls open_RenameDlg, it must pass the correct progress ID of the parent \fBCopyJob\fP (to hide the progress dialog). You can set the parent job only once. By default a job does not have a parent job. 
.PP
\fBParameters:\fP
.RS 4
\fIparentJob\fP the new parent job 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.SS "\fBJob\fP* KIO::Job::parentJob () const"
.PP
Returns the parent job, if there is one. 
.PP
\fBReturns:\fP
.RS 4
the parent job, or 0 if there is none 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetParentJob\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.SS "void KIO::Job::setMetaData (const \fBKIO::MetaData\fP & metaData)"
.PP
Set meta data to be sent to the slave, replacing existing meta data. 
.PP
\fBParameters:\fP
.RS 4
\fImetaData\fP the meta data to set 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaddMetaData()\fP 
.PP
\fBmergeMetaData()\fP 
.RE
.PP

.SS "void KIO::Job::addMetaData (const \fBQString\fP & key, const \fBQString\fP & value)"
.PP
Add key/value pair to the meta data that is sent to the slave. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key of the meta data 
.br
\fIvalue\fP the value of the meta data 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetMetaData()\fP 
.PP
\fBmergeMetaData()\fP 
.RE
.PP

.PP
Referenced by KIO::davPropFind(), KIO::get(), KIO::TransferJob::slotFinished(), and KIO::storedGet().
.SS "void KIO::Job::addMetaData (const \fBQMap\fP< \fBQString\fP, \fBQString\fP > & values)"
.PP
Add key/value pairs to the meta data that is sent to the slave. 
.PP
If a certain key already existed, it will be overridden. 
.PP
\fBParameters:\fP
.RS 4
\fIvalues\fP the meta data to add 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetMetaData()\fP 
.PP
\fBmergeMetaData()\fP 
.RE
.PP

.SS "void KIO::Job::mergeMetaData (const \fBQMap\fP< \fBQString\fP, \fBQString\fP > & values)"
.PP
Add key/value pairs to the meta data that is sent to the slave. 
.PP
If a certain key already existed, it will remain unchanged. 
.PP
\fBParameters:\fP
.RS 4
\fIvalues\fP the meta data to merge 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetMetaData()\fP 
.PP
\fBaddMetaData()\fP 
.RE
.PP

.SS "\fBMetaData\fP KIO::Job::metaData () const"
.PP
Get meta data received from the slave. 
.PP
(Valid when first data is received and/or slave is finished) 
.PP
\fBReturns:\fP
.RS 4
the job's meta data 
.RE
.PP

.SS "\fBQString\fP KIO::Job::queryMetaData (const \fBQString\fP & key)"
.PP
Query meta data received from the slave. 
.PP
(Valid when first data is received and/or slave is finished) 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key of the meta data to retrieve 
.RE
.PP
\fBReturns:\fP
.RS 4
the value of the meta data, or QString::null if the \fCkey\fP does not exist 
.RE
.PP

.PP
Referenced by KIO::ListJob::slotFinished(), KIO::MimetypeJob::slotFinished(), KIO::TransferJob::slotFinished(), KIO::StatJob::slotFinished(), and KIO::MkdirJob::slotFinished().
.SS "\fBKIO::filesize_t\fP KIO::Job::getProcessedSize ()"
.PP
Returns the processed size for this job. 
.PP
\fBSee also:\fP
.RS 4
\fBprocessedSize\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Referenced by KIO::TransferJob::sendAsyncData().
.SS "void KIO::Job::result (\fBKIO::Job\fP * job)\fC [signal]\fP"
.PP
Emitted when the job is finished, in any case (completed, canceled, failed...). 
.PP
Use error to know the result. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.RE
.PP

.SS "void KIO::Job::canceled (\fBKIO::Job\fP * job)\fC [signal]\fP"
.PP
\fBDeprecated\fP
.RS 4
. Don't use ! Emitted when the job is canceled. Signal \fBresult()\fP is emitted as well, and \fBerror()\fP is, in this case, ERR_USER_CANCELED.
.RE
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.RE
.PP

.SS "void KIO::Job::infoMessage (\fBKIO::Job\fP * job, const \fBQString\fP & msg)\fC [signal]\fP"
.PP
Emitted to display information about this job, as sent by the slave. 
.PP
Examples of message are 'Resolving host', 'Connecting to host...', etc. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fImsg\fP the info message 
.RE
.PP

.PP
Referenced by KIO::SimpleJob::slotInfoMessage().
.SS "void KIO::Job::connected (\fBKIO::Job\fP * job)\fC [signal]\fP"
.PP
Emitted when the slave successfully connected to the host. 
.PP
There is no guarantee the slave will send this, and this is currently unused (in the applications). 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.RE
.PP

.PP
Referenced by KIO::SimpleJob::slotConnected().
.SS "void KIO::Job::percent (\fBKIO::Job\fP * job, unsigned long percent)\fC [signal]\fP"
.PP
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. 
.PP
(see \fBKProgress\fP). Note that this signal is not emitted for finished jobs. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIpercent\fP the percentage 
.RE
.PP

.PP
Referenced by KIO::DeleteJob::slotProcessedSize().
.SS "void KIO::Job::totalSize (\fBKIO::Job\fP * job, \fBKIO::filesize_t\fP size)\fC [signal]\fP"
.PP
Emitted when we know the size of this job (data size for transfers, number of entries for listings). 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIsize\fP the total size in bytes 
.RE
.PP

.PP
Referenced by KIO::SimpleJob::slotTotalSize().
.SS "void KIO::Job::processedSize (\fBKIO::Job\fP * job, \fBKIO::filesize_t\fP size)\fC [signal]\fP"
.PP
Regularly emitted to show the progress of this job (current data size for transfers, entries listed). 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIsize\fP the processed size in bytes 
.RE
.PP

.PP
Referenced by KIO::TransferJob::sendAsyncData(), KIO::DeleteJob::slotProcessedSize(), and KIO::SimpleJob::slotProcessedSize().
.SS "void KIO::Job::speed (\fBKIO::Job\fP * job, unsigned long bytes_per_second)\fC [signal]\fP"
.PP
Emitted to display information about the speed of this job. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIbytes_per_second\fP the speed in bytes/s 
.RE
.PP

.SS "virtual void KIO::Job::slotResult (\fBKIO::Job\fP * job)\fC [protected, virtual, slot]\fP"
.PP
Called whenever a subjob finishes. 
.PP
Default implementation checks for errors and propagates to parent job, then calls removeSubjob. Override if you don't want subjobs errors to be propagated. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the subjob 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBresult()\fP 
.RE
.PP

.PP
Reimplemented in \fBKDirSize\fP, \fBKIO::ChmodJob\fP, \fBKIO::TransferJob\fP, \fBKIO::FileCopyJob\fP, \fBKIO::ListJob\fP, \fBKIO::CopyJob\fP, \fBKIO::DeleteJob\fP, \fBKIO::MetaInfoJob\fP, and \fBKIO::PreviewJob\fP.
.PP
Referenced by KDirSize::slotResult(), and KIO::DeleteJob::slotResult().
.SS "void KIO::Job::slotSpeed (\fBKIO::Job\fP * job, unsigned long bytes_per_second)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the subjob 
.br
\fIbytes_per_second\fP the speed in bytes/s 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBspeed()\fP 
.RE
.PP

.SS "void KIO::Job::slotInfoMessage (\fBKIO::Job\fP * job, const \fBQString\fP & msg)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the subjob 
.br
\fImsg\fP the info message 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBinfoMessage()\fP 
.RE
.PP

.SS "void KIO::Job::slotSpeedTimeout ()\fC [protected, slot]\fP"
.PP
Remove speed information. 
.PP
.SS "virtual void KIO::Job::addSubjob (\fBJob\fP * job, bool inheritMetaData = \fCtrue\fP)\fC [protected, virtual]\fP"
.PP
Add a job that has to be finished before a result is emitted. 
.PP
This has obviously to be called before the finish signal is emitted by the slave.
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the subjob to add 
.br
\fIinheritMetaData\fP if true, the subjob will inherit the meta data from this job. 
.RE
.PP

.PP
Referenced by KIO::DeleteJob::slotResult().
.SS "virtual void KIO::Job::removeSubjob (\fBJob\fP * job)\fC [protected, virtual]\fP"
.PP
Mark a sub job as being done. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the subjob to add 
.RE
.PP

.PP
Referenced by KIO::ListJob::slotResult(), and KIO::TransferJob::slotResult().
.SS "void KIO::Job::removeSubjob (\fBJob\fP * job, bool mergeMetaData, bool emitResultIfLast)\fC [protected]\fP"
.PP
Overloaded version of removeSubjob. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the subjob to remove 
.br
\fImergeMetaData\fP if set, the metadata received by the subjob is merged into this job. 
.br
\fIemitResultIfLast\fP if this was the last subjob, emit result, i.e. terminate this job. 
.RE
.PP

.SS "void KIO::Job::emitPercent (\fBKIO::filesize_t\fP processedSize, \fBKIO::filesize_t\fP totalSize)\fC [protected]\fP"
.PP
Utility function for inherited jobs. 
.PP
Emits the percent signal if bigger than m_percent, after calculating it from the parameters.
.PP
\fBParameters:\fP
.RS 4
\fIprocessedSize\fP the processed size in bytes 
.br
\fItotalSize\fP the total size in bytes 
.RE
.PP

.PP
Referenced by KIO::TransferJob::sendAsyncData(), and KIO::SimpleJob::slotProcessedSize().
.SS "void KIO::Job::emitSpeed (unsigned long bytes_per_second)\fC [protected]\fP"
.PP
Utility function for inherited jobs. 
.PP
Emits the speed signal and starts the timer for removing that info
.PP
\fBParameters:\fP
.RS 4
\fIbytes_per_second\fP the speed in bytes_per_second 
.RE
.PP

.PP
Referenced by KIO::SimpleJob::slotSpeed().
.SS "void KIO::Job::emitResult ()\fC [protected]\fP"
.PP
Utility function to emit the result signal, and suicide this job. 
.PP
It first tells the observer to hide the progress dialog for this job. 
.PP
Referenced by KIO::MetaInfoJob::MetaInfoJob(), KIO::SimpleJob::slotFinished(), KIO::TransferJob::slotResult(), and KIO::ChmodJob::slotResult().
.SS "void KIO::Job::setProcessedSize (\fBKIO::filesize_t\fP size)\fC [protected]\fP"
.PP
Set the processed size, does not emit processedSize 
.PP
\fBSince:\fP
.RS 4
3.2. 
.RE
.PP

.PP
Referenced by KIO::TransferJob::sendAsyncData(), KIO::DeleteJob::slotProcessedSize(), and KIO::SimpleJob::slotProcessedSize().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
