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

kio/kio

  • KIO
  • StoredTransferJob
Public Member Functions | List of all members
KIO::StoredTransferJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::StoredTransferJob:
KIO::TransferJob KIO::SimpleJob KIO::Job

Public Member Functions

 StoredTransferJob (const KURL &url, int command, const TQByteArray &packedArgs, const TQByteArray &_staticData, bool showProgressInfo)
 
void setData (const TQByteArray &arr)
 
TQByteArray data () const
 
- Public Member Functions inherited from KIO::TransferJob
 TransferJob (const KURL &url, int command, const TQByteArray &packedArgs, const TQByteArray &_staticData, bool showProgressInfo)
 
virtual void start (Slave *slave)
 
virtual void slotResult (KIO::Job *job)
 
void suspend ()
 
void resume ()
 
bool isSuspended () const
 
bool isErrorPage () const
 
void setAsyncDataEnabled (bool enabled)
 
void sendAsyncData (const TQByteArray &data)
 
void setReportDataSent (bool enabled)
 
bool reportDataSent ()
 
- Public Member Functions inherited from KIO::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 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 ()
 

Additional Inherited Members

- Public Slots inherited from KIO::SimpleJob
void slotTotalSize (KIO::filesize_t data_size)
 
virtual void slotError (int, const TQString &)
 
- Signals inherited from KIO::TransferJob
void data (KIO::Job *job, const TQByteArray &data)
 
void dataReq (KIO::Job *job, TQByteArray &data)
 
void redirection (KIO::Job *job, const KURL &url)
 
void permanentRedirection (KIO::Job *job, const KURL &fromUrl, const KURL &toUrl)
 
void mimetype (KIO::Job *job, const TQString &type)
 
void canResume (KIO::Job *job, KIO::filesize_t offset)
 
- Static Public Member Functions inherited from KIO::SimpleJob
static void removeOnHold ()
 
- Protected Types inherited from KIO::Job
enum  { EF_TransferJobAsync = (1 << 0), EF_TransferJobNeedData = (1 << 1), EF_TransferJobDataSent = (1 << 2), EF_ListJobUnrestricted = (1 << 3) }
 
- Protected Slots inherited from KIO::TransferJob
virtual void slotRedirection (const KURL &url)
 
virtual void slotFinished ()
 
virtual void slotData (const TQByteArray &data)
 
virtual void slotDataReq ()
 
virtual void slotMimetype (const TQString &mimetype)
 
virtual void slotNeedSubURLData ()
 
virtual void slotSubURLData (KIO::Job *, const TQByteArray &)
 
virtual void slotMetaData (const KIO::MetaData &_metaData)
 
void slotErrorPage ()
 
void slotCanResume (KIO::filesize_t offset)
 
void slotPostRedirection ()
 
- Protected Member Functions inherited from KIO::TransferJob
virtual void virtual_hook (int id, void *data)
 
- Protected Attributes inherited from KIO::TransferJob
bool m_suspended
 
bool m_errorPage
 
TQByteArray staticData
 
KURL m_redirectionURL
 
KURL::List m_redirectionList
 
TQString m_mimetype
 
TransferJob * m_subJob
 

Detailed Description

StoredTransferJob is a TransferJob (for downloading or uploading data) that also stores a TQByteArray with the data, making it simpler to use than the standard TransferJob.

For KIO::storedGet it puts the data into the member TQByteArray, so the user of this class can get hold of the whole data at once by calling data() when the result signal is emitted. You should only use StoredTransferJob to download data if you cannot process the data by chunks while it's being downloaded, since storing everything in a TQByteArray can potentially require a lot of memory.

For KIO::storedPut the user of this class simply provides the bytearray from the start, and the job takes care of uploading it. You should only use StoredTransferJob to upload data if you cannot provide the in chunks while it's being uploaded, since storing everything in a TQByteArray can potentially require a lot of memory.

Since
3.3

Definition at line 1075 of file jobclasses.h.

Constructor & Destructor Documentation

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

Do not create a StoredTransferJob.

Use storedGet() or storedPut() instead.

Parameters
urlthe url to get or put
commandthe command to issue
packedArgsthe arguments
_staticDataadditional data to transmit (e.g. in a HTTP Post)
showProgressInfotrue to show progress information to the user

Definition at line 1390 of file job.cpp.

Member Function Documentation

TQByteArray KIO::StoredTransferJob::data ( ) const
inline

Get hold of the downloaded data.

This is for get jobs. You're supposed to call this only from the slot connected to the result() signal.

Definition at line 1104 of file jobclasses.h.

void StoredTransferJob::setData ( const TQByteArray &  arr)

Set data to be uploaded.

This is for put jobs. Automatically called by KIO::storedPut(const TQByteArray &, ...), do not call this yourself.

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