• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kio/kio
 

kio/kio

  • KIO
  • ListJob
Signals | Public Member Functions | Protected Slots | Protected Member Functions
KIO::ListJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::ListJob:
KIO::SimpleJob KIO::Job

List of all members.

Signals

void entries (KIO::Job *job, const KIO::UDSEntryList &list)
void redirection (KIO::Job *job, const KURL &url)
void permanentRedirection (KIO::Job *job, const KURL &fromUrl, const KURL &toUrl)

Public Member Functions

 ListJob (const KURL &url, bool showProgressInfo, bool recursive=false, TQString prefix=TQString::null, bool includeHidden=true)
virtual void start (Slave *slave)
const KURL & redirectionURL () const
void setUnrestricted (bool unrestricted)

Protected Slots

virtual void slotFinished ()
virtual void slotMetaData (const KIO::MetaData &_metaData)
virtual void slotResult (KIO::Job *job)
void slotListEntries (const KIO::UDSEntryList &list)
void slotRedirection (const KURL &url)
void gotEntries (KIO::Job *subjob, const KIO::UDSEntryList &list)

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,
TQString  prefix = TQString::null,
bool  includeHidden = true 
)

Do not create a ListJob directly.

Use KIO::listDir() or KIO::listRecursive() instead.

Parameters:
urlthe url of the directory
showProgressInfotrue to show progress information to the user
recursivetrue to get the data recursively from child directories, false to get only the content of the specified dir
prefixthe prefix of the files, or TQString::null for no prefix
includeHiddentrue 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:
jobthe job that emitted this signal
listthe 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:
jobthe job that emitted this signal
fromUrlthe original URL
toUrlthe 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:
jobthe job that is redirected
urlthe 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::slotMetaData ( const KIO::MetaData &  _metaData) [protected, virtual, slot]

MetaData from the slave is received.

Parameters:
_metaDatathe meta data
See also:
metaData()

Reimplemented from KIO::SimpleJob.

Definition at line 2147 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:
jobthe subjob
See also:
result()

Reimplemented from KIO::Job.

Definition at line 2092 of file job.cpp.


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

kio/kio

Skip menu "kio/kio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kio/kio

Skip menu "kio/kio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kio/kio by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |