KConfigDialog Class Reference

#include <kconfigdialog.h>

Inheritance diagram for KConfigDialog:

List of all members.

Signals
void	settingsChanged (const QString &dialogName)
void	widgetModified ()
Public Member Functions
	KConfigDialog (QWidget *parent, const QString &name, KConfigSkeleton *config)
	KConfigDialog (QWidget *parent, const QString &name, KCoreConfigSkeleton *config)
	~KConfigDialog ()
KPageWidgetItem *	addPage (QWidget *page, const QString &itemName, const QString &pixmapName=QString(), const QString &header=QString(), bool manage=true)
KPageWidgetItem *	addPage (QWidget *page, KConfigSkeleton *config, const QString &itemName, const QString &pixmapName=QString(), const QString &header=QString())
Static Public Member Functions
static KConfigDialog *	exists (const QString &name)
static bool	showDialog (const QString &name)
Protected Slots
void	settingsChangedSlot ()
void	updateButtons ()
virtual void	updateSettings ()
virtual void	updateWidgets ()
virtual void	updateWidgetsDefault ()
Protected Member Functions
virtual bool	hasChanged ()
virtual bool	isDefault ()
virtual void	showEvent (QShowEvent *e)

---

Detailed Description

Standard KDE configuration dialog class.

The KConfigDialog class provides an easy and uniform means of displaying a settings dialog using KPageDialog, KConfigDialogManager and a KConfigSkeleton derived settings class.

KConfigDialog handles the enabling and disabling of buttons, creation of the dialog, and deletion of the widgets. Because of KConfigDialogManager, this class also manages: restoring the settings, reseting them to the default values, and saving them. This requires that the names of the widgets corresponding to configuration entries have to have the same name plus an additional "kcfg_" prefix. For example the widget named "kcfg_MyOption" would be associated with the configuration entry "MyOption".

Here is an example usage of KConfigDialog:

 void KCoolApp::showSettings(){
   if(KConfigDialog::showDialog("settings"))
     return;
   KConfigDialog *dialog = new KConfigDialog(this, "settings", MySettings::self());
   dialog->setFaceType(KPageDialog::List);
   dialog->addPage(new General(0, "General"), i18n("General") );
   dialog->addPage(new Appearance(0, "Style"), i18n("Appearance") );
   connect(dialog, SIGNAL(settingsChanged(const QString&)), mainWidget, SLOT(loadSettings()));
   connect(dialog, SIGNAL(settingsChanged(const QString&)), this, SLOT(loadSettings()));
   dialog->show();
 }

Other than the above code, each class that has settings in the dialog should have a loadSettings() type slot to read settings and perform any necessary changes.

For dialog appearance options (like buttons, default button, ...) please see

See also:

KPageDialog

KConfigSkeleton

Author:

Waldo Bastian basti.nosp@m.an@k.nosp@m.de.or.nosp@m.g

Definition at line 73 of file kconfigdialog.h.

---

Constructor & Destructor Documentation

KConfigDialog::KConfigDialog	(	QWidget *	parent,
		const QString &	name,
		KConfigSkeleton *	config
	)

Parameters:

parent	- The parent of this object. Even though the class deletes itself the parent should be set so the dialog can be centered with the application on the screen.
name	- The name of this object. The name is used in determining if there can be more than one dialog at a time. Use names such as: "Font Settings" or "Color Settings" and not just "Settings" in applications where there is more than one dialog.
config	- Config object containing settings.

Definition at line 94 of file kconfigdialog.cpp.

KConfigDialog::KConfigDialog	(	QWidget *	parent,
		const QString &	name,
		KCoreConfigSkeleton *	config
	)

Since:

4.8.1

Parameters:

parent	- The parent of this object. Even though the class deletes itself the parent should be set so the dialog can be centered with the application on the screen.
name	- The name of this object. The name is used in determining if there can be more than one dialog at a time. Use names such as: "Font Settings" or "Color Settings" and not just "Settings" in applications where there is more than one dialog.
config	- Config object containing settings.

Definition at line 101 of file kconfigdialog.cpp.

KConfigDialog::~KConfigDialog

(

)

Deconstructor, removes name from the list of open dialogs.

Deletes private class.

See also:

exists()

Definition at line 108 of file kconfigdialog.cpp.

---

Member Function Documentation

KPageWidgetItem * KConfigDialog::addPage	(	QWidget *	page,
		const QString &	itemName,
		const QString &	pixmapName = QString(),
		const QString &	header = QString(),
		bool	manage = true
	)

