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

kio/kio

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

#include <jobclasses.h>

Inheritance diagram for KIO::FileCopyJob:
KIO::Job

Public Slots

void slotStart ()
 
void slotData (KIO::Job *, const TQByteArray &data)
 
void slotDataReq (KIO::Job *, TQByteArray &data)
 
void slotMimetype (KIO::Job *, const TQString &type)
 

Signals

void mimetype (KIO::Job *job, const TQString &type)
 
- 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)
 

Public Member Functions

 FileCopyJob (const KURL &src, const KURL &dest, int permissions, bool move, bool overwrite, bool resume, bool showProgressInfo)
 
void setSourceSize64 (KIO::filesize_t size)
 
void setModificationTime (time_t mtime)
 
void setSourceSize (off_t size) KDE_DEPRECATED
 
KURL srcURL () const
 
KURL destURL () const
 
- Public Member Functions inherited from KIO::Job
virtual void kill (bool quietly=true)
 
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 ()
 

Protected Slots

virtual void slotResult (KIO::Job *job)
 
void slotProcessedSize (KIO::Job *job, KIO::filesize_t size)
 
void slotTotalSize (KIO::Job *job, KIO::filesize_t size)
 
void slotPercent (KIO::Job *job, unsigned long pct)
 
void slotCanResume (KIO::Job *job, KIO::filesize_t offset)
 
- 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

void startCopyJob ()
 
void startCopyJob (const KURL &slave_url)
 
void startRenameJob (const KURL &slave_url)
 
void startDataPump ()
 
void connectSubjob (SimpleJob *job)
 
virtual void virtual_hook (int id, void *data)
 
- 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

KURL m_src
 
KURL m_dest
 
int m_permissions
 
bool m_move:1
 
bool m_overwrite:1
 
bool m_resume:1
 
bool m_canResume:1
 
bool m_resumeAnswerSent:1
 
TQByteArray m_buffer
 
SimpleJob * m_moveJob
 
SimpleJob * m_copyJob
 
TransferJob * m_getJob
 
TransferJob * m_putJob
 
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

- 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

The FileCopyJob copies data from one place to another.

See also
KIO::file_copy()
KIO::file_move()

Definition at line 1250 of file jobclasses.h.

Constructor & Destructor Documentation

◆ FileCopyJob()

FileCopyJob::FileCopyJob ( const KURL &  src,
const KURL &  dest,
int  permissions,
bool  move,
bool  overwrite,
bool  resume,
bool  showProgressInfo 
)

Do not create a FileCopyJob directly.

Use KIO::file_move() or KIO::file_copy() instead.

Parameters
srcthe source URL
destthe destination URL
permissionsthe permissions of the resulting resource
movetrue to move, false to copy
overwritetrue to allow overwriting, false otherwise
resumetrue to resume an operation, false otherwise
showProgressInfotrue to show progress information to the user

Definition at line 1556 of file job.cpp.

Member Function Documentation

◆ destURL()

KURL KIO::FileCopyJob::destURL ( ) const
inline

Returns the destination URL.

Returns
the destination URL

Definition at line 1301 of file jobclasses.h.

◆ mimetype

void KIO::FileCopyJob::mimetype ( KIO::Job *  job,
const TQString &  type 
)
signal

Mimetype determined during a file copy.

This is never emitted during a move, and might not be emitted during a copy, depending on the slave.

Parameters
jobthe job that emitted this signal
typethe mime type
Since
3.5.7

◆ setModificationTime()

void FileCopyJob::setModificationTime ( time_t  mtime)

Sets the modification time of the file.

Note that this is ignored if a direct copy (SlaveBase::copy) can be done, in which case the mtime of the source is applied to the destination (if the protocol supports the concept).

Definition at line 1653 of file job.cpp.

◆ setSourceSize()

void FileCopyJob::setSourceSize ( off_t  size)
Deprecated:

Definition at line 1639 of file job.cpp.

◆ setSourceSize64()

void FileCopyJob::setSourceSize64 ( KIO::filesize_t  size)
If you know the size of the source file, call this method
to inform this job. It will be displayed in the "resume" dialog.
Parameters
sizethe size of the source file
Since
3.2

Definition at line 1646 of file job.cpp.

◆ slotCanResume

void FileCopyJob::slotCanResume ( KIO::Job *  job,
KIO::filesize_t  offset 
)
protectedslot
Forward signal from subjob
Parameters
jobthe job that emitted this signal
offsetthe offset to resume from

Definition at line 1746 of file job.cpp.

◆ slotPercent

void FileCopyJob::slotPercent ( KIO::Job *  job,
unsigned long  pct 
)
protectedslot
Forward signal from subjob
Parameters
jobthe job that emitted this signal
pctthe percentage

Definition at line 1714 of file job.cpp.

◆ slotProcessedSize

void FileCopyJob::slotProcessedSize ( KIO::Job *  job,
KIO::filesize_t  size 
)
protectedslot
Forward signal from subjob
Parameters
jobthe job that emitted this signal
sizethe processed size in bytes

Definition at line 1695 of file job.cpp.

◆ slotResult

void FileCopyJob::slotResult ( KIO::Job *  job)
protectedvirtualslot
Called whenever a subjob finishes.
Parameters
jobthe job that emitted this signal

Definition at line 1880 of file job.cpp.

◆ slotTotalSize

void FileCopyJob::slotTotalSize ( KIO::Job *  job,
KIO::filesize_t  size 
)
protectedslot
Forward signal from subjob
Parameters
jobthe job that emitted this signal
sizethe total size

Definition at line 1705 of file job.cpp.

◆ srcURL()

KURL KIO::FileCopyJob::srcURL ( ) const
inline

Returns the source URL.

Returns
the source URL

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