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

tdeio/tdeio

TDEIO::ListJob

TDEIO::ListJob Class Reference

A ListJob is allows you to get the get the content of a directory. More...

#include <jobclasses.h>

Inheritance diagram for TDEIO::ListJob:
TDEIO::SimpleJob TDEIO::Job TQObject

List of all members.

Signals

void entries (TDEIO::Job *job, const TDEIO::UDSEntryList &list)
void redirection (TDEIO::Job *job, const KURL &url)
void permanentRedirection (TDEIO::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 TDEIO::MetaData &_metaData)
virtual void slotResult (TDEIO::Job *job)
void slotListEntries (const TDEIO::UDSEntryList &list)
void slotRedirection (const KURL &url)
void gotEntries (TDEIO::Job *subjob, const TDEIO::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 TDEIO::listRecursive() or TDEIO::listDir() instead.

See also:
TDEIO::listRecursive()
TDEIO::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 TDEIO::listDir() or TDEIO::listRecursive() instead.

Parameters:
url the url of the directory
showProgressInfo true to show progress information to the user
recursive true to get the data recursively from child directories, false to get only the content of the specified dir
prefix the prefix of the files, or TQString::null for no prefix
includeHidden true to include hidden files (those starting with '.')

Definition at line 2019 of file job.cpp.


Member Function Documentation

void TDEIO::ListJob::entries ( TDEIO::Job *  job,
const TDEIO::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 TDEIO::ListJob::permanentRedirection ( TDEIO::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
Since:
3.1
void TDEIO::ListJob::redirection ( TDEIO::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& TDEIO::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 2199 of file job.cpp.

void ListJob::slotFinished (  )  [protected, virtual, slot]

Called when the slave marks the job as finished.

Reimplemented from TDEIO::SimpleJob.

Definition at line 2147 of file job.cpp.

void ListJob::slotMetaData ( const TDEIO::MetaData &  _metaData  )  [protected, virtual, slot]

MetaData from the slave is received.

Parameters:
_metaData the meta data
See also:
metaData()

Reimplemented from TDEIO::SimpleJob.

Definition at line 2182 of file job.cpp.

void ListJob::slotResult ( TDEIO::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:
job the subjob
See also:
result()

Reimplemented from TDEIO::Job.

Definition at line 2127 of file job.cpp.


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

tdeio/tdeio

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

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeio/tdeio by doxygen 1.6.3
This website is maintained by Timothy Pearson.