kdecore Library API Documentation

KConfigDialogManager Class Reference

Provides a means of automatically retrieving, saving and resetting KConfigSkeleton based settings in a dialog. More...

#include <kconfigdialogmanager.h>

Inheritance diagram for KConfigDialogManager:

QObject List of all members.

Public Slots

void updateSettings ()
void updateWidgets ()
void updateWidgetsDefault ()

Signals

void settingsChanged ()
void settingsChanged (QWidget *widget)
void widgetModified ()

Public Member Functions

 KConfigDialogManager (QWidget *parent, KConfigSkeleton *conf, const char *name=0)
 ~KConfigDialogManager ()
void addWidget (QWidget *widget)
bool hasChanged ()
bool isDefault ()

Protected Member Functions

void init (bool trackChanges)
bool parseChildren (const QWidget *widget, bool trackChanges)
void setProperty (QWidget *w, const QVariant &v)
QVariant property (QWidget *w)
void setupWidget (QWidget *widget, KConfigSkeletonItem *item)

Protected Attributes

KConfigSkeletonm_conf
QWidgetm_dialog
QSqlPropertyMappropertyMap
QMap< QString, QCStringchangedMap

Detailed Description

Provides a means of automatically retrieving, saving and resetting KConfigSkeleton based settings in a dialog.

The KConfigDialogManager class provides a means of automatically retrieving, saving and resetting basic settings. It also can emit signals when settings have been changed (settings were saved) or modified (the user changes a checkbox from on to off).

The names of the widgets to be managed have to correspond to the names of the configuration entries in the KConfigSkeleton object plus an additional "kcfg_" prefix. For example a widget named "kcfg_MyOption" would be associated to the configuration entry "MyOption".

KConfigDialogManager uses the QSqlPropertyMap class to determine if it can do anything to a widget. Note that KConfigDialogManager doesn't require a database, it simply uses the functionality that is built into the QSqlPropertyMap class. New widgets can be added to the map using QSqlPropertyMap::installDefaultMap(). Note that you can't just add any class. The class must have a matching Q_PROPERTY(...) macro defined.

For example (note that KColorButton is already added and it doesn't need to manually added):

kcolorbutton.h defines the following property:

Q_PROPERTY( QColor color READ color WRITE setColor )

To add KColorButton the following code would be inserted in the main.

If you add a new widget to the QSqlPropertyMap and wish to be notified when it is modified you should add its signal using addWidgetChangedSignal().

Since:
3.2
Author:
Benjamin C Meyer <ben+kdelibs at meyerhome dot net>

Waldo Bastian <bastian@kde.org>

Definition at line 77 of file kconfigdialogmanager.h.


Constructor & Destructor Documentation

KConfigDialogManager::KConfigDialogManager QWidget parent,
KConfigSkeleton conf,
const char *  name = 0
 

Constructor.

Parameters:
parent Dialog widget to manage
conf Object that contains settings
name - Object name.

Definition at line 48 of file kconfigdialogmanager.cpp.

References QSqlPropertyMap::defaultMap(), init(), KConfigDialogManager(), m_conf, m_dialog, and propertyMap.

Referenced by KConfigDialogManager().

KConfigDialogManager::~KConfigDialogManager  ) 
 

Destructor.

Definition at line 59 of file kconfigdialogmanager.cpp.


Member Function Documentation

void KConfigDialogManager::settingsChanged  )  [signal]
 

One or more of the settings have been saved (such as when the user clicks on the Apply button).

This is only emitted by updateSettings() whenever one or more setting were changed and consequently saved.

Referenced by updateSettings().

void KConfigDialogManager::settingsChanged QWidget widget  )  [signal]
 

TODO: Verify One or more of the settings have been changed.

Parameters:
widget - The widget group (pass in via addWidget()) that contains the one or more modified setting.
See also:
settingsChanged()

void KConfigDialogManager::widgetModified  )  [signal]
 

If retrieveSettings() was told to track changes then if any known setting was changed this signal will be emitted.

Note that a settings can be modified several times and might go back to the original saved state. hasChanged() will tell you if anything has actually changed from the saved values.

Referenced by parseChildren().

void KConfigDialogManager::addWidget QWidget widget  ) 
 

Add additional widgets to manage.

Parameters:
widget Additional widget to manage, inlcuding all its children

Definition at line 116 of file kconfigdialogmanager.cpp.

References addWidget(), and parseChildren().

Referenced by addWidget().

bool KConfigDialogManager::hasChanged  ) 
 

Returns whether the current state of the known widgets are different from the state in the config object.

Definition at line 324 of file kconfigdialogmanager.cpp.

References QDictIterator::current(), QDictIterator::currentKey(), endl(), KConfigSkeleton::findItem(), m_conf, KConfigSkeletonItem::property(), and property().

Referenced by isDefault().

bool KConfigDialogManager::isDefault  ) 
 

Returns whether the current state of the known widgets are the same as the default state in the config object.

Definition at line 348 of file kconfigdialogmanager.cpp.

References hasChanged(), m_conf, and KConfigSkeleton::useDefaults().

void KConfigDialogManager::updateSettings  )  [slot]
 

