• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KIO

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

#include <jobclasses.h>

Inheritance diagram for KIO::FileCopyJob:
KIO::Job KCompositeJob KJob QObject

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 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 QMap< QString, QString > &values)
 
void addMetaData (const QString &key, const QString &value)
 
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 ()
 
- Public Member Functions inherited from KJob
 KJob (QObject *parent=0)
 
virtual ~KJob ()
 
Capabilities capabilities () const
 
int error () const
 
virtual QString errorString () 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)
 
virtual void start ()=0
 
qulonglong totalAmount (Unit unit) const
 
KJobUiDelegate * uiDelegate () const
 

Protected Slots

virtual void slotResult (KJob *job)
 
- Protected Slots inherited from KCompositeJob
virtual void slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
 
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 doResume ()
 
virtual bool doSuspend ()
 
virtual bool removeSubjob (KJob *job)
 
- Protected Member Functions inherited from KCompositeJob
 KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
 
virtual bool addSubjob (KJob *job)
 
void clearSubjobs ()
 
bool hasSubjobs ()
 
virtual bool removeSubjob (KJob *job)
 
const QList< KJob * > & subjobs () const
 
- Protected Member Functions inherited from KJob
 KJob (KJobPrivate &dd, QObject *parent)
 
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
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 KJob
enum  Capability
 
enum  KillVerbosity
 
enum  Unit
 
- Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=Quietly)
 
bool resume ()
 
bool suspend ()
 
- Public Attributes inherited from KJob
 Bytes
 
 Directories
 
 EmitResult
 
 Files
 
 Killable
 
 KilledJobError
 
 NoCapabilities
 
 NoError
 
 Quietly
 
 Suspendable
 
 UserDefinedError
 
- Protected Attributes inherited from KJob
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::~FileCopyJob ( )

Definition at line 2064 of file job.cpp.

◆ FileCopyJob()

FileCopyJob::FileCopyJob ( FileCopyJobPrivate &  dd)
protected

Definition at line 1995 of file job.cpp.

Member Function Documentation

◆ destUrl()

KUrl FileCopyJob::destUrl ( ) const

Returns the destination URL.

Returns
the destination URL

Definition at line 2087 of file job.cpp.

◆ doResume()

bool FileCopyJob::doResume ( )
virtual

Resume this job.

See also
suspend

Reimplemented from KIO::Job.

Definition at line 2158 of file job.cpp.

◆ doSuspend()

bool FileCopyJob::doSuspend ( )
virtual

Suspend this job.

See also
resume

Reimplemented from KIO::Job.

Definition at line 2139 of file job.cpp.

◆ mimetype

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
jobthe job that emitted this signal
typethe mime type

◆ setModificationTime()

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

◆ setSourceSize()

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
sizethe size of the source file

Definition at line 2068 of file job.cpp.

◆ slotResult

void FileCopyJob::slotResult ( KJob *  job)
protectedvirtualslot

Called whenever a subjob finishes.

Parameters
jobthe job that emitted this signal

Definition at line 2365 of file job.cpp.

◆ srcUrl()

KUrl FileCopyJob::srcUrl ( ) const

Returns the source URL.

Returns
the source URL

Definition at line 2082 of file job.cpp.


The documentation for this class was generated from the following files:
  • jobclasses.h
  • job.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal