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

kio/kio

  • KIO
  • SimpleJob
Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
KIO::SimpleJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::SimpleJob:
KIO::Job KIO::ListJob KIO::MkdirJob KIO::StatJob KIO::TransferJob KIO::DavJob KIO::MimetypeJob KIO::MultiGetJob KIO::StoredTransferJob

Public Slots

void slotTotalSize (KIO::filesize_t data_size)
 
virtual void slotError (int, const TQString &)
 

Public Member Functions

 SimpleJob (const KURL &url, int command, const TQByteArray &packedArgs, bool showProgressInfo)
 
const KURL & url () const
 
virtual void kill (bool quietly=true)
 
virtual void putOnHold ()
 
virtual void start (Slave *slave)
 
void slaveDone ()
 
Slave * slave () const
 
int command () const
 
- Public Member Functions inherited from KIO::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 KIO::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)
 
KIO::filesize_t getProcessedSize ()
 

Static Public Member Functions

static void removeOnHold ()
 

Protected Slots

virtual void slotFinished ()
 
void slotWarning (const TQString &)
 
void slotInfoMessage (const TQString &s)
 
void slotConnected ()
 
void slotProcessedSize (KIO::filesize_t data_size)
 
void slotSpeed (unsigned long speed)
 
virtual void slotMetaData (const KIO::MetaData &_metaData)
 
void slotNeedProgressId ()
 
- Protected Slots inherited from KIO::Job
virtual void slotResult (KIO::Job *job)
 
void slotSpeed (KIO::Job *job, unsigned long speed)
 
void slotInfoMessage (KIO::Job *job, const TQString &msg)
 
void slotSpeedTimeout ()
 

Protected Member Functions

virtual void virtual_hook (int id, void *data)
 
void storeSSLSessionFromJob (const KURL &m_redirectionURL)
 
- Protected Member Functions inherited from KIO::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 (KIO::filesize_t processedSize, KIO::filesize_t totalSize)
 
void emitSpeed (unsigned long speed)
 
void emitResult ()
 
void setProcessedSize (KIO::filesize_t size)
 
unsigned long userTimestamp () const
 
int & extraFlags ()
 

Protected Attributes

Slave * m_slave
 
TQByteArray m_packedArgs
 
KURL m_url
 
KURL m_subUrl
 
int m_command
 
KIO::filesize_t m_totalSize
 
- Protected Attributes inherited from KIO::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
 

Additional Inherited Members

- Signals inherited from KIO::Job
void result (KIO::Job *job)
 
void canceled (KIO::Job *job)
 
void infoMessage (KIO::Job *job, const TQString &msg)
 
void warning (KIO::Job *job, const TQString &msg)
 
void connected (KIO::Job *job)
 
void percent (KIO::Job *job, unsigned long percent)
 
void totalSize (KIO::Job *job, KIO::filesize_t size)
 
void processedSize (KIO::Job *job, KIO::filesize_t size)
 
void speed (KIO::Job *job, unsigned long speed)
 
- Protected Types inherited from KIO::Job
enum  { EF_TransferJobAsync = (1 << 0), EF_TransferJobNeedData = (1 << 1), EF_TransferJobDataSent = (1 << 2), EF_ListJobUnrestricted = (1 << 3) }
 

Detailed Description

A simple job (one url and one command).

This is the base class for all jobs that are scheduled. Other jobs are high-level jobs (CopyJob, DeleteJob, FileCopyJob...) that manage subjobs but aren't scheduled directly.

Definition at line 528 of file jobclasses.h.

Constructor & Destructor Documentation

SimpleJob::SimpleJob ( const KURL &  url,
int  command,
const TQByteArray &  packedArgs,
bool  showProgressInfo 
)

Creates a new simple job.

You don't need to use this constructor, unless you create a new job that inherits from SimpleJob.

Parameters
urlthe url of the job
commandthe command of the job
packedArgsthe arguments
showProgressInfotrue to show progress information to the user

Definition at line 430 of file job.cpp.

Member Function Documentation

void SimpleJob::kill ( bool  quietly = true)
virtual

Abort job.

This kills all subjobs and deletes the job.

Parameters
quietlyif true, Job will emit signal result Should only be set to false when the user kills the job (from kio_uiserver), not when you want to abort a job.

Reimplemented from KIO::Job.

Definition at line 457 of file job.cpp.

void SimpleJob::putOnHold ( )
virtual

Abort job.

Suspends slave to be reused by another job for the same request.

Definition at line 464 of file job.cpp.

void SimpleJob::removeOnHold ( )
static

Discard suspended slave.

Definition at line 475 of file job.cpp.

void SimpleJob::slotConnected ( )
protectedslot

Called on a slave's connected signal.

See Also
connected()

Definition at line 639 of file job.cpp.

void SimpleJob::slotFinished ( )
protectedvirtualslot

Called when the slave marks the job as finished.

Definition at line 576 of file job.cpp.

void SimpleJob::slotInfoMessage ( const TQString &  s)
protectedslot

Called on a slave's info message.

Parameters
sthe info message
See Also
infoMessage()

Definition at line 634 of file job.cpp.

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

MetaData from the slave is received.

Parameters
_metaDatathe meta data
See Also
metaData()

Definition at line 677 of file job.cpp.

void SimpleJob::slotProcessedSize ( KIO::filesize_t  data_size)
protectedslot

Forward signal from the slave.

Parameters
data_sizethe processed size in bytes
See Also
processedSize()

Definition at line 660 of file job.cpp.

void SimpleJob::slotSpeed ( unsigned long  speed)
protectedslot

Forward signal from the slave.

Parameters
speedthe speed in bytes/s
See Also
speed()

Definition at line 671 of file job.cpp.

void SimpleJob::slotTotalSize ( KIO::filesize_t  data_size)
slot

Forward signal from the slave Can also be called by the parent job, when it knows the size.

Parameters
data_sizethe total size

Definition at line 651 of file job.cpp.

const KURL& KIO::SimpleJob::url ( ) const
inline

Returns the SimpleJob's URL.

Returns
the url

Definition at line 549 of file jobclasses.h.


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.8.3.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |