KCMultiDialog Class

A class that offers a KPageDialog containing config modules. More...

Header:	`#include <KCMultiDialog>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS KCMUtils)` `target_link_libraries(mytarget PRIVATE KF6::KCMUtils)`

List of all members, including inherited members

Public Functions

	KCMultiDialog(QWidget *parent = nullptr)
KPageWidgetItem *	addModule(const KPluginMetaData &metaData, const QVariantList &args = {})
void	clear()
`(since 6.0)` void	setDefaultsIndicatorsVisible(bool show)

Signals

void	configCommitted()

Protected Slots

void	slotApplyClicked()
void	slotDefaultClicked()
void	slotHelpClicked()
void	slotOkClicked()
void	slotUser1Clicked()

Detailed Description

Member Function Documentation

`[explicit]` KCMultiDialog::KCMultiDialog(QWidget **parent* = nullptr)

Constructs a new KCMultiDialog.

parent The parent widget.

KPageWidgetItem KCMultiDialog::addModule(const KPluginMetaData &metaData, const QVariantList &args* = {})

Adds a module to the dialog. Its position will be determined based on the X-KDE-Weight value.

metaData KPluginMetaData that will be used to load the plugin.

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

void KCMultiDialog::clear()

Removes all modules from the dialog.

`[signal]` void KCMultiDialog::configCommitted()

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

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

`[since 6.0]` void KCMultiDialog::setDefaultsIndicatorsVisible(bool show)

Whether to show or hide an indicator when settings have changed from their default value.

This function was introduced in 6.0.

`[protected slot]` void KCMultiDialog::slotApplyClicked()

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.

`[protected slot]` void KCMultiDialog::slotDefaultClicked()

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.

`[protected slot]` void KCMultiDialog::slotHelpClicked()

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.

`[protected slot]` void KCMultiDialog::slotOkClicked()

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.

`[protected slot]` void KCMultiDialog::slotUser1Clicked()

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.