KIO::ListJob Class Reference
#include <jobclasses.h>
Inheritance diagram for KIO::ListJob:

Detailed Description
A ListJob is allows you to get the get the content of a directory.Don't create the job directly, but use KIO::listRecursive() or KIO::listDir() instead.
- See also:
- KIO::listRecursive()
Definition at line 1367 of file jobclasses.h.
Signals | |
void | entries (KIO::Job *job, const KIO::UDSEntryList &list) |
void | redirection (KIO::Job *job, const KURL &url) |
void | permanentRedirection (KIO::Job *job, const KURL &fromUrl, const KURL &toUrl) |
Public Member Functions | |
ListJob (const KURL &url, bool showProgressInfo, bool recursive=false, QString prefix=QString::null, bool includeHidden=true) | |
virtual void | start (Slave *slave) |
const KURL & | redirectionURL () const |
void | setUnrestricted (bool unrestricted) |
Protected Slots | |
virtual void | slotFinished () |
virtual void | slotMetaData (const KIO::MetaData &_metaData) |
virtual void | slotResult (KIO::Job *job) |
void | slotListEntries (const KIO::UDSEntryList &list) |
void | slotRedirection (const KURL &url) |
void | gotEntries (KIO::Job *subjob, const KIO::UDSEntryList &list) |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Constructor & Destructor Documentation
ListJob::ListJob | ( | const KURL & | url, | |
bool | showProgressInfo, | |||
bool | recursive = false , |
|||
QString | prefix = QString::null , |
|||
bool | includeHidden = true | |||
) |
Do not create a ListJob directly.
Use KIO::listDir() or KIO::listRecursive() instead.
- Parameters:
-
url the url of the directory showProgressInfo true to show progress information to the user recursive true to get the data recursively from child directories, false to get only the content of the specified dir prefix the prefix of the files, or QString::null for no prefix includeHidden true to include hidden files (those starting with '.')
Member Function Documentation
void KIO::ListJob::entries | ( | KIO::Job * | job, | |
const KIO::UDSEntryList & | list | |||
) | [signal] |
This signal emits the entry found by the job while listing.
The progress signals aren't specific to ListJob. It simply uses SimpleJob's processedSize (number of entries listed) and totalSize (total number of entries, if known), as well as percent.
- Parameters:
-
job the job that emitted this signal list the list of UDSEntries
void KIO::ListJob::permanentRedirection | ( | KIO::Job * | job, | |
const KURL & | fromUrl, | |||
const KURL & | toUrl | |||
) | [signal] |
Signals a permanent redirection.
The redirection itself is handled internally.
- Parameters:
-
job the job that emitted this signal fromUrl the original URL toUrl the new URL
- Since:
- 3.1
void KIO::ListJob::redirection | ( | KIO::Job * | job, | |
const KURL & | url | |||
) | [signal] |
Signals a redirection.
Use to update the URL shown to the user. The redirection itself is handled internally.
- Parameters:
-
job the job that is redirected url the new url
const KURL& KIO::ListJob::redirectionURL | ( | ) | const [inline] |
Returns the ListJob's redirection URL.
This will be invalid if there was no redirection.
- Returns:
- the redirection url
- Since:
- 3.4.1
Definition at line 1399 of file jobclasses.h.
void ListJob::setUnrestricted | ( | bool | unrestricted | ) |
void ListJob::slotFinished | ( | ) | [protected, virtual, slot] |
void ListJob::slotMetaData | ( | const KIO::MetaData & | _metaData | ) | [protected, virtual, slot] |
MetaData from the slave is received.
- Parameters:
-
_metaData the meta data
- See also:
- metaData()
Reimplemented from KIO::SimpleJob.
void ListJob::slotResult | ( | KIO::Job * | job | ) | [protected, virtual, slot] |
The documentation for this class was generated from the following files: