KIO::ListJob

#include <KIO/ListJob>

Inheritance diagram for KIO::ListJob:

[legend]

Public Types
enum class	ListFlag { IncludeHidden = 1 << 0 }

typedef QFlags< ListFlag >	ListFlags

Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities

enum	Capability

enum	Unit

Public Types inherited from QObject
typedef	QObjectList

Signals
void	entries (KIO::Job *job, const KIO::UDSEntryList &list)

void	permanentRedirection (KIO::Job *job, const QUrl &fromUrl, const QUrl &toUrl)

void	redirection (KIO::Job *job, const QUrl &url)

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

Signals inherited from KIO::Job
void	connected (KIO::Job *job)

Signals inherited from KJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >())

void	finished (KJob *job)

void	infoMessage (KJob *job, const QString &message)

void	percentChanged (KJob *job, unsigned long percent)

void	processedAmountChanged (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	totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)

void	totalSize (KJob *job, qulonglong size)

void	warning (KJob *job, const QString &message)

Public Member Functions
const QUrl &	redirectionUrl () const

void	setUnrestricted (bool unrestricted)

Public Member Functions inherited from KIO::SimpleJob
bool	isRedirectionHandlingEnabled () const

virtual void	putOnHold ()

void	setRedirectionHandlingEnabled (bool handle)

const QUrl &	url () const

Public Member Functions inherited from KIO::Job
void	addMetaData (const QMap< QString, QString > &values)

void	addMetaData (const QString &key, const QString &value)

QStringList	detailedErrorStrings (const QUrl *reqUrl=nullptr, int method=-1) const

QString	errorString () const override

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	setUiDelegateExtension (JobUiDelegateExtension *extension)

void	start () override

JobUiDelegateExtension *	uiDelegateExtension () const

Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=nullptr)

Public Member Functions inherited from KJob
	KJob (QObject *parent=nullptr)

Capabilities	capabilities () const

qint64	elapsedTime () const

int	error () const

QString	errorText () const

bool	exec ()

bool	isAutoDelete () const

bool	isFinishedNotificationHidden () const

bool	isStartedWithExec () const

bool	isSuspended () const

unsigned long	percent () const

Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const

void	setAutoDelete (bool autodelete)

void	setFinishedNotificationHidden (bool hide=true)

void	setUiDelegate (KJobUiDelegate *delegate)

Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const

KJobUiDelegate *	uiDelegate () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Protected Slots
void	slotFinished () override

void	slotResult (KJob *job) override

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 &message)

virtual void	slotResult (KJob *job)

Protected Member Functions
KIOCORE_NO_EXPORT	ListJob (ListJobPrivate &dd)

Protected Member Functions inherited from KIO::SimpleJob
KIOCORE_NO_EXPORT	SimpleJob (SimpleJobPrivate &dd)

bool	doKill () override

bool	doResume () override

bool	doSuspend () override

Protected Member Functions inherited from KIO::Job
	Job (JobPrivate &dd)

bool	addSubjob (KJob *job) override

bool	removeSubjob (KJob *job) override

Protected Member Functions inherited from KCompositeJob
void	clearSubjobs ()

bool	hasSubjobs () const

const QList< KJob * > &	subjobs () const

Protected Member Functions inherited from KJob
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)

void	emitResult ()

void	emitSpeed (unsigned long speed)

bool	isFinished () const

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	setProgressUnit (Unit unit)

void	setTotalAmount (Unit unit, qulonglong amount)

void	startElapsedTimer ()

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Properties inherited from QObject
	objectName

Public Slots inherited from KIO::SimpleJob
void	slotError (int, const QString &)

Public Slots inherited from KJob
bool	kill (KJob::KillVerbosity verbosity=KJob::Quietly)

bool	resume ()

bool	suspend ()

Static Public Member Functions inherited from KIO::SimpleJob
static void	removeOnHold ()

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from KJob
	Bytes

	Directories

	Files

	Items

	Killable

	NoCapabilities

	Suspendable

	UnitsCount

Protected Attributes inherited from KIO::Job
JobPrivate *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()

Member Typedef Documentation

◆ ListFlags

QFlags< ListFlag > KIO::ListJob::ListFlags

Definition at line 37 of file listjob.h.

Member Enumeration Documentation

◆ ListFlag

enum class KIO::ListJob::ListFlag

strong

Enumerator
IncludeHidden	Include hidden files in the listing.

Definition at line 34 of file listjob.h.

Constructor & Destructor Documentation

◆ ~ListJob()

ListJob::~ListJob ( )

override

Definition at line 80 of file listjob.cpp.

◆ ListJob()

ListJob::ListJob ( ListJobPrivate & dd )

explicitprotected

Definition at line 70 of file listjob.cpp.

Member Function Documentation

◆ entries

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

◆ permanentRedirection

void KIO::ListJob::permanentRedirection	(	KIO::Job *	job,
		const QUrl &	fromUrl,
		const QUrl &	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

◆ redirection

void KIO::ListJob::redirection	(	KIO::Job *	job,
		const QUrl &	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

◆ redirectionUrl()

const QUrl & 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 283 of file listjob.cpp.

◆ setUnrestricted()

void ListJob::setUnrestricted ( bool unrestricted )

Do not apply any KIOSK restrictions to this job.

Definition at line 249 of file listjob.cpp.

◆ slotFinished

void ListJob::slotFinished ( )

overrideprotectedslot

Definition at line 215 of file listjob.cpp.

◆ slotResult

void ListJob::slotResult ( KJob * job )

overrideprotectedslot

Definition at line 188 of file listjob.cpp.

◆ subError

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:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KIO

KIO::ListJob

Public Types

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ListFlags

Member Enumeration Documentation

◆ ListFlag

Constructor & Destructor Documentation

◆ ~ListJob()

◆ ListJob()

Member Function Documentation

◆ entries

◆ permanentRedirection

◆ redirection

◆ redirectionUrl()

◆ setUnrestricted()

◆ slotFinished

◆ slotResult

◆ subError