KDE PIM / Developers / API Docs / libkdepim

KPrefsDialog Class Reference

Base class for a preferences dialog. More...

#include <kprefsdialog.h>

Inherits KDialogBase, and KPrefsWidManager.

List of all members.

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions


Detailed Description

Base class for a preferences dialog.

This class provides the framework for a preferences dialog. You have to subclass it and add the code to create the actual configuration widgets and do the layout management.

KPrefsDialog provides functions to add subclasses of KPrefsWid via KPrefsWidManager. For these widgets the reading, writing and setting to default values is handled automatically. Custom widgets have to be handled in the functions usrReadConfig() and usrWriteConfig().


Constructor & Destructor Documentation

KPrefsDialog::KPrefsDialog KConfigSkeleton *  prefs,
QWidget *  parent = 0,
char *  name = 0,
bool  modal = false
 

Create a KPrefsDialog for a KPrefs object.

Parameters:
prefs KPrefs object used to access te configuration.
parent Parent widget.
name Widget name.
modal true, if dialog has to be modal, false for non-modal.

KPrefsDialog::~KPrefsDialog  )  [virtual]
 

Destructor.


Member Function Documentation

void KPrefsDialog::setDefaults  )  [slot]
 

Set all widgets to default values.

void KPrefsDialog::readConfig  )  [slot]
 

Read preferences from config file.

void KPrefsDialog::writeConfig  )  [slot]
 

Write preferences to config file.

void KPrefsDialog::configChanged  )  [signal]
 

Emitted when the a changed configuration has been stored.

void KPrefsDialog::slotApply  )  [protected, slot]
 

Apply changes to preferences.

void KPrefsDialog::slotOk  )  [protected, slot]
 

Accept changes to preferences and close dialog.

void KPrefsDialog::slotDefault  )  [protected, slot]
 

Set preferences to default values.

virtual void KPrefsDialog::usrReadConfig  )  [inline, protected, virtual]
 

Implement this to read custom configuration widgets.

virtual void KPrefsDialog::usrWriteConfig  )  [inline, protected, virtual]
 

Implement this to write custom configuration widgets.


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