libkdepim Library API Documentation

KPrefsDialog Class Reference

Base class for a preferences dialog. More...

#include <kprefsdialog.h>

Inheritance diagram for KPrefsDialog:

KPrefsWidManager List of all members.

Public Slots

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

Signals

void configChanged ()

Public Methods

 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 Methods

virtual void usrReadConfig ()
virtual void usrWriteConfig ()

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 498 of file kprefsdialog.h.


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 509 of file kprefsdialog.cpp.

KPrefsDialog::~KPrefsDialog   [virtual]
 

Destructor.

Definition at line 522 of file kprefsdialog.cpp.


Member Function Documentation

void KPrefsDialog::setDefaults   [slot]
 

Set all widgets to default values.

Definition at line 587 of file kprefsdialog.cpp.

References KPrefsWidManager::setWidDefaults().

Referenced by slotDefault().

void KPrefsDialog::readConfig   [slot]
 

Read preferences from config file.

Definition at line 592 of file kprefsdialog.cpp.

References KPrefsWidManager::readWidConfig(), and usrReadConfig().

Referenced by writeConfig().

void KPrefsDialog::writeConfig   [slot]
 

Write preferences to config file.

Definition at line 599 of file kprefsdialog.cpp.

References readConfig(), usrWriteConfig(), and KPrefsWidManager::writeWidConfig().

Referenced by slotApply().

void KPrefsDialog::configChanged   [signal]
 

Emitted when the a changed configuration has been stored.

Referenced by slotApply().

void KPrefsDialog::slotApply   [protected, slot]
 

Apply changes to preferences.

Definition at line 609 of file kprefsdialog.cpp.

References configChanged(), and writeConfig().

Referenced by slotOk().

void KPrefsDialog::slotOk   [protected, slot]
 

Accept changes to preferences and close dialog.

Definition at line 615 of file kprefsdialog.cpp.

References slotApply().

void KPrefsDialog::slotDefault   [protected, slot]
 

Set preferences to default values.

Definition at line 621 of file kprefsdialog.cpp.

References setDefaults().

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

Implement this to read custom configuration widgets.

Definition at line 545 of file kprefsdialog.h.

Referenced by readConfig().

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

Implement this to write custom configuration widgets.

Definition at line 547 of file kprefsdialog.h.

Referenced by writeConfig().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkdepim Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:32 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003