KIO::CopyJob

#include <KIO/CopyJob>

Inheritance diagram for KIO::CopyJob:

[legend]

Public Types
enum	CopyMode { Copy, Move, Link }

Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities

enum	Capability

enum	Unit

Signals
QT_MOC_COMPAT void	aboutToCreate (KIO::Job *job, const QList< KIO::CopyInfo > &files)

void	copying (KIO::Job *job, const QUrl &src, const QUrl &dest)

void	copyingDone (KIO::Job *job, const QUrl &from, const QUrl &to, const QDateTime &mtime, bool directory, bool renamed)

void	copyingLinkDone (KIO::Job *job, const QUrl &from, const QString &target, const QUrl &to)

void	creatingDir (KIO::Job *job, const QUrl &dir)

void	linking (KIO::Job *job, const QString &target, const QUrl &to)

void	moving (KIO::Job *job, const QUrl &from, const QUrl &to)

void	processedDirs (KIO::Job *job, unsigned long dirs)

void	processedFiles (KIO::Job *job, unsigned long files)

void	renamed (KIO::Job *job, const QUrl &from, const QUrl &to)

QT_MOC_COMPAT void	totalDirs (KJob *job, unsigned long dirs)

QT_MOC_COMPAT void	totalFiles (KJob *job, unsigned long files)

Signals inherited from KIO::Job
void	canceled (KJob *job)

void	connected (KIO::Job *job)

Signals inherited from KJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< 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	percentChanged (KJob *job, unsigned long percent)

void	processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)

void	processedAmountChanged (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	totalAmountChanged (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
QUrl	destUrl () const

bool	doResume () override

bool	doSuspend () override

CopyMode	operationMode () const

void	setAutoRename (bool autoRename)

void	setAutoSkip (bool autoSkip)

void	setDefaultPermissions (bool b)

void	setWriteIntoExistingDirectories (bool overwriteAllDirs)

QList< QUrl >	srcUrls () const

Public Member Functions inherited from KIO::Job
void	addMetaData (const QMap< QString, QString > &values)

void	addMetaData (const QString &key, const QString &value)

QStringList	detailedErrorStrings (const QUrl *reqUrl=nullptr, int method=-1) const

QString	errorString () const override

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	setUiDelegateExtension (JobUiDelegateExtension *extension)

void	start () override

KJobUiDelegate *	ui () const

JobUiDelegateExtension *	uiDelegateExtension () const

Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=nullptr)

Public Member Functions inherited from KJob
	KJob (QObject *parent=nullptr)

Capabilities	capabilities () const

int	error () const

QString	errorText () const

bool	exec ()

bool	isAutoDelete () const

bool	isFinishedNotificationHidden () const

bool	isStartedWithExec () const

bool	isSuspended () const

unsigned long	percent () const

Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const

void	setAutoDelete (bool autodelete)

void	setFinishedNotificationHidden (bool hide=true)

void	setUiDelegate (KJobUiDelegate *delegate)

Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const

KJobUiDelegate *	uiDelegate () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Protected Slots
void	slotResult (KJob *job) override

Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &plain, const QString &rich)

virtual void	slotResult (KJob *job)

Protected Member Functions
KIOCORE_NO_EXPORT	CopyJob (CopyJobPrivate &dd)

void	emitResult ()

Protected Member Functions inherited from KIO::Job
	Job (JobPrivate &dd)

bool	addSubjob (KJob *job) override

bool	doKill () override

bool	doResume () override

bool	doSuspend () override

bool	removeSubjob (KJob *job) override

Protected Member Functions inherited from KCompositeJob
void	clearSubjobs ()

bool	hasSubjobs () const

const QList< KJob * > &	subjobs () const

Protected Member Functions inherited from KJob
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)

void	emitResult ()

void	emitSpeed (unsigned long speed)

bool	isFinished () const

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	setProgressUnit (Unit unit)

void	setTotalAmount (Unit unit, qulonglong amount)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Properties inherited from QObject
	objectName

Public Slots inherited from KJob
bool	kill (KillVerbosity verbosity=Quietly)

bool	resume ()

bool	suspend ()

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from KJob
	Bytes

	Directories

	Files

	Items

	Killable

	NoCapabilities

	Suspendable

	UnitsCount

Public Attributes inherited from QObject
typedef	QObjectList

