KIO::StatJob Class Reference

#include <KIO/StatJob>

Inheritance diagram for KIO::StatJob:

Public Types
enum	StatSide { SourceSide , DestinationSide }
Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities
enum	Capability
enum	Unit

Signals
void	permanentRedirection (KIO::Job *job, const QUrl &fromUrl, const QUrl &toUrl)
void	redirection (KIO::Job *job, const QUrl &url)
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 Member Functions
QUrl	mostLocalUrl () const
void	setDetails (KIO::StatDetails details)
void	setSide (StatSide side)
const UDSEntry &	statResult () const
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
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

Protected Slots
void	slotFinished () override
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 &message)
virtual void	slotResult (KJob *job)

Protected Member Functions
KIOCORE_NO_EXPORT	StatJob (StatJobPrivate &dd)
Protected Member Functions inherited from KIO::SimpleJob
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
Properties inherited from QObject
	objectName
Public Slots inherited from KIO::SimpleJob
void	slotError (int, const QString &)
Public Slots inherited from KJob
bool	kill (KJob::KillVerbosity verbosity=KJob::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)
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

A KIO job that retrieves information about a file or directory.

See also

KIO::stat()

Definition at line 25 of file statjob.h.

Member Enumeration Documentation

StatSide

enum KIO::StatJob::StatSide

Definition at line 30 of file statjob.h.

Constructor & Destructor Documentation

~StatJob()

StatJob::~StatJob ( )

override

Definition at line 66 of file statjob.cpp.

StatJob()

StatJob::StatJob ( StatJobPrivate & dd )

explicitprotected

Definition at line 60 of file statjob.cpp.

Member Function Documentation

mostLocalUrl()

QUrl StatJob::mostLocalUrl

(

)

const

most local URL

Since this method depends on UDSEntry::UDS_LOCAL_PATH having been previously set by a KIO worker, ideally you should first check that the protocol Class of the URL being stat'ed is ":local" before creating the StatJob at all. Typically only ":local" KIO workers set UDS_LOCAL_PATH. See KProtocolInfo::protocolClass().

Call this in a slot connected to the result signal, and only after making sure no error happened.

Returns

the most local URL for the URL we were stat'ing

Sample usage:

auto *job = KIO::mostLocalUrl("desktop:/foo");
job->uiDelegate()->setWindow(this);
connect(job, &KJob::result, this, &MyClass::slotMostLocalUrlResult);
[...]
// and in slotMostLocalUrlResult(KJob *job)
if (job->error()) {
   [...] // doesn't exist
} else {
   const QUrl localUrl = job->mostLocalUrl();
   // localUrl = file:///$HOME/Desktop/foo
   [...]
}

Since

4.4

Definition at line 85 of file statjob.cpp.

permanentRedirection

void KIO::StatJob::permanentRedirection ( KIO::Job * job, const QUrl & fromUrl, const QUrl & toUrl )

signal

Signals a permanent redirection.

The redirection itself is handled internally.

Parameters

job	the job that is redirected
fromUrl	the original URL
toUrl	the new URL

redirection

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

signal

Signals a redirection.

Use to update the URL shown to the user. The redirection itself is handled internally.

Parameters

job	the job that is redirected
url	the new url

setDetails()

void StatJob::setDetails

(

KIO::StatDetails

details

)

Selects the level of details we want.

Since

5.69

Definition at line 75 of file statjob.cpp.

setSide()

void StatJob::setSide

(

StatSide

side

)

A stat() can have two meanings.

Either we want to read from this URL, or to check if we can write to it. First case is "source", second is "dest". It is necessary to know what the StatJob is for, to tune the KIO worker's behavior (e.g. with FTP). By default it is SourceSide.

Parameters

side	SourceSide or DestinationSide

Definition at line 70 of file statjob.cpp.

slotFinished

void StatJob::slotFinished ( )

overrideprotectedslot

Definition at line 149 of file statjob.cpp.

statResult()

const UDSEntry & StatJob::statResult

(

)

const

Result of the stat operation.

Call this in the slot connected to result, and only after making sure no error happened.

Returns

the result of the stat

Definition at line 80 of file statjob.cpp.

---

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

• statjob.h
• statjob.cpp