#include <filejob.h>

Inheritance diagram for KIO::FileJob:

Signals
void	close (KIO::Job *job)

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

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

void	open (KIO::Job *job)

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

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

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

Public Member Functions
	~FileJob ()

void	close ()

void	read (KIO::filesize_t size)

void	seek (KIO::filesize_t offset)

KIO::filesize_t	size ()

void	write (const QByteArray &data)

Public Member Functions inherited from KIO::SimpleJob
	~SimpleJob ()

bool	isRedirectionHandlingEnabled () const

virtual void	putOnHold ()

void	setRedirectionHandlingEnabled (bool handle)

const KUrl &	url () 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 QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

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

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

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

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

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

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Protected Member Functions
	FileJob (FileJobPrivate &dd)

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

virtual bool	doKill ()

virtual bool	doResume ()

virtual bool	doSuspend ()

void	storeSSLSessionFromJob (const KUrl &m_redirectionURL)

Protected Member Functions inherited from KIO::Job
	Job ()

	Job (JobPrivate &dd)

virtual bool	addSubjob (KJob *job)

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 QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from KCompositeJob
enum	Capability

enum	KillVerbosity

enum	Unit

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

Public Slots inherited from KCompositeJob
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
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

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)

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

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

Protected Slots inherited from KIO::SimpleJob
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)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Protected Attributes inherited from KCompositeJob
KJobPrivate *const	d_ptr

Properties inherited from QObject
	objectName

Detailed Description

The file-job is an asynchronious version of normal file handling.

It allows block-wise reading and writing, and allows seeking. Results are returned through signals.

Should always be created using KIO::open(KUrl&)

Definition at line 37 of file filejob.h.

Constructor & Destructor Documentation

FileJob::~FileJob ( )

Definition at line 78 of file filejob.cpp.

FileJob::FileJob ( FileJobPrivate & dd )

protected

Definition at line 73 of file filejob.cpp.

Member Function Documentation

void FileJob::close ( )

Close.

Closes the file-slave

Definition at line 109 of file filejob.cpp.

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

signal

File is closed and will accept no more commands.

Parameters

job	the job that emitted this signal

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

signal

Data from the slave has arrived.

Parameters

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

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

signal

Mimetype determined.

Parameters

job	the job that emitted this signal
type	the mime type

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

signal

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

Parameters

job	the job that emitted this signal

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

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

Read block.

The slave emits the data through data().

Parameters

size	the requested amount of data

Definition at line 82 of file filejob.cpp.

void KIO::FileJob::redirection	(	KIO::Job *	job,
		const KUrl &	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

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

Seek.

The slave emits position()

Parameters

offset the position from start to go to

Definition at line 100 of file filejob.cpp.

KIO::filesize_t FileJob::size ( )

Size.

Returns: the file size

Definition at line 118 of file filejob.cpp.

void FileJob::write ( const QByteArray & data )

Write block.

Parameters

data	the data to write

Definition at line 92 of file filejob.cpp.

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

signal

Bytes written to the file.

Parameters

job	the job that emitted this signal
written	bytes written.

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

KIO

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KIO

kdelibs API Reference

Search