.TH "KIO::SimpleJob" 3 "28 Jan 2004" "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::ListJob, KIO::StatJob, and \fBKIO::TransferJob\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBslotTotalSize\fP (KIO::filesize_t data_size)"
.br
.RI "\fIForward signal from the slave Can also be called by the parent job, when it knows the size. \fP"
.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
.RI "\fIAbort job. \fP"
.ti -1c
.RI "virtual void \fBputOnHold\fP ()"
.br
.RI "\fIAbort job. \fP"
.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 "void \fBremoveOnHold\fP ()"
.br
.RI "\fIDiscard suspended slave. \fP"
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "virtual void \fBslotFinished\fP ()"
.br
.RI "\fICalled when the slave marks the job as finished. \fP"
.ti -1c
.RI "void \fBslotWarning\fP (const  \fBQString\fP &)"
.br
.ti -1c
.RI "void \fBslotInfoMessage\fP (const  \fBQString\fP &)"
.br
.RI "\fICalled on a slave's info message. \fP"
.ti -1c
.RI "void \fBslotConnected\fP ()"
.br
.RI "\fICalled on a slave's connected signal. \fP"
.ti -1c
.RI "void \fBslotProcessedSize\fP (KIO::filesize_t data_size)"
.br
.RI "\fIForward signal from the slave. \fP"
.ti -1c
.RI "void \fBslotSpeed\fP (unsigned long bytes_per_second)"
.br
.RI "\fIForward signal from the slave. \fP"
.ti -1c
.RI "virtual void \fBslotMetaData\fP (const  KIO::MetaData &_metaData)"
.br
.RI "\fIMetaData from the slave is received. \fP"
.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
.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 "KIO::filesize_t \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 (CopyJob, \fBDeleteJob\fP, \fBFileCopyJob\fP...) that manage subjobs but aren't scheduled directly. 
.PP
Definition at line 364 of file jobclasses.h.
.SH "Member Function Documentation"
.PP 
.SS "void SimpleJob::kill (bool quietly = true)\fC [virtual]\fP"
.PP
Abort job. This kills all subjobs and deletes the job. 
.PP
\fBParameters:\fP
.RS 4
\fIquietly\fP if true, \fBJob\fP will emit signal \fBresult\fP 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
Reimplemented from \fBKIO::Job\fP.
.PP
Definition at line 380 of file job.cpp.
.PP
Referenced by putOnHold().
.SS "void SimpleJob::putOnHold ()\fC [virtual]\fP"
.PP
Abort job. Suspends slave to be reused by another job for the same request. Definition at line 387 of file job.cpp.
.PP
References kill().
.PP
Referenced by KRun::foundMimeType().
.SS "void SimpleJob::removeOnHold ()\fC [static]\fP"
.PP
Discard suspended slave. Definition at line 394 of file job.cpp.
.SS "void SimpleJob::slotTotalSize (KIO::filesize_t data_size)\fC [slot]\fP"
.PP
Forward signal from the slave Can also be called by the parent job, when it knows the size. Definition at line 542 of file job.cpp.
.PP
References KIO::Job::totalSize().
.PP
Referenced by slotProcessedSize().
.SS "void SimpleJob::slotFinished ()\fC [protected, virtual, slot]\fP"
.PP
Called when the slave marks the job as finished. Reimplemented in \fBKIO::DavJob\fP, and \fBKIO::TransferJob\fP.
.PP
Definition at line 476 of file job.cpp.
.PP
References KURL::directory(), KIO::Job::emitResult(), QPtrList< Job >::isEmpty(), and KURL::setPath().
.SS "void SimpleJob::slotInfoMessage (const \fBQString\fP &)\fC [protected, slot]\fP"
.PP
Called on a slave's info message. Definition at line 525 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. Definition at line 530 of file job.cpp.
.PP
References KIO::Job::connected().
.SS "void SimpleJob::slotProcessedSize (KIO::filesize_t data_size)\fC [protected, slot]\fP"
.PP
Forward signal from the slave. Definition at line 548 of file job.cpp.
.PP
References KIO::Job::emitPercent(), KIO::Job::processedSize(), and slotTotalSize().
.SS "void SimpleJob::slotSpeed (unsigned long bytes_per_second)\fC [protected, slot]\fP"
.PP
Forward signal from the slave. Definition at line 558 of file job.cpp.
.PP
References KIO::Job::emitSpeed().
.SS "void SimpleJob::slotMetaData (const KIO::MetaData & _metaData)\fC [protected, virtual, slot]\fP"
.PP
MetaData from the slave is received. Definition at line 564 of file job.cpp.

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