• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KIO

  • KIO
  • ListJob
Signals | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KIO::ListJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::ListJob:
KIO::SimpleJob KIO::Job KCompositeJob KJob QObject

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 KJob
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 QMap< QString, QString > &values)
void addMetaData (const QString &key, const QString &value)
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 ()
Public Member Functions inherited from KJob
 KJob (QObject *parent=0)
virtual ~KJob ()
Capabilities capabilities () const
int error () const
QString errorText () const
bool exec ()
bool isAutoDelete () const
bool isSuspended () const
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 ()
bool hasSubjobs ()
const QList< KJob * > & subjobs () const
Protected Member Functions inherited from KJob
 KJob (KJobPrivate &dd, QObject *parent)
void emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void emitResult ()
void emitSpeed (unsigned long speed)
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)

Additional Inherited Members

Public Types inherited from KJob
enum  Capability
enum  KillVerbosity
enum  Unit
Public Slots inherited from KIO::SimpleJob
void slotError (int, const QString &)
Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=Quietly)
bool resume ()
bool suspend ()
Static Public Member Functions inherited from KIO::SimpleJob
static void removeOnHold ()
Public Attributes inherited from KJob
 Bytes
 Directories
 EmitResult
 Files
 Killable
 KilledJobError
 NoCapabilities
 NoError
 Quietly
 Suspendable
 UserDefinedError
Protected Attributes inherited from KJob
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::~ListJob ( )

Definition at line 2557 of file job.cpp.

◆ ListJob()

ListJob::ListJob ( ListJobPrivate & dd)
protected

Definition at line 2547 of file job.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
jobthe job that emitted this signal
listthe list of UDSEntries

◆ permanentRedirection

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
jobthe job that emitted this signal
fromUrlthe original URL
toUrlthe new URL

◆ redirection

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
jobthe job that is redirected
urlthe new url

◆ redirectionUrl()

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 2775 of file job.cpp.

◆ setUnrestricted()

void ListJob::setUnrestricted ( bool unrestricted)

Do not apply any KIOSK restrictions to this job.

Definition at line 2745 of file job.cpp.

◆ slotFinished

void ListJob::slotFinished ( )
protectedvirtualslot

Definition at line 2690 of file job.cpp.

◆ slotMetaData

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

Definition at line 2728 of file job.cpp.

◆ slotResult

void ListJob::slotResult ( KJob * job)
protectedvirtualslot

Definition at line 2662 of file job.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
jobthe job that emitted the signal
subJobthe 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Tue Mar 25 2025 00:00:00 by doxygen 1.14.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal