KPrefsDialog Class Reference

#include <kprefsdialog.h>

Inheritance diagram for KPrefsDialog:

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

Signals
void	configChanged ()

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

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

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

Constructor & Destructor Documentation

KPrefsDialog()

KPrefsDialog::KPrefsDialog	(	TDEConfigSkeleton *	prefs,
		TQWidget *	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 736 of file kprefsdialog.cpp.

~KPrefsDialog()

KPrefsDialog::~KPrefsDialog ( )

virtual

Destructor.

Definition at line 749 of file kprefsdialog.cpp.

Member Function Documentation

configChanged

void KPrefsDialog::configChanged ( )

signal

Emitted when the a changed configuration has been stored.

readConfig

void KPrefsDialog::readConfig ( )

slot

Read preferences from config file.

Definition at line 819 of file kprefsdialog.cpp.

setDefaults

void KPrefsDialog::setDefaults ( )

slot

Set all widgets to default values.

Definition at line 814 of file kprefsdialog.cpp.

slotApply

void KPrefsDialog::slotApply ( )

protectedslot

Apply changes to preferences.

Definition at line 836 of file kprefsdialog.cpp.

slotDefault

void KPrefsDialog::slotDefault ( )

protectedslot

Set preferences to default values.

Definition at line 848 of file kprefsdialog.cpp.

slotOk

void KPrefsDialog::slotOk ( )

protectedslot

Accept changes to preferences and close dialog.

Definition at line 842 of file kprefsdialog.cpp.

usrReadConfig()

virtual void KPrefsDialog::usrReadConfig ( )

inlineprotectedvirtual

Implement this to read custom configuration widgets.

Definition at line 769 of file kprefsdialog.h.

usrWriteConfig()

virtual void KPrefsDialog::usrWriteConfig ( )

inlineprotectedvirtual

Implement this to write custom configuration widgets.

Definition at line 771 of file kprefsdialog.h.

writeConfig

void KPrefsDialog::writeConfig ( )

slot

Write preferences to config file.

Definition at line 826 of file kprefsdialog.cpp.

---

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

• kprefsdialog.h
• kprefsdialog.cpp