KIO::SimpleJob

#include <KIO/SimpleJob>

Inheritance diagram for KIO::SimpleJob:

[legend]

Public Slots
void	slotError (int, const QString &)

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

bool	resume ()

bool	suspend ()

Public Member Functions
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

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

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

QBindable< QString >	bindableObjectName ()

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

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 QRegularExpression &re, Qt::FindChildOptions options) const const

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

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

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_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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	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	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

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

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

bool	signalsBlocked () const const

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

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

QThread *	thread () const const

Static Public Member Functions
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)

Protected Slots
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 &message)

virtual void	slotResult (KJob *job)

Protected Member Functions
KIOCORE_NO_EXPORT	SimpleJob (SimpleJobPrivate &dd)

bool	doKill () override

bool	doResume () override

bool	doSuspend () override

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)

void	startElapsedTimer ()

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

Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

Signals inherited from KIO::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 &message)

void	percentChanged (KJob *job, unsigned long percent)

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	totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)

void	totalSize (KJob *job, qulonglong size)

void	warning (KJob *job, const QString &message)

Public Attributes inherited from KJob
	Bytes

	Directories

	Files

	Items

	Killable

	NoCapabilities

	Suspendable

	UnitsCount

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

Detailed Description

A simple job (one url and one command).

This is the base class for all jobs that are scheduled. Other jobs are high-level jobs (CopyJob, DeleteJob, FileCopyJob...) that manage subjobs but aren't scheduled directly.

Constructor & Destructor Documentation

◆ ~SimpleJob()

SimpleJob::~SimpleJob ( )

override

Definition at line 103 of file simplejob.cpp.

◆ SimpleJob()

SimpleJob::SimpleJob ( SimpleJobPrivate & dd )

explicitprotected

Creates a new simple job.

You don't need to use this constructor, unless you create a new job that inherits from SimpleJob.

Definition at line 20 of file simplejob.cpp.

Member Function Documentation

◆ doKill()

bool SimpleJob::doKill ( )

overrideprotectedvirtual

Abort job.

This kills all subjobs and deletes the job.

Reimplemented from KIO::Job.

Definition at line 40 of file simplejob.cpp.

◆ doResume()

bool SimpleJob::doResume ( )

overrideprotectedvirtual

Resume this job.

See also: suspend

Reimplemented from KIO::Job.

Reimplemented in KIO::TransferJob.

Definition at line 61 of file simplejob.cpp.

◆ doSuspend()

bool SimpleJob::doSuspend ( )

overrideprotectedvirtual

Suspend this job.

See also: resume

Reimplemented from KIO::Job.

Definition at line 52 of file simplejob.cpp.

◆ isRedirectionHandlingEnabled()

bool SimpleJob::isRedirectionHandlingEnabled ( ) const

Returns true when redirections are handled internally, the default.

Definition at line 92 of file simplejob.cpp.

◆ putOnHold()

void SimpleJob::putOnHold ( )

virtual

Abort job.

Suspends worker to be reused by another job for the same request.

Definition at line 75 of file simplejob.cpp.

◆ removeOnHold()

void SimpleJob::removeOnHold ( )

static

Discard suspended worker.

Definition at line 87 of file simplejob.cpp.

◆ setRedirectionHandlingEnabled()

void SimpleJob::setRedirectionHandlingEnabled ( bool handle )

Set handle to false to prevent the internal handling of redirections.

When this flag is set, redirection requests are simply forwarded to the caller instead of being handled internally.

Definition at line 97 of file simplejob.cpp.

◆ slotError

void SimpleJob::slotError	(	int	err,
		const QString &	errorText )

slot

Called on a worker's error. Made public for the scheduler.

Definition at line 233 of file simplejob.cpp.

◆ slotFinished

void SimpleJob::slotFinished ( )

protectedvirtualslot

Called when the worker marks the job as finished.

Reimplemented in KIO::EmptyTrashJob.

Definition at line 195 of file simplejob.cpp.

◆ slotMetaData

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

protectedvirtualslot

MetaData from the worker is received.

Parameters

_metaData the meta data

See also: metaData()

Definition at line 295 of file simplejob.cpp.

◆ slotWarning

void SimpleJob::slotWarning ( const QString & errorText )

protectedvirtualslot

Called on a worker's warning.

Definition at line 245 of file simplejob.cpp.

◆ url()

const QUrl & SimpleJob::url ( ) const

Returns the SimpleJob's URL.

Returns: the url

Definition at line 70 of file simplejob.cpp.

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

Public Slots

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SimpleJob()

◆ SimpleJob()

Member Function Documentation

◆ doKill()

◆ doResume()

◆ doSuspend()

◆ isRedirectionHandlingEnabled()

◆ putOnHold()

◆ removeOnHold()

◆ setRedirectionHandlingEnabled()

◆ slotError

◆ slotFinished

◆ slotMetaData

◆ slotWarning

◆ url()