KPIM::KPrefsDialog Class Reference

#include <kprefsdialog.h>

Inheritance diagram for KPIM::KPrefsDialog:

Public Slots
void	readConfig ()
void	setDefaults ()
void	writeConfig ()

Signals
void	configChanged ()

Public Member Functions
	KPrefsDialog (KConfigSkeleton *prefs, QWidget *parent=0, bool modal=false)
virtual	~KPrefsDialog ()
void	autoCreate ()
Public Member Functions inherited from KPIM::KPrefsWidManager
	KPrefsWidManager (KConfigSkeleton *prefs)
virtual	~KPrefsWidManager ()
virtual void	addWid (KPrefsWid *)
KPrefsWidBool *	addWidBool (KConfigSkeleton::ItemBool *item, QWidget *parent=0)
KPrefsWidColor *	addWidColor (KConfigSkeleton::ItemColor *item, QWidget *parent=0)
KPrefsWidCombo *	addWidCombo (KConfigSkeleton::ItemEnum *item, QWidget *parent=0)
KPrefsWidDate *	addWidDate (KConfigSkeleton::ItemDateTime *item, QWidget *parent=0)
KPrefsWidDuration *	addWidDuration (KConfigSkeleton::ItemDateTime *item, const QString &format, QWidget *parent=0)
KPrefsWidFont *	addWidFont (KConfigSkeleton::ItemFont *item, QWidget *parent=0, const QString &sampleText=QString())
KPrefsWidInt *	addWidInt (KConfigSkeleton::ItemInt *item, QWidget *parent=0)
KPrefsWidString *	addWidPassword (KConfigSkeleton::ItemString *item, QWidget *parent=0)
KPrefsWidPath *	addWidPath (KConfigSkeleton::ItemPath *item, QWidget *parent=0, const QString &filter=QString(), KFile::Modes mode=KFile::File)
KPrefsWidRadios *	addWidRadios (KConfigSkeleton::ItemEnum *item, QWidget *parent=0)
KPrefsWidString *	addWidString (KConfigSkeleton::ItemString *item, QWidget *parent=0)
KPrefsWidTime *	addWidTime (KConfigSkeleton::ItemDateTime *item, QWidget *parent=0)
KConfigSkeleton *	prefs () const
void	readWidConfig ()
void	setWidDefaults ()
void	writeWidConfig ()

Protected Slots
void	slotApply ()
void	slotDefault ()
void	slotOk ()

Protected Member Functions
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 739 of file kprefsdialog.h.

Constructor & Destructor Documentation

KPrefsDialog::KPrefsDialog ( KConfigSkeleton *  prefs, QWidget *  parent = 0, bool  modal = false  )

explicit

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

KPrefsDialog::~KPrefsDialog ( )

virtual

Destructor.

Definition at line 796 of file kprefsdialog.cpp.

Member Function Documentation

void KPrefsDialog::autoCreate

(

)

Definition at line 801 of file kprefsdialog.cpp.

void KPIM::KPrefsDialog::configChanged ( )

signal

Emitted when the a changed configuration has been stored.

void KPrefsDialog::readConfig ( )

slot

Read preferences from config file.

Definition at line 863 of file kprefsdialog.cpp.

void KPrefsDialog::setDefaults ( )

slot

Set all widgets to default values.

Definition at line 858 of file kprefsdialog.cpp.

void KPrefsDialog::slotApply ( )

protectedslot

Apply changes to preferences.

Definition at line 876 of file kprefsdialog.cpp.

void KPrefsDialog::slotDefault ( )

protectedslot

Set preferences to default values.

Definition at line 889 of file kprefsdialog.cpp.

void KPrefsDialog::slotOk ( )

protectedslot

Accept changes to preferences and close dialog.

Definition at line 883 of file kprefsdialog.cpp.

virtual void KPIM::KPrefsDialog::usrReadConfig ( )

inlineprotectedvirtual

Implement this to read custom configuration widgets.

Definition at line 787 of file kprefsdialog.h.

virtual void KPIM::KPrefsDialog::usrWriteConfig ( )

inlineprotectedvirtual

Implement this to write custom configuration widgets.

Definition at line 789 of file kprefsdialog.h.

void KPrefsDialog::writeConfig ( )

slot

Write preferences to config file.

Definition at line 869 of file kprefsdialog.cpp.

---

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

• kprefsdialog.h
• kprefsdialog.cpp