libkdepim

KPrefsDialog Class Reference

#include <kprefsdialog.h>

Inheritance diagram for KPrefsDialog:

KPrefsWidManager List of all members.

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().

Definition at line 672 of file kprefsdialog.h.


Public Slots

void setDefaults ()
void readConfig ()
void writeConfig ()

Signals

void configChanged ()

Public Member Functions

 KPrefsDialog (KConfigSkeleton *prefs, QWidget *parent=0, char *name=0, bool modal=false)
virtual ~KPrefsDialog ()
void autoCreate ()

Protected Slots

void slotApply ()
void slotOk ()
void slotDefault ()

Protected Member Functions

virtual void usrReadConfig ()
virtual void 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.

Definition at line 687 of file kprefsdialog.cpp.

KPrefsDialog::~KPrefsDialog (  )  [virtual]

Destructor.

Definition at line 700 of file kprefsdialog.cpp.


Member Function Documentation

void KPrefsDialog::setDefaults (  )  [slot]

Set all widgets to default values.

Definition at line 765 of file kprefsdialog.cpp.

void KPrefsDialog::readConfig (  )  [slot]

Read preferences from config file.

Definition at line 770 of file kprefsdialog.cpp.

void KPrefsDialog::writeConfig (  )  [slot]

Write preferences to config file.

Definition at line 777 of file kprefsdialog.cpp.

void KPrefsDialog::configChanged (  )  [signal]

Emitted when the a changed configuration has been stored.

void KPrefsDialog::slotApply (  )  [protected, slot]

Apply changes to preferences.

Definition at line 787 of file kprefsdialog.cpp.

void KPrefsDialog::slotOk (  )  [protected, slot]

Accept changes to preferences and close dialog.

Definition at line 793 of file kprefsdialog.cpp.

void KPrefsDialog::slotDefault (  )  [protected, slot]

Set preferences to default values.

Definition at line 799 of file kprefsdialog.cpp.

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

Implement this to read custom configuration widgets.

Definition at line 719 of file kprefsdialog.h.

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

Implement this to write custom configuration widgets.

Definition at line 721 of file kprefsdialog.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys