.TH "KIO::DeleteJob" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::DeleteJob \- A more complex \fBJob\fP to delete files and directories.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <jobclasses.h>\fP
.PP
Inherits \fBKIO::Job\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBtotalFiles\fP (\fBKIO::Job\fP *job, unsigned long files)"
.br
.ti -1c
.RI "void \fBtotalDirs\fP (\fBKIO::Job\fP *job, unsigned long dirs)"
.br
.ti -1c
.RI "void \fBprocessedFiles\fP (\fBKIO::Job\fP *job, unsigned long files)"
.br
.ti -1c
.RI "void \fBprocessedDirs\fP (\fBKIO::Job\fP *job, unsigned long dirs)"
.br
.ti -1c
.RI "void \fBdeleting\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &file)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBDeleteJob\fP (const \fBKURL::List\fP &src, bool shred, bool showProgressInfo)"
.br
.ti -1c
.RI "\fBKURL::List\fP \fBurls\fP () const "
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotStart\fP ()"
.br
.ti -1c
.RI "void \fBslotEntries\fP (\fBKIO::Job\fP *, const \fBKIO::UDSEntryList\fP &list)"
.br
.ti -1c
.RI "virtual void \fBslotResult\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBslotProcessedSize\fP (\fBKIO::Job\fP *, \fBKIO::filesize_t\fP data_size)"
.br
.ti -1c
.RI "void \fBslotReport\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
.SH "Detailed Description"
.PP 
A more complex \fBJob\fP to delete files and directories. 

Don't create the job directly, but use \fBKIO::del()\fP instead.
.PP
\fBSee also:\fP
.RS 4
\fBKIO::del()\fP 
.RE
.PP

.PP
Definition at line 1698 of file jobclasses.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "DeleteJob::DeleteJob (const \fBKURL::List\fP & src, bool shred, bool showProgressInfo)"
.PP
Do not create a \fBDeleteJob\fP directly. 
.PP
Use \fBKIO::del()\fP instead.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the list of URLs to delete 
.br
\fIshred\fP true to shred (make sure that data is not recoverable)a 
.br
\fIshowProgressInfo\fP true to show progress information to the user 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKIO::del()\fP
.RE
.PP

.PP
Definition at line 3783 of file job.cpp.
.PP
References QObject::connect(), QTimer::singleShot(), QTimer::start(), totalDirs(), and totalFiles().
.SH "Member Function Documentation"
.PP 
.SS "\fBKURL::List\fP KIO::DeleteJob::urls () const\fC [inline]\fP"
.PP
Returns the list of URLs. 
.PP
\fBReturns:\fP
.RS 4
the list of URLs.
.RE
.PP

.PP
Definition at line 1717 of file jobclasses.h.
.SS "void KIO::DeleteJob::totalFiles (\fBKIO::Job\fP * job, unsigned long files)\fC [signal]\fP"
.PP
Emitted when the total number of files is known. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfiles\fP the total number of files
.RE
.PP

.PP
Referenced by DeleteJob().
.SS "void KIO::DeleteJob::totalDirs (\fBKIO::Job\fP * job, unsigned long dirs)\fC [signal]\fP"
.PP
Emitted when the toal number of direcotries is known. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIdirs\fP the total number of directories
.RE
.PP

.PP
Referenced by DeleteJob().
.SS "void KIO::DeleteJob::processedFiles (\fBKIO::Job\fP * job, unsigned long files)\fC [signal]\fP"
.PP
Sends the number of processed files. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfiles\fP the number of processed files
.RE
.PP

.SS "void KIO::DeleteJob::processedDirs (\fBKIO::Job\fP * job, unsigned long dirs)\fC [signal]\fP"
.PP
Sends the number of processed directories. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIdirs\fP the number of processed dirs
.RE
.PP

.SS "void KIO::DeleteJob::deleting (\fBKIO::Job\fP * job, const \fBKURL\fP & file)\fC [signal]\fP"
.PP
Sends the URL of the file that is currently being deleted. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfile\fP the URL of the file or directory that is being deleted
.RE
.PP

.SS "void DeleteJob::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 from \fBKIO::Job\fP.
.PP
Definition at line 4077 of file job.cpp.
.PP
References KIO::Job::addSubjob(), QValueList::append(), QValueList::begin(), QObject::connect(), KURL::directory(), QValueList::end(), KIO::Job::error(), QPtrList::isEmpty(), KURL::isLocalFile(), KIO::listRecursive(), KURL::path(), QPtrList::remove(), KIO::Scheduler::scheduleJob(), KIO::ListJob::setUnrestricted(), KIO::Job::slotResult(), KIO::UDS_FILE_TYPE, KIO::UDS_LINK_DEST, and KIO::UDS_SIZE.
.SS "void DeleteJob::slotProcessedSize (\fBKIO::Job\fP *, \fBKIO::filesize_t\fP data_size)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
Definition at line 4048 of file job.cpp.
.PP
References KIO::Job::percent(), KIO::Job::processedSize(), and KIO::Job::setProcessedSize().

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