Protected Attributes inherited from KIO::Job
JobPrivate *const	d_ptr

Detailed Description

CopyJob is used to move, copy or symlink files and directories. Don't create the job directly, but use KIO::copy(), KIO::move(), KIO::link() and friends.

See also: KIO::copy(); KIO::copyAs(); KIO::move(); KIO::moveAs(); KIO::link(); KIO::linkAs()

Definition at line 53 of file copyjob.h.

Member Enumeration Documentation

◆ CopyMode

enum KIO::CopyJob::CopyMode

Defines the mode of the operation.

Definition at line 61 of file copyjob.h.

Member Function Documentation

◆ aboutToCreate

QT_MOC_COMPAT void KIO::CopyJob::aboutToCreate	(	KIO::Job *	job,
		const QList< KIO::CopyInfo > &	files
	)

signal

Emitted when it is known which files / directories are going to be created.

Note that this may still change e.g. when existing files with the same name are discovered.

Parameters

job	the job that emitted this signal
files	a list of items that are about to be created.

Deprecated:: since 5.2 – this signal is unused since kde 3...

◆ copying

void KIO::CopyJob::copying	(	KIO::Job *	job,
		const QUrl &	src,
		const QUrl &	dest
	)

signal

The job is copying a file or directory.

Note: This signal is used for progress dialogs, it's not emitted for every file or directory (this would be too slow), but every 200ms.

Parameters

job	the job that emitted this signal
src	the URL of the file or directory that is currently being copied
dest	the destination of the current operation

◆ copyingDone

void KIO::CopyJob::copyingDone	(	KIO::Job *	job,
		const QUrl &	from,
		const QUrl &	to,
		const QDateTime &	mtime,
		bool	directory,
		bool	renamed
	)

signal

The job emits this signal when copying or moving a file or directory successfully finished.

This signal is mainly for the Undo feature. If you simply want to know when a copy job is done, use result().

Parameters

job	the job that emitted this signal
from	the source URL
to	the destination URL
mtime	the modification time of the source file, hopefully set on the destination file too (when the KIO worker supports it).
directory	indicates whether a file or directory was successfully copied/moved. true for a directory, false for file
renamed	indicates that the destination URL was created using a rename operation (i.e. fast directory moving). true if is has been renamed

◆ copyingLinkDone

void KIO::CopyJob::copyingLinkDone	(	KIO::Job *	job,
		const QUrl &	from,
		const QString &	target,
		const QUrl &	to
	)

signal

The job is copying or moving a symbolic link, that points to target.

The new link is created in to. The existing one is/was in from. This signal is mainly for the Undo feature.

Parameters

job	the job that emitted this signal
from	the source URL
target	the target
to	the destination URL

◆ creatingDir

void KIO::CopyJob::creatingDir	(	KIO::Job *	job,
		const QUrl &	dir
	)

signal

The job is creating the directory dir.

This signal is emitted for every directory being created.

Parameters

job	the job that emitted this signal
dir	the directory that is currently being created

◆ destUrl()

QUrl CopyJob::destUrl ( ) const

Returns the destination URL.

Returns: the destination URL

Definition at line 436 of file copyjob.cpp.

◆ doResume()

bool CopyJob::doResume ( )

overridevirtual

Reimplemented for internal reasons.

Reimplemented from KJob.

Definition at line 703 of file copyjob.cpp.

◆ doSuspend()

bool CopyJob::doSuspend ( )

overridevirtual

Reimplemented for internal reasons.

Reimplemented from KJob.

Definition at line 696 of file copyjob.cpp.

◆ linking

void KIO::CopyJob::linking	(	KIO::Job *	job,
		const QString &	target,
		const QUrl &	to
	)

signal

The job is creating a symbolic link.

Note: This signal is used for progress dialogs, it's not emitted for every file or directory (this would be too slow), but every 200ms.

Parameters

job	the job that emitted this signal
target	the URL of the file or directory that is currently being linked
to	the destination of the current operation

◆ moving

void KIO::CopyJob::moving	(	KIO::Job *	job,
		const QUrl &	from,
		const QUrl &	to
	)

signal

The job is moving a file or directory.

Note: This signal is used for progress dialogs, it's not emitted for every file or directory (this would be too slow), but every 200ms.

Parameters

job	the job that emitted this signal
from	the URL of the file or directory that is currently being moved
to	the destination of the current operation

