KIO::FileCopyJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::FileCopyJob:

Signals
void	mimetype (KIO::Job *job, const QString &type)
Signals inherited from KIO::Job
void	canceled (KJob *job)
void	connected (KIO::Job *job)
Signals inherited from KCompositeJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=qMakePair(QString(), QString()), const QPair< QString, QString > &field2=qMakePair(QString(), QString()))
void	finished (KJob *job)
void	infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
void	percent (KJob *job, unsigned long percent)
void	processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
void	processedSize (KJob *job, qulonglong size)
void	result (KJob *job)
void	resumed (KJob *job)
void	speed (KJob *job, unsigned long speed)
void	suspended (KJob *job)
void	totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
void	totalSize (KJob *job, qulonglong size)
void	warning (KJob *job, const QString &plain, const QString &rich=QString())
Signals inherited from KJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=qMakePair(QString(), QString()), const QPair< QString, QString > &field2=qMakePair(QString(), QString()))
void	finished (KJob *job)
void	infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
void	percent (KJob *job, unsigned long percent)
void	processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
void	processedSize (KJob *job, qulonglong size)
void	result (KJob *job)
void	resumed (KJob *job)
void	speed (KJob *job, unsigned long speed)
void	suspended (KJob *job)
void	totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
void	totalSize (KJob *job, qulonglong size)
void	warning (KJob *job, const QString &plain, const QString &rich=QString())

Public Member Functions
	~FileCopyJob ()
KUrl	destUrl () const
bool	doResume ()
bool	doSuspend ()
void	setModificationTime (const QDateTime &mtime)
void	setSourceSize (KIO::filesize_t size)
KUrl	srcUrl () const
Public Member Functions inherited from KIO::Job
virtual	~Job ()
void	addMetaData (const QString &key, const QString &value)
void	addMetaData (const QMap< QString, QString > &values)
QStringList	detailedErrorStrings (const KUrl *reqUrl=0L, int method=-1) const
QString	errorString () const
bool	isInteractive () const
void	mergeMetaData (const QMap< QString, QString > &values)
MetaData	metaData () const
MetaData	outgoingMetaData () const
Job *	parentJob () const
QString	queryMetaData (const QString &key)
void	setMetaData (const KIO::MetaData &metaData)
void	setParentJob (Job *parentJob)
void	showErrorDialog (QWidget *parent=0)
void	start ()
JobUiDelegate *	ui () const
Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=0)
virtual	~KCompositeJob ()
virtual	~KJob ()
Capabilities	capabilities () const
int	error () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isSuspended () const
	KJob (QObject *parent=0)
unsigned long	percent () const
qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setUiDelegate (KJobUiDelegate *delegate)
qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () const
Public Member Functions inherited from KJob
	KJob (QObject *parent=0)
Capabilities	capabilities () const
int	error () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isSuspended () const
unsigned long	percent () const
qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setUiDelegate (KJobUiDelegate *delegate)
qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () const

Protected Slots
virtual void	slotResult (KJob *job)

Protected Member Functions
	FileCopyJob (FileCopyJobPrivate &dd)
Protected Member Functions inherited from KIO::Job
	Job ()
	Job (JobPrivate &dd)
virtual bool	addSubjob (KJob *job)
virtual bool	doKill ()
virtual bool	removeSubjob (KJob *job)
Protected Member Functions inherited from KCompositeJob
	KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
void	clearSubjobs ()
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void	emitResult ()
void	emitSpeed (unsigned long speed)
bool	hasSubjobs ()
	KJob (KJobPrivate &dd, QObject *parent)
void	setCapabilities (Capabilities capabilities)
void	setError (int errorCode)
void	setErrorText (const QString &errorText)
void	setPercent (unsigned long percentage)
void	setProcessedAmount (Unit unit, qulonglong amount)
void	setTotalAmount (Unit unit, qulonglong amount)
const QList< KJob * > &	subjobs () const
Protected Member Functions inherited from KJob
	KJob (KJobPrivate &dd, QObject *parent)
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void	emitResult ()
void	emitSpeed (unsigned long speed)
void	setCapabilities (Capabilities capabilities)
void	setError (int errorCode)
void	setErrorText (const QString &errorText)
void	setPercent (unsigned long percentage)
void	setProcessedAmount (Unit unit, qulonglong amount)
void	setTotalAmount (Unit unit, qulonglong amount)

Additional Inherited Members
Public Types inherited from KCompositeJob
enum	Capability
enum	KillVerbosity
enum	Unit
Public Slots inherited from KCompositeJob
bool	kill (KillVerbosity verbosity=Quietly)
bool	resume ()
bool	suspend ()
Public Attributes inherited from KCompositeJob
	Bytes
	Directories
	EmitResult
	Files
	Killable
	KilledJobError
	NoCapabilities
	NoError
	Quietly
	Suspendable
	UserDefinedError
Protected Attributes inherited from KCompositeJob
KJobPrivate *const	d_ptr

Detailed Description

The FileCopyJob copies data from one place to another.

See Also

KIO::file_copy()

KIO::file_move()

Definition at line 856 of file jobclasses.h.

Constructor & Destructor Documentation

FileCopyJob::~FileCopyJob

(

)

Definition at line 2049 of file job.cpp.

FileCopyJob::FileCopyJob ( FileCopyJobPrivate &  dd )

protected

Definition at line 1980 of file job.cpp.

Member Function Documentation

KUrl FileCopyJob::destUrl

(

)

const

Returns the destination URL.

Returns

the destination URL

Definition at line 2072 of file job.cpp.

bool FileCopyJob::doResume ( )

virtual

Resume this job.

See Also

suspend

Reimplemented from KIO::Job.

Definition at line 2137 of file job.cpp.

bool FileCopyJob::doSuspend ( )

virtual

Suspend this job.

See Also

resume

Reimplemented from KIO::Job.

Definition at line 2118 of file job.cpp.

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

signal

Mimetype determined during a file copy.

This is never emitted during a move, and might not be emitted during a file copy, depending on the slave. But when a get and a put are being used (which is the common case), this signal forwards the mimetype information from the get job.

Parameters

job	the job that emitted this signal
type	the mime type

void FileCopyJob::setModificationTime

(

const QDateTime &

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 2061 of file job.cpp.

void FileCopyJob::setSourceSize

(

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

size	the size of the source file

Definition at line 2053 of file job.cpp.

void FileCopyJob::slotResult ( KJob *  job )

protectedvirtualslot

Called whenever a subjob finishes.

Parameters

job	the job that emitted this signal

Definition at line 2344 of file job.cpp.

KUrl FileCopyJob::srcUrl

(

)

const

Returns the source URL.

Returns

the source URL

Definition at line 2067 of file job.cpp.

---

The documentation for this class was generated from the following files:

• jobclasses.h
• job.cpp