Traverse the specified widgets, saving the settings of all known widgets in the settings object.

Example use: User clicks Ok or Apply button in a configure dialog.

Definition at line 263 of file kconfigdialogmanager.cpp.

References QDictIterator::current(), QDictIterator::currentKey(), endl(), KConfigSkeleton::findItem(), m_conf, KConfigSkeletonItem::property(), property(), KConfigSkeletonItem::setProperty(), settingsChanged(), and KConfigSkeleton::writeConfig().

void KConfigDialogManager::updateWidgets  )  [slot]
 

Traverse the specified widgets, sets the state of all known widgets according to the state in the settings object.

Example use: Initialisation of dialog. Example use: User clicks Reset button in a configure dialog.

Definition at line 224 of file kconfigdialogmanager.cpp.

References QDictIterator::current(), QDictIterator::currentKey(), endl(), KConfigSkeleton::findItem(), KConfigSkeletonItem::isImmutable(), m_conf, property(), KConfigSkeletonItem::property(), QWidget::setEnabled(), setProperty(), and QObject::signalsBlocked().

Referenced by updateWidgetsDefault().

void KConfigDialogManager::updateWidgetsDefault  )  [slot]
 

Traverse the specified widgets, sets the state of all known widgets according to the default state in the settings object.

Example use: User clicks Defaults button in a configure dialog.

Definition at line 256 of file kconfigdialogmanager.cpp.

References m_conf, updateWidgets(), and KConfigSkeleton::useDefaults().

void KConfigDialogManager::init bool  trackChanges  )  [protected]
 

Parameters:
trackChanges - If any changes by the widgets should be tracked set true. This causes the emitting the modified() signal when something changes. TODO:
Returns:
bool - True if any setting was changed from the default.

Definition at line 64 of file kconfigdialogmanager.cpp.

References changedMap, init(), QMap< QString, QCString >::insert(), m_dialog, and parseChildren().

Referenced by init(), and KConfigDialogManager().

bool KConfigDialogManager::parseChildren const QWidget widget,
bool  trackChanges
[protected]
 

Recursive function that finds all known children.

Goes through the children of widget and if any are known and not being ignored, stores them in currentGroup. Also checks if the widget should be disabled because it is set immutable.

Parameters:
widget - Parent of the children to look at.
trackChanges - If true then tracks any changes to the children of widget that are known.
Returns:
bool - If a widget was set to something other then its default.

Definition at line 137 of file kconfigdialogmanager.cpp.

References changedMap, QPtrListIterator::current(), QComboBox::editable(), QMap< QString, QCString >::end(), endl(), QMap< QString, QCString >::find(), KConfigSkeleton::findItem(), QObject::isWidgetType(), m_conf, parseChildren(), setupWidget(), and widgetModified().

Referenced by addWidget(), init(), and parseChildren().

void KConfigDialogManager::setProperty QWidget w,
const QVariant v
[protected]
 

Set a property.

Definition at line 292 of file kconfigdialogmanager.cpp.

References QComboBox::editable(), propertyMap, QButtonGroup::setButton(), QComboBox::setCurrentText(), QSqlPropertyMap::setProperty(), setProperty(), QVariant::toInt(), and QVariant::toString().

Referenced by setProperty(), and updateWidgets().

QVariant KConfigDialogManager::property QWidget w  )  [protected]
 

Retrieve a property.

Definition at line 311 of file kconfigdialogmanager.cpp.

References QComboBox::currentText(), QComboBox::editable(), QSqlPropertyMap::property(), property(), propertyMap, and QButtonGroup::selectedId().

Referenced by hasChanged(), property(), updateSettings(), and updateWidgets().

void KConfigDialogManager::setupWidget QWidget widget,
KConfigSkeletonItem item
[protected]
 

Setup secondary widget properties.

Definition at line 121 of file kconfigdialogmanager.cpp.

References QVariant::isValid(), KConfigSkeletonItem::maxValue(), KConfigSkeletonItem::minValue(), and setupWidget().

Referenced by parseChildren(), and setupWidget().


Member Data Documentation

KConfigSkeleton* KConfigDialogManager::m_conf [protected]
 

KConfigSkeleton object used to store settings.

Definition at line 208 of file kconfigdialogmanager.h.

Referenced by hasChanged(), isDefault(), KConfigDialogManager(), parseChildren(), updateSettings(), updateWidgets(), and updateWidgetsDefault().

QWidget* KConfigDialogManager::m_dialog [protected]
 

Dialog being managed.

Definition at line 213 of file kconfigdialogmanager.h.

Referenced by init(), and KConfigDialogManager().

QSqlPropertyMap* KConfigDialogManager::propertyMap [protected]
 

Pointer to the property map for easy access.

Definition at line 218 of file kconfigdialogmanager.h.

Referenced by KConfigDialogManager(), property(), and setProperty().

QMap<QString, QCString> KConfigDialogManager::changedMap [protected]
 

Map of the classes and the signals that they emit when changed.

Definition at line 223 of file kconfigdialogmanager.h.

Referenced by init(), and parseChildren().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdecore Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 12 15:08:02 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003