◆ operationMode()

KIO::CopyJob::CopyMode KIO::CopyJob::operationMode ( ) const

Returns the mode of the operation (copy, move, or link), depending on whether KIO::copy(), KIO::move() or KIO::link() was called.

Definition at line 2605 of file copyjob.cpp.

◆ processedDirs

void KIO::CopyJob::processedDirs	(	KIO::Job *	job,
		unsigned long	dirs
	)

signal

Sends the number of processed directories.

Parameters

job	the job that emitted this signal
dirs	the number of processed dirs

◆ processedFiles

void KIO::CopyJob::processedFiles	(	KIO::Job *	job,
		unsigned long	files
	)

signal

Sends the number of processed files.

Parameters

job	the job that emitted this signal
files	the number of processed files

◆ renamed

void KIO::CopyJob::renamed	(	KIO::Job *	job,
		const QUrl &	from,
		const QUrl &	to
	)

signal

The user chose to rename from to to.

Parameters

job	the job that emitted this signal
from	the original name
to	the new name

◆ setAutoRename()

void KIO::CopyJob::setAutoRename ( bool autoRename )

Rename files automatically when the destination already exists, instead of the default behavior (interactive mode: showing a dialog to the user, non-interactive mode: aborting with an error).

Initially added for a unit test.

Since: 4.7

Definition at line 2616 of file copyjob.cpp.

◆ setAutoSkip()

void KIO::CopyJob::setAutoSkip ( bool autoSkip )

Skip copying or moving any file when the destination already exists, instead of the default behavior (interactive mode: showing a dialog to the user, non-interactive mode: aborting with an error).

Initially added for a unit test.

Since: 4.2

Definition at line 2610 of file copyjob.cpp.

◆ setDefaultPermissions()

void KIO::CopyJob::setDefaultPermissions ( bool b )

By default the permissions of the copied files will be those of the source files.

But when copying "template" files to "new" files, people prefer the umask to apply, rather than the template's permissions. For that case, call setDefaultPermissions(true)

Definition at line 2600 of file copyjob.cpp.

◆ setWriteIntoExistingDirectories()

void KIO::CopyJob::setWriteIntoExistingDirectories ( bool overwriteAllDirs )

Reuse any directory that already exists, instead of the default behavior (interactive mode: showing a dialog to the user, non-interactive mode: aborting with an error).

Since: 4.2

Definition at line 2622 of file copyjob.cpp.

◆ srcUrls()

QList< QUrl > CopyJob::srcUrls ( ) const

Returns the list of source URLs.

Returns: the list of source URLs.

Definition at line 431 of file copyjob.cpp.

◆ totalDirs

QT_MOC_COMPAT void KIO::CopyJob::totalDirs	(	KJob *	job,
		unsigned long	dirs
	)

signal

Emitted when the total number of directories is known.

Parameters

job	the job that emitted this signal
dirs	the total number of directories

Deprecated:: since 5.72, up to Frameworks versions <= 5.79, use the KJob::totalAmount(KJob *, KJob::Unit, qulonglong) signal, starting from 5.80 use KJob::totalAmountChanged(KJob *, KJob::Unit, qulonglong) signal instead.

◆ totalFiles

QT_MOC_COMPAT void KIO::CopyJob::totalFiles	(	KJob *	job,
		unsigned long	files
	)

signal

Emitted when the total number of files is known.

Parameters

job	the job that emitted this signal
files	the total number of files

Deprecated:: since 5.72, up to Frameworks versions <= 5.79, use the KJob::totalAmount(KJob *, KJob::Unit, qulonglong) signal, starting from 5.80 use the KJob::totalAmountChanged(KJob *, KJob::Unit, qulonglong) signal instead.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KIO

KIO::CopyJob

Public Types

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CopyMode

Member Function Documentation

◆ aboutToCreate

◆ copying

◆ copyingDone

◆ copyingLinkDone

◆ creatingDir

◆ destUrl()

◆ doResume()

◆ doSuspend()

◆ linking

◆ moving

◆ operationMode()

◆ processedDirs

◆ processedFiles

◆ renamed

◆ setAutoRename()

◆ setAutoSkip()

◆ setDefaultPermissions()

◆ setWriteIntoExistingDirectories()

◆ srcUrls()

◆ totalDirs

◆ totalFiles