.TH "KIO::ListJob" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::ListJob \- A \fBListJob\fP is allows you to get the get the content of a directory.  

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

.in +1c
.ti -1c
.RI "void \fBentries\fP (\fBKIO::Job\fP *job, const \fBKIO::UDSEntryList\fP &list)"
.br
.ti -1c
.RI "void \fBredirection\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &url)"
.br
.ti -1c
.RI "void \fBpermanentRedirection\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &fromUrl, const \fBKURL\fP &toUrl)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBListJob\fP (const \fBKURL\fP &url, bool showProgressInfo, bool recursive=false, \fBQString\fP prefix=QString::null, bool includeHidden=true)"
.br
.ti -1c
.RI "virtual void \fBstart\fP (Slave *slave)"
.br
.ti -1c
.RI "const \fBKURL\fP & \fBredirectionURL\fP () const "
.br
.ti -1c
.RI "void \fBsetUnrestricted\fP (bool unrestricted)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "virtual void \fBslotFinished\fP ()"
.br
.ti -1c
.RI "virtual void \fBslotMetaData\fP (const \fBKIO::MetaData\fP &_metaData)"
.br
.ti -1c
.RI "virtual void \fBslotResult\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBslotListEntries\fP (const \fBKIO::UDSEntryList\fP &list)"
.br
.ti -1c
.RI "void \fBslotRedirection\fP (const \fBKURL\fP &url)"
.br
.ti -1c
.RI "void \fBgotEntries\fP (\fBKIO::Job\fP *subjob, const \fBKIO::UDSEntryList\fP &list)"
.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 \fBListJob\fP is allows you to get the get the content of a directory. 

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

.PP
Definition at line 1329 of file jobclasses.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "ListJob::ListJob (const \fBKURL\fP & url, bool showProgressInfo, bool recursive = \fCfalse\fP, \fBQString\fP prefix = \fCQString::null\fP, bool includeHidden = \fCtrue\fP)"
.PP
Do not create a \fBListJob\fP directly. 
.PP
Use \fBKIO::listDir()\fP or \fBKIO::listRecursive()\fP instead. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the url of the directory 
.br
\fIshowProgressInfo\fP true to show progress information to the user 
.br
\fIrecursive\fP true to get the data recursively from child directories, false to get only the content of the specified dir 
.br
\fIprefix\fP the prefix of the files, or QString::null for no prefix 
.br
\fIincludeHidden\fP true to include hidden files (those starting with '.')
.RE
.PP

.PP
Definition at line 1905 of file job.cpp.
.SH "Member Function Documentation"
.PP 
.SS "const \fBKURL\fP& KIO::ListJob::redirectionURL () const\fC [inline]\fP"
.PP
Returns the ListJob's redirection URL. 
.PP
This will be invalid if there was no redirection. 
.PP
\fBReturns:\fP
.RS 4
the redirection url 
.RE
.PP
\fBSince:\fP
.RS 4
3.4.1 
.RE
.PP

.PP
Definition at line 1361 of file jobclasses.h.
.SS "void ListJob::setUnrestricted (bool unrestricted)"
.PP
Do not apply any KIOSK restrictions to this job. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 2085 of file job.cpp.
.PP
Referenced by KIO::DeleteJob::slotResult().
.SS "void KIO::ListJob::entries (\fBKIO::Job\fP * job, const \fBKIO::UDSEntryList\fP & list)\fC [signal]\fP"
.PP
This signal emits the entry found by the job while listing. 
.PP
The progress signals aren't specific to \fBListJob\fP. It simply uses SimpleJob's processedSize (number of entries listed) and totalSize (total number of entries, if known), as well as percent. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIlist\fP the list of UDSEntries 
.RE
.PP

.SS "void KIO::ListJob::redirection (\fBKIO::Job\fP * job, const \fBKURL\fP & url)\fC [signal]\fP"
.PP
Signals a redirection. 
.PP
Use to update the URL shown to the user. The redirection itself is handled internally. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that is redirected 
.br
\fIurl\fP the new url 
.RE
.PP

.PP
Referenced by slotFinished().
.SS "void KIO::ListJob::permanentRedirection (\fBKIO::Job\fP * job, const \fBKURL\fP & fromUrl, const \fBKURL\fP & toUrl)\fC [signal]\fP"
.PP
Signals a permanent redirection. 
.PP
The redirection itself is handled internally. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfromUrl\fP the original URL 
.br
\fItoUrl\fP the new URL 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Referenced by slotFinished().
.SS "void ListJob::slotFinished ()\fC [protected, virtual, slot]\fP"
.PP
Called when the slave marks the job as finished. 
.PP
Reimplemented from \fBKIO::SimpleJob\fP.
.PP
Definition at line 2033 of file job.cpp.
.PP
References KIO::Scheduler::doJob(), KMimeType::findByURL(), KURL::isEmpty(), QString::isEmpty(), KURL::isLocalFile(), KURL::isValid(), permanentRedirection(), KIO::Job::queryMetaData(), redirection(), KURL::setProtocol(), and KIO::SimpleJob::slotFinished().
.SS "void ListJob::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 from \fBKIO::SimpleJob\fP.
.PP
Definition at line 2068 of file job.cpp.
.PP
References KIO::SimpleJob::slotMetaData().
.SS "void ListJob::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 2013 of file job.cpp.
.PP
References KIO::Job::removeSubjob().

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