Adds page to the dialog and to KConfigDialogManager.

When an application is done adding pages show() should be called to display the dialog.

Parameters:

page	- Pointer to the page that is to be added to the dialog. This object is reparented.
itemName	- Name of the page.
pixmapName	- Name of the icon that should be used, if needed, when displaying the page. The string may either be the name of a themed icon (e.g. "document-save"), which the internal icon loader will be used to retrieve, or an absolute path to the pixmap on disk.
header	- Header text use in the list modes. Ignored in Tabbed mode. If empty, the itemName text is used when needed.
manage	- Whether KConfigDialogManager should manage the page or not.

Returns:

The KPageWidgetItem associated with the page.

Definition at line 114 of file kconfigdialog.cpp.

KPageWidgetItem * KConfigDialog::addPage	(	QWidget *	page,
		KConfigSkeleton *	config,
		const QString &	itemName,
		const QString &	pixmapName = QString(),
		const QString &	header = QString()
	)

Adds page to the dialog that is managed by a custom KConfigDialogManager.

This is useful for dialogs that contain settings spread over more than one configuration file and thus have/need more than one KConfigSkeleton. When an application is done adding pages show() should be called to display the dialog.

Parameters:

page	- Pointer to the page that is to be added to the dialog. This object is reparented.
config	- Config object containing corresponding settings.
itemName	- Name of the page.
pixmapName	- Name of the icon that should be used, if needed, when displaying the page. The string may either be the name of a themed icon (e.g. "document-save"), which the internal icon loader will be used to retrieve, or an absolute path to the pixmap on disk.
header	- Header text use in the list modes. Ignored in Tabbed mode. If empty, the itemName text is used when needed.

Returns:

The KPageWidgetItem associated with the page.

Definition at line 138 of file kconfigdialog.cpp.

KConfigDialog * KConfigDialog::exists

(

const QString &

name

)

[static]

See if a dialog with the name 'name' already exists.

See also:

showDialog()

Parameters:

name	- Dialog name to look for.

Returns:

Pointer to widget or NULL if it does not exist.

Definition at line 209 of file kconfigdialog.cpp.

bool KConfigDialog::hasChanged

(

)

[protected, virtual]

Returns whether the current state of the dialog is different from the current configuration.

Virtual function for custom additions.

Definition at line 311 of file kconfigdialog.cpp.

bool KConfigDialog::isDefault

(

)

[protected, virtual]

Returns whether the current state of the dialog is the same as the default configuration.

Definition at line 316 of file kconfigdialog.cpp.

void KConfigDialog::settingsChanged

(

const QString &

dialogName

)

[signal]

One or more of the settings have been permanently changed such as if the user clicked on the Apply or Ok button.

Parameters:

dialogName

the name of the dialog.

void KConfigDialog::settingsChangedSlot

(

)

[protected, slot]

Some setting was changed.

Emit the signal with the dialogs name. Connect to this slot if there are widgets not managed by KConfig.

Since:

4.3

Definition at line 326 of file kconfigdialog.cpp.

bool KConfigDialog::showDialog

(

const QString &

name

)

[static]

Attempts to show the dialog with the name 'name'.

See also:

exists()

Parameters:

name	- The name of the dialog to show.

Returns:

True if the dialog 'name' exists and was shown.

Definition at line 217 of file kconfigdialog.cpp.

void KConfigDialog::showEvent

(

QShowEvent *

e

)

[protected, virtual]

Definition at line 264 of file kconfigdialog.cpp.

void KConfigDialog::updateButtons

(

)

[protected, slot]

Updates the Apply and Default buttons.

Connect to this slot if you implement you own hasChanged() or isDefault() methods for widgets not managed by KConfig.

Since:

4.3

Definition at line 321 of file kconfigdialog.cpp.

void KConfigDialog::updateSettings

(

)

[protected, virtual, slot]

Update the settings from the dialog.

Virtual function for custom additions.

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

Definition at line 299 of file kconfigdialog.cpp.

void KConfigDialog::updateWidgets

(

)

[protected, virtual, slot]

Update the dialog based on the settings.

Virtual function for custom additions.

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

Definition at line 303 of file kconfigdialog.cpp.

void KConfigDialog::updateWidgetsDefault

(

)

[protected, virtual, slot]

Update the dialog based on the default settings.

Virtual function for custom additions.

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

Definition at line 307 of file kconfigdialog.cpp.

void KConfigDialog::widgetModified

(

)

[signal]

A widget in the dialog was modified.

---

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

• kconfigdialog.h
• kconfigdialog.cpp