.TH "KIO::SimpleJob" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::SimpleJob \- A simple job (one url and one command).  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <jobclasses.h>\fP
.PP
Inherits \fBKIO::Job\fP.
.PP
Inherited by KIO::DirectCopyJob, \fBKIO::ListJob\fP, \fBKIO::MkdirJob\fP, \fBKIO::StatJob\fP, and \fBKIO::TransferJob\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBslotTotalSize\fP (\fBKIO::filesize_t\fP data_size)"
.br
.ti -1c
.RI "virtual void \fBslotError\fP (int, const \fBQString\fP &)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSimpleJob\fP (const \fBKURL\fP &url, int command, const \fBQByteArray\fP &packedArgs, bool showProgressInfo)"
.br
.ti -1c
.RI "const \fBKURL\fP & \fBurl\fP () const "
.br
.ti -1c
.RI "virtual void \fBkill\fP (bool quietly=true)"
.br
.ti -1c
.RI "virtual void \fBputOnHold\fP ()"
.br
.ti -1c
.RI "virtual void \fBstart\fP (Slave *slave)"
.br
.ti -1c
.RI "void \fBslaveDone\fP ()"
.br
.ti -1c
.RI "Slave * \fBslave\fP () const "
.br
.ti -1c
.RI "int \fBcommand\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBremoveOnHold\fP ()"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "virtual void \fBslotFinished\fP ()"
.br
.ti -1c
.RI "void \fBslotWarning\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "void \fBslotInfoMessage\fP (const \fBQString\fP &s)"
.br
.ti -1c
.RI "void \fBslotConnected\fP ()"
.br
.ti -1c
.RI "void \fBslotProcessedSize\fP (\fBKIO::filesize_t\fP data_size)"
.br
.ti -1c
.RI "void \fBslotSpeed\fP (unsigned long bytes_per_second)"
.br
.ti -1c
.RI "virtual void \fBslotMetaData\fP (const \fBKIO::MetaData\fP &_metaData)"
.br
.ti -1c
.RI "void \fBslotNeedProgressId\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.ti -1c
.RI "void \fBstoreSSLSessionFromJob\fP (const \fBKURL\fP &m_redirectionURL)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "Slave * \fBm_slave\fP"
.br
.ti -1c
.RI "\fBQByteArray\fP \fBm_packedArgs\fP"
.br
.ti -1c
.RI "\fBKURL\fP \fBm_url\fP"
.br
.ti -1c
.RI "\fBKURL\fP \fBm_subUrl\fP"
.br
.ti -1c
.RI "int \fBm_command\fP"
.br
.ti -1c
.RI "\fBKIO::filesize_t\fP \fBm_totalSize\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A simple job (one url and one command). 

This is the base class for all jobs that are scheduled. Other jobs are high-level jobs (\fBCopyJob\fP, \fBDeleteJob\fP, \fBFileCopyJob\fP...) that manage subjobs but aren't scheduled directly. 
.PP
Definition at line 487 of file jobclasses.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SimpleJob::SimpleJob (const \fBKURL\fP & url, int command, const \fBQByteArray\fP & packedArgs, bool showProgressInfo)"
.PP
Creates a new simple job. 
.PP
You don't need to use this constructor, unless you create a new job that inherits from \fBSimpleJob\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the url of the job 
.br
\fIcommand\fP the command of the job 
.br
\fIpackedArgs\fP the arguments 
.br
\fIshowProgressInfo\fP true to show progress information to the user
.RE
.PP

.PP
Definition at line 390 of file job.cpp.
.PP
References KIO::Scheduler::doJob(), QValueList::fromLast(), KURL::hasSubURL(), KURL::isValid(), KURL::join(), QValueList::remove(), QTimer::singleShot(), slotFinished(), KURL::split(), and KURL::url().
.SH "Member Function Documentation"
.PP 
.SS "const \fBKURL\fP& KIO::SimpleJob::url () const\fC [inline]\fP"
.PP
Returns the SimpleJob's URL. 
.PP
\fBReturns:\fP
.RS 4
the url
.RE
.PP

.PP
Definition at line 508 of file jobclasses.h.
.PP
Referenced by slotFinished().
.SS "void SimpleJob::kill (bool quietly = \fCtrue\fP)\fC [virtual]\fP"
.PP
Abort job. 
.PP
This kills all subjobs and deletes the job. 
.PP
\fBParameters:\fP
.RS 4
\fIquietly\fP if true, \fBJob\fP will emit signal result Should only be set to false when the user kills the job (from kio_uiserver), not when you want to abort a job. 
.RE
.PP

