KUtils
KCMultiDialog Class Reference
#include <kcmultidialog.h>

Detailed Description
A class that offers a KPageDialog containing arbitrary KControl Modules.
Definition at line 37 of file kcmultidialog.h.
Signals | |
void | configCommitted (const QByteArray &componentName) |
void | configCommitted () |
Public Member Functions | |
KPageWidgetItem * | addModule (const KCModuleInfo &moduleinfo, KPageWidgetItem *parent=0, const QStringList &args=QStringList()) |
KPageWidgetItem * | addModule (const QString &module, const QStringList &args=QStringList()) |
void | clear () |
KCMultiDialog (QWidget *parent=0) | |
virtual | ~KCMultiDialog () |
Protected Slots | |
void | slotApplyClicked () |
void | slotDefaultClicked () |
void | slotHelpClicked () |
void | slotOkClicked () |
void | slotUser1Clicked () |
Protected Member Functions | |
KCMultiDialog (KCMultiDialogPrivate &dd, KPageWidget *pageWidget, QWidget *parent, Qt::WFlags flags=0) | |
KCMultiDialog (KPageWidget *pageWidget, QWidget *parent, Qt::WFlags flags=0) |
Constructor & Destructor Documentation
KCMultiDialog::KCMultiDialog | ( | QWidget * | parent = 0 |
) |
Constructs a new KCMultiDialog.
- Parameters:
-
parent The parent widget
Definition at line 129 of file kcmultidialog.cpp.
KCMultiDialog::~KCMultiDialog | ( | ) | [virtual] |
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 135 of file kcmultidialog.cpp.
KCMultiDialog::KCMultiDialog | ( | KCMultiDialogPrivate & | dd, | |
KPageWidget * | pageWidget, | |||
QWidget * | parent, | |||
Qt::WFlags | flags = 0 | |||
) | [protected] |
Definition at line 141 of file kcmultidialog.cpp.
Member Function Documentation
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 its created
Definition at line 267 of file kcmultidialog.cpp.
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 its created
- Returns:
- The
- See also:
- KPageWidgetItem associated with the new dialog page.
Definition at line 255 of file kcmultidialog.cpp.
void KCMultiDialog::clear | ( | ) |
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::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::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 215 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 151 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 231 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 223 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 167 of file kcmultidialog.cpp.
The documentation for this class was generated from the following files: