• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KIO::ListJob

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:

Inheritance graph
[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

const KUrl & redirectionUrl () const
void setUnrestricted (bool unrestricted)
 ~ListJob ()

Protected Slots

virtual void slotFinished ()
virtual void slotMetaData (const KIO::MetaData &_metaData)
virtual void slotResult (KJob *job)

Protected Member Functions

 ListJob (ListJobPrivate &dd)

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


Constructor & Destructor Documentation

ListJob::~ListJob (  ) 

Definition at line 2287 of file job.cpp.

ListJob::ListJob ( ListJobPrivate &  dd  )  [protected]

Definition at line 2277 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 2481 of file job.cpp.

void ListJob::setUnrestricted ( bool  unrestricted  ) 

Do not apply any KIOSK restrictions to this job.

Definition at line 2451 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 2398 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 2434 of file job.cpp.

void ListJob::slotResult ( KJob *  job  )  [protected, virtual, slot]

Definition at line 2375 of file job.cpp.


The documentation for this class was generated from the following files:
  • jobclasses.h
  • job.cpp

KIO

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal