KCMultiDialog Class Reference

A class that offers a KPageDialog containing arbitrary KControl Modules. More...

#include <kcmultidialog.h>

Inheritance diagram for KCMultiDialog:

List of all members.

Signals
void	configCommitted ()
void	configCommitted (const QByteArray &componentName)
Public Member Functions
	KCMultiDialog (QWidget *parent=0)
virtual	~KCMultiDialog ()
KPageWidgetItem *	addModule (const KCModuleInfo &moduleinfo, KPageWidgetItem *parent=0, const QStringList &args=QStringList())
KPageWidgetItem *	addModule (const QString &module, const QStringList &args=QStringList())
void	clear ()
void	setButtons (ButtonCodes buttonMask)
Protected Slots
void	slotApplyClicked ()
void	slotDefaultClicked ()
void	slotHelpClicked ()
void	slotOkClicked ()
void	slotUser1Clicked ()
Protected Member Functions
	KCMultiDialog (KPageWidget *pageWidget, QWidget *parent, Qt::WFlags flags=0)
	KCMultiDialog (KCMultiDialogPrivate &dd, KPageWidget *pageWidget, QWidget *parent, Qt::WFlags flags=0)

---

Detailed Description

A class that offers a KPageDialog containing arbitrary KControl Modules.

Author:

Matthias Elter <elter@kde.org>, Daniel Molkentin <molkentin@kde.org>

Definition at line 37 of file kcmultidialog.h.

---

Constructor & Destructor Documentation

KCMultiDialog::KCMultiDialog

(

QWidget *

parent = 0

)

Constructs a new KCMultiDialog.

Parameters:

parent

The parent widget

Definition at line 227 of file kcmultidialog.cpp.

KCMultiDialog::~KCMultiDialog

(

)

[virtual]

Destructor.

Definition at line 245 of file kcmultidialog.cpp.

KCMultiDialog::KCMultiDialog	(	KPageWidget *	pageWidget,
		QWidget *	parent,
		Qt::WFlags	flags = 0
	)		[protected]

This constructor can be used by subclasses to provide a custom KPageWidget.

Definition at line 233 of file kcmultidialog.cpp.

KCMultiDialog::KCMultiDialog	(	KCMultiDialogPrivate &	dd,
		KPageWidget *	pageWidget,
		QWidget *	parent,
		Qt::WFlags	flags = 0
	)		[protected]

Definition at line 239 of file kcmultidialog.cpp.

---

Member Function Documentation

KPageWidgetItem * KCMultiDialog::addModule	(	const QString &	module,
		const QStringList &	args = QStringList()
	)

Add a module.

The module is added according to its KCModuleInfo::weight(). The weight determines where in the list the module will appear. Lighter modules on top, heavier modules at the bottom.

Parameters:

module	Specify the name of the module that is to be added to the list of modules the dialog will show.
args	The arguments that should be given to the KCModule when it is created

Returns:

The

See also:

KPageWidgetItem associated with the new dialog page.

Definition at line 362 of file kcmultidialog.cpp.

KPageWidgetItem * KCMultiDialog::addModule	(	const KCModuleInfo &	moduleinfo,
		KPageWidgetItem *	parent = 0,
		const QStringList &	args = QStringList()
	)

Add a module.

The module is added according to its KCModuleInfo::weight(). The weight determines where in the list the module will appear. Lighter modules on top, heavier modules at the bottom.

Parameters:

moduleinfo	Pass a KCModuleInfo object which will be used for creating the module. It will be added to the list of modules the dialog will show.
parent	The

See also:

KPageWidgetItem that should appear as parents in the tree view or a 0 pointer if there is no parent.

Parameters:

args	The arguments that should be given to the KCModule when it is created

Definition at line 374 of file kcmultidialog.cpp.

void KCMultiDialog::clear

(

)

Removes all modules from the dialog.

Definition at line 460 of file kcmultidialog.cpp.

void KCMultiDialog::configCommitted

(

)

[signal]

Emitted after all KCModules have been told to save their configuration.

The applyClicked and okClicked signals are emitted before the configuration is saved.

void KCMultiDialog::configCommitted

(

const QByteArray &

componentName

)

[signal]

Emitted after the KCModules have been told to save their configuration.

It is emitted once for every instance the KCMs that were changed belong to.

You can make use of this if you have more than one component in your application. componentName tells you the instance that has to reload its configuration.

The applyClicked and okClicked signals are emitted before the configuration is saved.

Parameters:

componentName

The name of the instance that needs to reload its configuration.

void KCMultiDialog::setButtons

(

ButtonCodes

buttonMask

)

Reimplemented for internal reasons.

Reimplemented from KDialog.

Definition at line 475 of file kcmultidialog.cpp.

void KCMultiDialog::slotApplyClicked

(

)

[protected, slot]

This slot is called when the user presses the "Apply" Button.

You can reimplement it if needed.

Note:

Make sure you call the original implementation.

Definition at line 322 of file kcmultidialog.cpp.

void KCMultiDialog::slotDefaultClicked

(

)

[protected, slot]

This slot is called when the user presses the "Default" Button.

You can reimplement it if needed.

Note:

Make sure you call the original implementation.

Definition at line 249 of file kcmultidialog.cpp.

void KCMultiDialog::slotHelpClicked

(

)

[protected, slot]

This slot is called when the user presses the "Help" Button.

It reads the X-DocPath field of the currently selected KControl module's .desktop file to find the path to the documentation, which it then attempts to load.

You can reimplement this slot if needed.

Note:

Make sure you call the original implementation.

Definition at line 338 of file kcmultidialog.cpp.

void KCMultiDialog::slotOkClicked

(

)

[protected, slot]

This slot is called when the user presses the "OK" Button.

You can reimplement it if needed.

Note:

Make sure you call the original implementation.

Definition at line 330 of file kcmultidialog.cpp.

void KCMultiDialog::slotUser1Clicked

(

)

[protected, slot]

This slot is called when the user presses the "Reset" Button.

You can reimplement it if needed.

Note:

Make sure you call the original implementation.

Definition at line 265 of file kcmultidialog.cpp.

---

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

• kcmultidialog.h
• kcmultidialog.cpp