KIO::ListJob Class Reference

A ListJob is allows you to get the get the content of a directory. More...

#include <jobclasses.h>

Inheritance diagram for KIO::ListJob:

[legend]

List of all members.

Signals
void	entries (KIO::Job *job, const KIO::UDSEntryList &list)
void	permanentRedirection (KIO::Job *job, const KURL &fromUrl, const KURL &toUrl)
void	redirection (KIO::Job *job, const KURL &url)
Public Member Functions
	ListJob (const KURL &url, bool showProgressInfo, bool recursive=false, QString prefix=QString::null, bool includeHidden=true)
const KURL &	redirectionURL () const
void	setUnrestricted (bool unrestricted)
virtual void	start (Slave *slave)
Protected Slots
void	gotEntries (KIO::Job *subjob, const KIO::UDSEntryList &list)
virtual void	slotFinished ()
void	slotListEntries (const KIO::UDSEntryList &list)
virtual void	slotMetaData (const KIO::MetaData &_metaData)
void	slotRedirection (const KURL &url)
virtual void	slotResult (KIO::Job *job)
Protected Member Functions
virtual void	virtual_hook (int id, void *data)

---

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()

KIO::listDir()

Definition at line 1392 of file jobclasses.h.

---

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 '.')

Definition at line 1984 of file job.cpp.

---

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 ListJob::gotEntries	(	KIO::Job *	subjob,
		const KIO::UDSEntryList &	list
	)			[protected, slot]

Definition at line 2086 of file job.cpp.

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 1424 of file jobclasses.h.

void ListJob::setUnrestricted

(

bool

unrestricted

)

Do not apply any KIOSK restrictions to this job.

Since:

3.2

Definition at line 2164 of file job.cpp.

void ListJob::slotFinished

(

)

[protected, virtual, slot]

Called when the slave marks the job as finished.

Reimplemented from KIO::SimpleJob.

Definition at line 2112 of file job.cpp.

void ListJob::slotListEntries

(

const KIO::UDSEntryList &

list

)

[protected, slot]

Definition at line 1994 of file job.cpp.

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.

Definition at line 2147 of file job.cpp.

void ListJob::slotRedirection

(

const KURL &

url

)

[protected, slot]

Definition at line 2099 of file job.cpp.

void ListJob::slotResult

(

KIO::Job *

job

)

[protected, virtual, slot]

Called whenever a subjob finishes.

Default implementation checks for errors and propagates to parent job, then calls removeSubjob. Override if you don't want subjobs errors to be propagated.

Parameters:

job

the subjob

See also:

result()

Reimplemented from KIO::Job.

Definition at line 2092 of file job.cpp.

void ListJob::start

(

Slave *

slave

)

[virtual]

For internal use only.

Called by the scheduler when a slave gets to work on this job.

Parameters:

slave

the slave that starts working on this job

Reimplemented from KIO::SimpleJob.

Definition at line 2172 of file job.cpp.

void ListJob::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KIO::SimpleJob.

Definition at line 4767 of file job.cpp.

---

The documentation for this class was generated from the following files:

• jobclasses.h
• job.cpp