KIO::FileJob

#include <KIO/FileJob>

Inheritance diagram for KIO::FileJob:

[legend]

Signals
void	close (KIO::Job *job)

void	data (KIO::Job *job, const QByteArray &data)

void	fileClosed (KIO::Job *job)

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

void	mimeTypeFound (KIO::Job *job, const QString &mimeType)

void	open (KIO::Job *job)

void	position (KIO::Job *job, KIO::filesize_t offset)

void	redirection (KIO::Job *job, const QUrl &url)

void	truncated (KIO::Job *job, KIO::filesize_t length)

void	written (KIO::Job *job, KIO::filesize_t written)

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
void	close ()

void	read (KIO::filesize_t size)

void	seek (KIO::filesize_t offset)

KIO::filesize_t	size ()

void	truncate (KIO::filesize_t length)

void	write (const QByteArray &data)

Public Member Functions inherited from KIO::SimpleJob
bool	isRedirectionHandlingEnabled () const

virtual void	putOnHold ()

void	setRedirectionHandlingEnabled (bool handle)

const QUrl &	url () 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 Member Functions
KIOCORE_NO_EXPORT	FileJob (FileJobPrivate &dd)

Protected Member Functions inherited from KIO::SimpleJob
KIOCORE_NO_EXPORT	SimpleJob (SimpleJobPrivate &dd)

bool	doKill () override

bool	doResume () override

bool	doSuspend () override

void	storeSSLSessionFromJob (const QUrl &m_redirectionURL)

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

bool	addSubjob (KJob *job) 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
Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities

enum	Capability

enum	Unit

Properties inherited from QObject
	objectName

Public Slots inherited from KIO::SimpleJob
void	slotError (int, const QString &)

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

bool	resume ()

bool	suspend ()

Static Public Member Functions inherited from KIO::SimpleJob
static void	removeOnHold ()

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 Slots inherited from KIO::SimpleJob
virtual void	slotFinished ()

virtual void	slotMetaData (const KIO::MetaData &_metaData)

virtual void	slotWarning (const QString &)

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

virtual void	slotResult (KJob *job)

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

Detailed Description

The file-job is an asynchronous version of normal file handling. It allows block-wise reading and writing, and allows seeking and truncation. Results are returned through signals.

Should always be created using KIO::open(const QUrl&, QIODevice::OpenMode).

Definition at line 26 of file filejob.h.

Member Function Documentation

◆ close() [1/2]

void FileJob::close ( )

Closes the file KIO worker.

The worker emits close() and result().

Definition at line 110 of file filejob.cpp.

◆ close [2/2]

void KIO::FileJob::close ( KIO::Job * job )

signal

Signals that the file is closed and will accept no more commands.

Parameters

job	the job that emitted this signal

Deprecated:: since 5.79, use KIO::FileJob::fileClosed(KIO::Job *)

◆ data

void KIO::FileJob::data	(	KIO::Job *	job,
		const QByteArray &	data
	)

signal

Data from the worker has arrived.

Emitted after read().

Unless a read() request was sent for 0 bytes, End of data (EOD) has been reached if data.size() == 0

Parameters

job	the job that emitted this signal
data	data received from the worker.

◆ fileClosed

void KIO::FileJob::fileClosed ( KIO::Job * job )

signal

Signals that the file is closed and will accept no more commands.

Parameters

job	the job that emitted this signal

Since: 5.79

◆ mimetype

void KIO::FileJob::mimetype	(	KIO::Job *	job,
		const QString &	mimeType
	)

signal

MIME type determined.

Parameters

job	the job that emitted this signal
mimeType	the MIME type

Deprecated:: Since 5.78, use mimeTypeFound(KIO::Job *, const QString &)

◆ mimeTypeFound

void KIO::FileJob::mimeTypeFound	(	KIO::Job *	job,
		const QString &	mimeType
	)

signal

MIME type determined.

Parameters

job	the job that emitted this signal
mimeType	the MIME type

Since: 5.78

◆ open

void KIO::FileJob::open ( KIO::Job * job )

signal

File is open, metadata has been determined and the file KIO worker is ready to receive commands.

Parameters

job	the job that emitted this signal

◆ position

void KIO::FileJob::position	(	KIO::Job *	job,
		KIO::filesize_t	offset
	)

signal

The file has reached this position.

Emitted after seek().

Parameters

job	the job that emitted this signal
offset	the new position

◆ read()

void FileJob::read ( KIO::filesize_t size )

This function attempts to read up to size bytes from the URL passed to KIO::open() and returns the bytes received via the data() signal.

The read operation commences at the current file offset, and the file offset is incremented by the number of bytes read, but this change in the offset does not result in the position() signal being emitted.

If the current file offset is at or past the end of file (i.e. EOD), no bytes are read, and the data() signal returns an empty QByteArray.

On error the data() signal is not emitted. To catch errors please connect to the result() signal.

Parameters

size	the requested amount of data to read

Definition at line 67 of file filejob.cpp.

◆ redirection

void KIO::FileJob::redirection	(	KIO::Job *	job,
		const QUrl &	url
	)

signal

Signals the file is a redirection.

Follow this url manually to reach data

Parameters

job	the job that emitted this signal
url	the new URL

◆ seek()

void FileJob::seek ( KIO::filesize_t offset )

Seek.

The worker emits position() on successful seek to the specified offset.

On error the position() signal is not emitted. To catch errors please connect to the result() signal.

Parameters

offset the position from start to go to

Definition at line 88 of file filejob.cpp.

◆ size()

KIO::filesize_t FileJob::size ( )

Size.

Returns: the file size

Definition at line 121 of file filejob.cpp.

◆ truncate()

void FileJob::truncate ( KIO::filesize_t length )

Truncate.

The worker emits truncated() on successful truncation to the specified length.

On error the truncated() signal is not emitted. To catch errors please connect to the result() signal.

Parameters

length the desired length to truncate to

Since: 5.66

Definition at line 99 of file filejob.cpp.

◆ truncated

void KIO::FileJob::truncated	(	KIO::Job *	job,
		KIO::filesize_t	length
	)

signal

The file has been truncated to this point.

Emitted after truncate().

Parameters

job	the job that emitted this signal
length	the new length of the file

Since: 5.66

◆ write()

void FileJob::write ( const QByteArray & data )

This function attempts to write all the bytes in data to the URL passed to KIO::open() and returns the bytes written received via the written() signal.

The write operation commences at the current file offset, and the file offset is incremented by the number of bytes read, but this change in the offset does not result in the position() being emitted.

On error the written() signal is not emitted. To catch errors please connect to the result() signal.

Parameters

data	the data to write

Definition at line 78 of file filejob.cpp.

◆ written

void KIO::FileJob::written	(	KIO::Job *	job,
		KIO::filesize_t	written
	)

signal

written bytes were written to the file.

Emitted after write().

Parameters

job	the job that emitted this signal
written	bytes written.

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::FileJob

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ close() [1/2]

◆ close [2/2]

◆ data

◆ fileClosed

◆ mimetype

◆ mimeTypeFound

◆ open

◆ position

◆ read()

◆ redirection

◆ seek()

◆ size()

◆ truncate()

◆ truncated

◆ write()

◆ written