kio Library API Documentation

KIO::SlaveConfig Class Reference

SlaveConfig. More...

#include <slaveconfig.h>

Inheritance diagram for KIO::SlaveConfig:

QObject List of all members.

Signals

void configNeeded (const QString &protocol, const QString &host)
 This signal is raised when a slave of type protocol deals with host for the first time.


Public Methods

void setConfigData (const QString &protocol, const QString &host, const QString &key, const QString &value)
 Configure slaves of type protocol by setting key to value.

void setConfigData (const QString &protocol, const QString &host, const MetaData &config)
 Configure slaves of type protocol with config.

MetaData configData (const QString &protocol, const QString &host)
 Query slave configuration for slaves of type protocol when dealing with host.

QString configData (const QString &protocol, const QString &host, const QString &key)
 Query a specific configuration key for slaves of type protocol when dealing with host.

void reset ()
 Undo any changes made by calls to setConfigData.


Detailed Description

SlaveConfig.

This class manages the configuration for io-slaves based on protocol and host. The Scheduler makes use of this class to configure the slave 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 io-slave when the io-slave is used by your application.

Normally io-slaves 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 slave is connecting with a host that matches with the host and/or domain specified by the group.

Definition at line 49 of file slaveconfig.h.


Member Function Documentation

void KIO::SlaveConfig::setConfigData const QString   protocol,
const QString   host,
const QString   key,
const QString   value
 

Configure slaves of type protocol by setting key to value.

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

Changes made to the slave configuration only apply to slaves used by the current process.

Definition at line 159 of file slaveconfig.cpp.

References QMap< QString, QString >::insert(), and KStdAccel::key().

void KIO::SlaveConfig::setConfigData const QString   protocol,
const QString   host,
const MetaData &    config
 

Configure slaves of type protocol with config.

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

Changes made to the slave configuration only apply to slaves used by the current process.

Definition at line 169 of file slaveconfig.cpp.

References QString::isEmpty().

MetaData KIO::SlaveConfig::configData const QString   protocol,
const QString   host
 

Query slave configuration for slaves of type protocol when dealing with host.

Definition at line 193 of file slaveconfig.cpp.

References configNeeded(), and QString::isEmpty().

Referenced by configData().

QString KIO::SlaveConfig::configData const QString   protocol,
const QString   host,
const QString   key
 

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

Definition at line 212 of file slaveconfig.cpp.

References configData(), and KStdAccel::key().

void KIO::SlaveConfig::reset  
 

Undo any changes made by calls to setConfigData.

Definition at line 217 of file slaveconfig.cpp.

void KIO::SlaveConfig::configNeeded const QString   protocol,
const QString   host
[signal]
 

This signal is raised when a slave 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.

Referenced by configData().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:39 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001