KIO::WorkerConfig Class Reference

#include <workerconfig.h>

Inheritance diagram for KIO::WorkerConfig:

Signals
void	configNeeded (const QString &protocol, const QString &host)

Public Member Functions
MetaData	configData (const QString &protocol, const QString &host)
QString	configData (const QString &protocol, const QString &host, const QString &key)
void	reset ()
void	setConfigData (const QString &protocol, const QString &host, const MetaData &config)
void	setConfigData (const QString &protocol, const QString &host, const QString &key, const QString &value)
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 WorkerConfig *	self ()
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)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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)

Detailed Description

This class manages the configuration for KIO workers based on protocol and host.

The Scheduler makes use of this class to configure the worker whenever it has to connect to a new host.

You only need to use this class if you want to override specific configuration items of an KIO worker when the worker is used by your application.

Normally KIO workers are being configured by "kio_<protocol>rc" configuration files. Groups defined in such files are treated as host or domain specification. Configuration items defined in a group are only applied when the worker is connecting with a host that matches with the host and/or domain specified by the group.

Definition at line 35 of file workerconfig.h.

Constructor & Destructor Documentation

~WorkerConfig()

KIO::WorkerConfig::~WorkerConfig ( )

override

Definition at line 157 of file workerconfig.cpp.

WorkerConfig()

KIO::WorkerConfig::WorkerConfig ( )

protected

Definition at line 151 of file workerconfig.cpp.

Member Function Documentation

configData() [1/2]

MetaData KIO::WorkerConfig::configData	(	const QString &	protocol,
		const QString &	host )

Query worker configuration for workers of type protocol when dealing with host.

Definition at line 189 of file workerconfig.cpp.

configData() [2/2]

QString KIO::WorkerConfig::configData	(	const QString &	protocol,
		const QString &	host,
		const QString &	key )

Query a specific configuration key for workers of type protocol when dealing with host.

Definition at line 208 of file workerconfig.cpp.

configNeeded

void KIO::WorkerConfig::configNeeded ( const QString & protocol, const QString & host )

signal

This signal is raised when a worker of type protocol deals with host for the first time.

Your application can use this signal to make some last minute configuration changes with setConfigData based on the host.

reset()

void KIO::WorkerConfig::reset

(

)

Undo any changes made by calls to setConfigData.

Definition at line 213 of file workerconfig.cpp.

self()

WorkerConfig * KIO::WorkerConfig::self ( )

static

Definition at line 146 of file workerconfig.cpp.

setConfigData() [1/2]

void KIO::WorkerConfig::setConfigData	(	const QString &	protocol,
		const QString &	host,
		const MetaData &	config )

Configure workers of type protocol with config.

If host is specified the configuration only applies when dealing with host.

Changes made to the worker configuration only apply to workers used by the current process.

Definition at line 169 of file workerconfig.cpp.

setConfigData() [2/2]

void KIO::WorkerConfig::setConfigData	(	const QString &	protocol,
		const QString &	host,
		const QString &	key,
		const QString &	value )

Configure workers of type protocol by setting key to value.

If host is specified the configuration only applies when dealing with host.

Changes made to the worker configuration only apply to workers used by the current process.

Definition at line 162 of file workerconfig.cpp.

---

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

• workerconfig.h
• workerconfig.cpp