kutils Library API Documentation

KSettings::Dispatcher Class Reference

Dispatch change notifications from the KCMs to the program. More...

#include <dispatcher.h>

Inheritance diagram for KSettings::Dispatcher:

QObject List of all members.

Public Slots

void reparseConfiguration (const QCString &instanceName)
void syncConfiguration ()

Public Methods

void registerInstance (KInstance *instance, QObject *recv, const char *slot)
KConfigconfigForInstanceName (const QCString &instanceName)
QStrList instanceNames () const

Static Public Methods

Dispatcher * self ()

Detailed Description

Dispatch change notifications from the KCMs to the program.

Since your program does not have direct control over the KCMs that get loaded into the KConfigureDialog you need a way to get notified. This is what you do:

 Dispatcher::self()->registerInstance( instance(), this, SLOT( loadSettings() ) );

Author:
Matthias Kretz <kretz@kde.org>
Since:
3.2

Definition at line 49 of file dispatcher.h.


Member Function Documentation

Dispatcher * KSettings::Dispatcher::self   [static]
 

Get a reference the the Dispatcher object.

Definition at line 40 of file dispatcher.cpp.

References KStaticDeleter< type >::setObject().

void KSettings::Dispatcher::registerInstance KInstance   instance,
QObject   recv,
const char *    slot
 

Register a slot to be called when the configuration for the instance has changed.

instance is the KInstance object that is passed to KGenericFactory (if it is used). You can query it with KGenericFactory<YourClassName>::instance(). instance->instanceName() is also the same name that is put into the .desktop file of the KCMs for the X-KDE-ParentComponents.

Parameters:
instance  The KInstance object
recv  The object that should receive the signal
slot  The slot to be called: SLOT( slotName() )

Definition at line 61 of file dispatcher.cpp.

References QObject::connect(), QSignal::connect(), QMap< QCString, InstanceInfo >::contains(), QObject::destroyed(), KNotifyClient::instance(), and KInstance::instanceName().

KConfig * KSettings::Dispatcher::configForInstanceName const QCString   instanceName
 

Returns:
the KConfig object that belongs to the instanceName

Definition at line 86 of file dispatcher.cpp.

References KInstance::config(), and QMap< QCString, InstanceInfo >::contains().

QStrList KSettings::Dispatcher::instanceNames  
 

Returns:
a list of all the instance names that are currently registered

Definition at line 100 of file dispatcher.cpp.

References QMap< QCString, InstanceInfo >::begin(), and QMap< QCString, InstanceInfo >::end().

void KSettings::Dispatcher::reparseConfiguration const QCString   instanceName [slot]
 

Call this slot when the configuration belonging to the associated instance name has changed.

The registered slot will be called.

Parameters:
instanceName  The value of X-KDE-ParentComponents.

Definition at line 110 of file dispatcher.cpp.

References QSignal::activate(), and QMap< QCString, InstanceInfo >::contains().

void KSettings::Dispatcher::syncConfiguration   [slot]
 

When this slot is called the KConfig objects of all the registered instances are sync()ed.

This is usefull when some other KConfig objects will read/write from/to the same config file, so that you can first write out the current state of the KConfig objects.

Definition at line 127 of file dispatcher.cpp.

References QMap< QCString, InstanceInfo >::begin(), and QMap< QCString, InstanceInfo >::end().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kutils Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:24:52 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003