KIO::ListJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::ListJob:

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)
void	subError (KIO::ListJob *job, KIO::ListJob *subJob)
Signals inherited from KIO::Job
void	canceled (KJob *job)
void	connected (KIO::Job *job)
Signals inherited from KCompositeJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=qMakePair(QString(), QString()), const QPair< QString, QString > &field2=qMakePair(QString(), QString()))
void	finished (KJob *job)
void	infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
void	percent (KJob *job, unsigned long percent)
void	processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
void	processedSize (KJob *job, qulonglong size)
void	result (KJob *job)
void	resumed (KJob *job)
void	speed (KJob *job, unsigned long speed)
void	suspended (KJob *job)
void	totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
void	totalSize (KJob *job, qulonglong size)
void	warning (KJob *job, const QString &plain, const QString &rich=QString())

Public Member Functions
	~ListJob ()
const KUrl &	redirectionUrl () const
void	setUnrestricted (bool unrestricted)
Public Member Functions inherited from KIO::SimpleJob
	~SimpleJob ()
bool	isRedirectionHandlingEnabled () const
virtual void	putOnHold ()
void	setRedirectionHandlingEnabled (bool handle)
const KUrl &	url () const
Public Member Functions inherited from KIO::Job
virtual	~Job ()
void	addMetaData (const QString &key, const QString &value)
void	addMetaData (const QMap< QString, QString > &values)
QStringList	detailedErrorStrings (const KUrl *reqUrl=0L, int method=-1) const
QString	errorString () const
bool	isInteractive () const
void	mergeMetaData (const QMap< QString, QString > &values)
MetaData	metaData () const
MetaData	outgoingMetaData () const
Job *	parentJob () const
QString	queryMetaData (const QString &key)
void	setMetaData (const KIO::MetaData &metaData)
void	setParentJob (Job *parentJob)
void	showErrorDialog (QWidget *parent=0)
void	start ()
JobUiDelegate *	ui () const
Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=0)
virtual	~KCompositeJob ()
virtual	~KJob ()
Capabilities	capabilities () const
int	error () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isSuspended () const
	KJob (QObject *parent=0)
unsigned long	percent () const
qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setUiDelegate (KJobUiDelegate *delegate)
qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () const

Protected Slots
virtual void	slotFinished ()
virtual void	slotMetaData (const KIO::MetaData &_metaData)
virtual void	slotResult (KJob *job)
Protected Slots inherited from KIO::SimpleJob
virtual void	slotFinished ()
virtual void	slotMetaData (const KIO::MetaData &_metaData)
virtual void	slotWarning (const QString &)
Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
virtual void	slotResult (KJob *job)

Protected Member Functions
	ListJob (ListJobPrivate &dd)
Protected Member Functions inherited from KIO::SimpleJob
	SimpleJob (SimpleJobPrivate &dd)
virtual bool	doKill ()
virtual bool	doResume ()
virtual bool	doSuspend ()
void	storeSSLSessionFromJob (const KUrl &m_redirectionURL)
Protected Member Functions inherited from KIO::Job
	Job ()
	Job (JobPrivate &dd)
virtual bool	addSubjob (KJob *job)
virtual bool	removeSubjob (KJob *job)
Protected Member Functions inherited from KCompositeJob
	KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
void	clearSubjobs ()
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void	emitResult ()
void	emitSpeed (unsigned long speed)
bool	hasSubjobs ()
	KJob (KJobPrivate &dd, QObject *parent)
void	setCapabilities (Capabilities capabilities)
void	setError (int errorCode)
void	setErrorText (const QString &errorText)
void	setPercent (unsigned long percentage)
void	setProcessedAmount (Unit unit, qulonglong amount)
void	setTotalAmount (Unit unit, qulonglong amount)
const QList< KJob * > &	subjobs () const

Additional Inherited Members
Public Types inherited from KCompositeJob
enum	Capability
enum	KillVerbosity
enum	Unit
Public Slots inherited from KIO::SimpleJob
void	slotError (int, const QString &)
Public Slots inherited from KCompositeJob
bool	kill (KillVerbosity verbosity=Quietly)
bool	resume ()
bool	suspend ()
Static Public Member Functions inherited from KIO::SimpleJob
static void	removeOnHold ()
Protected Attributes inherited from KCompositeJob
KJobPrivate *const	d_ptr

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

Constructor & Destructor Documentation

ListJob::~ListJob

(

)

Definition at line 2572 of file job.cpp.

ListJob::ListJob ( ListJobPrivate &  dd )

protected

Definition at line 2562 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 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

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 & ListJob::redirectionUrl

(

)

const

Returns the ListJob's redirection URL.

This will be invalid if there was no redirection.

Returns

the redirection url

Definition at line 2779 of file job.cpp.

void ListJob::setUnrestricted

(

bool

unrestricted

)

Do not apply any KIOSK restrictions to this job.

Definition at line 2749 of file job.cpp.

void ListJob::slotFinished ( )

protectedvirtualslot

Definition at line 2694 of file job.cpp.

void ListJob::slotMetaData ( const KIO::MetaData &  _metaData )

protectedvirtualslot

Definition at line 2732 of file job.cpp.

void ListJob::slotResult ( KJob *  job )

protectedvirtualslot

Definition at line 2668 of file job.cpp.

void KIO::ListJob::subError ( KIO::ListJob *  job, KIO::ListJob *  subJob  )

signal

This signal is emitted when a sub-directory could not be listed.

The job keeps going, thus doesn't result in an overall error.

Parameters

job	the job that emitted the signal
subJob	the job listing a sub-directory, which failed. Use url(), error() and errorText() on that job to find out more.

---

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

• jobclasses.h
• job.cpp