.PP
Reimplemented from \fBKIO::Job\fP.
.PP
Definition at line 417 of file job.cpp.
.PP
References KIO::Scheduler::cancelJob(), and KIO::Job::kill().
.PP
Referenced by putOnHold().
.SS "void SimpleJob::putOnHold ()\fC [virtual]\fP"
.PP
Abort job. 
.PP
Suspends slave to be reused by another job for the same request. 
.PP
Definition at line 424 of file job.cpp.
.PP
References kill(), and KIO::Scheduler::putSlaveOnHold().
.PP
Referenced by KRun::foundMimeType().
.SS "void SimpleJob::removeOnHold ()\fC [static]\fP"
.PP
Discard suspended slave. 
.PP
Definition at line 431 of file job.cpp.
.PP
References KIO::Scheduler::removeSlaveOnHold().
.SS "void SimpleJob::slotTotalSize (\fBKIO::filesize_t\fP data_size)\fC [slot]\fP"
.PP
Forward signal from the slave Can also be called by the parent job, when it knows the size. 
.PP
\fBParameters:\fP
.RS 4
\fIdata_size\fP the total size 
.RE
.PP

.PP
Definition at line 592 of file job.cpp.
.PP
References KIO::Job::totalSize().
.PP
Referenced by KIO::TransferJob::sendAsyncData(), and slotProcessedSize().
.SS "void SimpleJob::slotFinished ()\fC [protected, virtual, slot]\fP"
.PP
Called when the slave marks the job as finished. 
.PP
Reimplemented in \fBKIO::DavJob\fP, \fBKIO::StatJob\fP, \fBKIO::MkdirJob\fP, \fBKIO::TransferJob\fP, \fBKIO::MultiGetJob\fP, \fBKIO::MimetypeJob\fP, and \fBKIO::ListJob\fP.
.PP
Definition at line 522 of file job.cpp.
.PP
References KURL::directory(), KIO::Job::emitResult(), QPtrList::isEmpty(), KURL::setPath(), and url().
.PP
Referenced by SimpleJob(), KIO::ListJob::slotFinished(), KIO::TransferJob::slotFinished(), KIO::StatJob::slotFinished(), and KIO::MkdirJob::slotFinished().
.SS "void SimpleJob::slotInfoMessage (const \fBQString\fP & s)\fC [protected, slot]\fP"
.PP
Called on a slave's info message. 
.PP
\fBParameters:\fP
.RS 4
\fIs\fP the info message 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBinfoMessage()\fP 
.RE
.PP

.PP
Definition at line 575 of file job.cpp.
.PP
References KIO::Job::infoMessage().
.SS "void SimpleJob::slotConnected ()\fC [protected, slot]\fP"
.PP
Called on a slave's connected signal. 
.PP
\fBSee also:\fP
.RS 4
\fBconnected()\fP 
.RE
.PP

.PP
Definition at line 580 of file job.cpp.
.PP
References KIO::Job::connected().
.SS "void SimpleJob::slotProcessedSize (\fBKIO::filesize_t\fP data_size)\fC [protected, slot]\fP"
.PP
Forward signal from the slave. 
.PP
\fBParameters:\fP
.RS 4
\fIdata_size\fP the processed size in bytes 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBprocessedSize()\fP 
.RE
.PP

.PP
Definition at line 601 of file job.cpp.
.PP
References KIO::Job::emitPercent(), KIO::Job::processedSize(), KIO::Job::setProcessedSize(), and slotTotalSize().
.SS "void SimpleJob::slotSpeed (unsigned long bytes_per_second)\fC [protected, slot]\fP"
.PP
Forward signal from the slave. 
.PP
\fBParameters:\fP
.RS 4
\fIbytes_per_second\fP the speed in bytes/s 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBspeed()\fP 
.RE
.PP

.PP
Definition at line 612 of file job.cpp.
.PP
References KIO::Job::emitSpeed().
.SS "void SimpleJob::slotMetaData (const \fBKIO::MetaData\fP & _metaData)\fC [protected, virtual, slot]\fP"
.PP
\fBMetaData\fP from the slave is received. 
.PP
\fBParameters:\fP
.RS 4
\fI_metaData\fP the meta data 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBmetaData()\fP 
.RE
.PP

.PP
Reimplemented in \fBKIO::StatJob\fP, \fBKIO::TransferJob\fP, and \fBKIO::ListJob\fP.
.PP
Definition at line 618 of file job.cpp.
.PP
Referenced by KIO::ListJob::slotMetaData(), KIO::TransferJob::slotMetaData(), and KIO::StatJob::slotMetaData().

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