• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KConfigDialogManager Class Reference

#include <kconfigdialogmanager.h>

Inheritance diagram for KConfigDialogManager:

Inheritance graph
[legend]

List of all members.


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".

New widgets can be added to the map using the static functions propertyMap() and changedMap(). Note that you can't just add any class. The class must have a matching Q_PROPERTY(...) macro defined, and a signal which emitted when the property changed. Note: by default, the property which defined as "USER true" is used.

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 USER true )
and signal:
 void changed( const QColor &newColor );

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

 KConfigDialogManager::changedMap()->insert("KColorButton", SIGNAL(changed(const QColor &)));

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

Waldo Bastian <bastian@kde.org>

Definition at line 75 of file kconfigdialogmanager.h.


Public Slots

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

Signals

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

Public Member Functions

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

Static Public Member Functions

static QHash< QString,
QByteArray > * 
changedMap ()
static QHash< QString,
QByteArray > * 
propertyMap ()

Protected Member Functions

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

Static Protected Member Functions

static void initMaps ()

Constructor & Destructor Documentation

KConfigDialogManager::KConfigDialogManager ( QWidget *  parent,
KConfigSkeleton *  conf 
)

Constructor.

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

Definition at line 67 of file kconfigdialogmanager.cpp.

KConfigDialogManager::~KConfigDialogManager (  ) 

Destructor.

Definition at line 75 of file kconfigdialogmanager.cpp.


Member Function Documentation

void KConfigDialogManager::addWidget ( QWidget *  widget  ) 

Add additional widgets to manage.

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

Definition at line 165 of file kconfigdialogmanager.cpp.

QHash< QString, QByteArray > * KConfigDialogManager::changedMap (  )  [static]

Retrieve the widget change map.

Definition at line 150 of file kconfigdialogmanager.cpp.

QByteArray KConfigDialogManager::getUserProperty ( const QWidget *  widget  )  const [protected]

Finds the USER property name using Qt's MetaProperty system, and caches it in the property map (the cache could be retrieved by propertyMap() ).

Definition at line 387 of file kconfigdialogmanager.cpp.

bool KConfigDialogManager::hasChanged (  )  const

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

Definition at line 459 of file kconfigdialogmanager.cpp.

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 156 of file kconfigdialogmanager.cpp.

void KConfigDialogManager::initMaps (  )  [static, protected]

Initializes the property maps.

Definition at line 80 of file kconfigdialogmanager.cpp.

bool KConfigDialogManager::isDefault (  )  const

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

Definition at line 481 of file kconfigdialogmanager.cpp.

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 204 of file kconfigdialogmanager.cpp.

QVariant KConfigDialogManager::property ( QWidget *  w  )  const [protected]

Retrieve a property.

Definition at line 437 of file kconfigdialogmanager.cpp.

QHash< QString, QByteArray > * KConfigDialogManager::propertyMap (  )  [static]

Retrieve the property map.

Definition at line 144 of file kconfigdialogmanager.cpp.

void KConfigDialogManager::setProperty ( QWidget *  w,
const QVariant &  v 
) [protected]

Set a property.

Definition at line 404 of file kconfigdialogmanager.cpp.

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::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.

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

Setup secondary widget properties.

Definition at line 170 of file kconfigdialogmanager.cpp.

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 358 of file kconfigdialogmanager.cpp.

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 312 of file kconfigdialogmanager.cpp.

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 351 of file kconfigdialogmanager.cpp.

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.


The documentation for this class was generated from the following files:
  • kconfigdialogmanager.h
  • kconfigdialogmanager.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal