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

tdeio/tdeio

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

#include <jobclasses.h>

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

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)
 
- Signals inherited from TDEIO::Job
void result (TDEIO::Job *job)
 
void canceled (TDEIO::Job *job)
 
void infoMessage (TDEIO::Job *job, const TQString &msg)
 
void warning (TDEIO::Job *job, const TQString &msg)
 
void connected (TDEIO::Job *job)
 
void percent (TDEIO::Job *job, unsigned long percent)
 
void totalSize (TDEIO::Job *job, TDEIO::filesize_t size)
 
void processedSize (TDEIO::Job *job, TDEIO::filesize_t size)
 
void speed (TDEIO::Job *job, unsigned long speed)
 

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)
 
- Public Member Functions inherited from TDEIO::SimpleJob
 SimpleJob (const KURL &url, int command, const TQByteArray &packedArgs, bool showProgressInfo)
 
const KURL & url () const
 
virtual void kill (bool quietly=true)
 
virtual void putOnHold ()
 
void slaveDone ()
 
Slave * slave () const
 
int command () const
 
- Public Member Functions inherited from TDEIO::Job
int error () const
 
int progressId () const
 
const TQString & errorText () const
 
TQString errorString () const
 
TQStringList detailedErrorStrings (const KURL *reqUrl=0L, int method=-1) const
 
void showErrorDialog (TQWidget *parent=0L)
 
void setAutoErrorHandlingEnabled (bool enable, TQWidget *parentWidget=0)
 
bool isAutoErrorHandlingEnabled () const
 
void setAutoWarningHandlingEnabled (bool enable)
 
bool isAutoWarningHandlingEnabled () const
 
void setInteractive (bool enable)
 
bool isInteractive () const
 
void setWindow (TQWidget *window)
 
TQWidget * window () const
 
void updateUserTimestamp (unsigned long time)
 
void setParentJob (Job *parentJob)
 
Job * parentJob () const
 
void setMetaData (const TDEIO::MetaData &metaData)
 
void addMetaData (const TQString &key, const TQString &value)
 
void addMetaData (const TQMap< TQString, TQString > &values)
 
void mergeMetaData (const TQMap< TQString, TQString > &values)
 
MetaData outgoingMetaData () const
 
MetaData metaData () const
 
TQString queryMetaData (const TQString &key)
 
TDEIO::filesize_t getProcessedSize ()
 

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 Slots inherited from TDEIO::SimpleJob
virtual void slotFinished ()
 
void slotWarning (const TQString &)
 
void slotInfoMessage (const TQString &s)
 
void slotConnected ()
 
void slotProcessedSize (TDEIO::filesize_t data_size)
 
void slotSpeed (unsigned long speed)
 
virtual void slotMetaData (const TDEIO::MetaData &_metaData)
 
void slotNeedProgressId ()
 
- Protected Slots inherited from TDEIO::Job
virtual void slotResult (TDEIO::Job *job)
 
void slotSpeed (TDEIO::Job *job, unsigned long speed)
 
void slotInfoMessage (TDEIO::Job *job, const TQString &msg)
 
void slotSpeedTimeout ()
 

Protected Member Functions

virtual void virtual_hook (int id, void *data)
 
- Protected Member Functions inherited from TDEIO::SimpleJob
void storeSSLSessionFromJob (const KURL &m_redirectionURL)
 
- Protected Member Functions inherited from TDEIO::Job
 Job (bool showProgressInfo)
 
virtual void addSubjob (Job *job, bool inheritMetaData=true)
 
virtual void removeSubjob (Job *job)
 
void removeSubjob (Job *job, bool mergeMetaData, bool emitResultIfLast)
 
void emitPercent (TDEIO::filesize_t processedSize, TDEIO::filesize_t totalSize)
 
void emitSpeed (unsigned long speed)
 
void emitResult ()
 
void setProcessedSize (TDEIO::filesize_t size)
 
unsigned long userTimestamp () const
 
int & extraFlags ()
 

Additional Inherited Members

- Public Slots inherited from TDEIO::SimpleJob
void slotTotalSize (TDEIO::filesize_t data_size)
 
virtual void slotError (int, const TQString &)
 
- Static Public Member Functions inherited from TDEIO::SimpleJob
static void removeOnHold ()
 
- Protected Types inherited from TDEIO::Job
enum  { EF_TransferJobAsync = (1 << 0), EF_TransferJobNeedData = (1 << 1), EF_TransferJobDataSent = (1 << 2), EF_ListJobUnrestricted = (1 << 3) }
 
- Protected Attributes inherited from TDEIO::SimpleJob
Slave * m_slave
 
TQByteArray m_packedArgs
 
KURL m_url
 
KURL m_subUrl
 
int m_command
 
TDEIO::filesize_t m_totalSize
 
- Protected Attributes inherited from TDEIO::Job
TQPtrList< Job > subjobs
 
int m_error
 
TQString m_errorText
 
unsigned long m_percent
 
int m_progressId
 
TQTimer * m_speedTimer
 
TQGuardedPtr< TQWidget > m_window
 
MetaData m_outgoingMetaData
 
MetaData m_incomingMetaData
 

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 1391 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
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 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
jobthe job that emitted this signal
listthe 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
jobthe job that emitted this signal
fromUrlthe original URL
toUrlthe 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
jobthe job that is redirected
urlthe 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 1423 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.


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
  •     tdecore
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  • tdeioslave
  •   http
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeio/tdeio by doxygen 1.8.8
This website is maintained by Timothy Pearson.