libkdepim Library API Documentation

KPrefsDialog Class Reference

Base class for a preferences dialog. More...

#include <kprefsdialog.h>

List of all members.

Public Slots

void setDefaults ()
 Set all widgets to default values.

void readConfig ()
 Read preferences from config file.

void writeConfig ()
 Write preferences to config file.


Signals

void configChanged ()
 Emitted when the a changed configuration has been stored.


Public Member Functions

 KPrefsDialog (KPrefs *prefs, QWidget *parent=0, char *name=0, bool modal=false)
 Create a KPrefsDialog for a KPrefs object.

virtual ~KPrefsDialog ()
 Destructor.

void addWid (KPrefsWid *)
 Register a custom KPrefsWid object.

KPrefsWidBooladdWidBool (const QString &text, bool *reference, QWidget *parent)
 Register a KPrefsWidBool object.

KPrefsWidTimeaddWidTime (const QString &text, int *reference, QWidget *parent)
 Register a KPrefsWidTime object.

KPrefsWidColoraddWidColor (const QString &text, QColor *reference, QWidget *parent)
 Register a KPrefsWidColor object.

KPrefsWidRadiosaddWidRadios (const QString &text, int *reference, QWidget *parent)
 Register a KPrefsWidRadios object.

KPrefsWidStringaddWidString (const QString &text, QString *reference, QWidget *parent)
 Register a KPrefsWidString object.

KPrefsWidStringaddWidPassword (const QString &text, QString *reference, QWidget *parent)
 Register a password KPrefsWidString object, with echomode set to QLineEdit::Password.

KPrefsWidFontaddWidFont (const QString &sampleText, const QString &buttonText, QFont *reference, QWidget *parent)
 Register a KPrefsWidFont object.


Protected Slots

void slotApply ()
 Apply changes to preferences.

void slotOk ()
 Accept changes to preferences and close dialog.

void slotDefault ()
 Set preferences to default values.


Protected Member Functions

virtual void usrReadConfig ()
 Implement this to read custom configuration widgets.

virtual void usrWriteConfig ()
 Implement this to write custom configuration widgets.


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


Constructor & Destructor Documentation

KPrefsDialog::KPrefsDialog KPrefs 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 269 of file kprefsdialog.cpp.

References setDefaults().

KPrefsDialog::~KPrefsDialog  )  [virtual]
 

Destructor.

Definition at line 282 of file kprefsdialog.cpp.


Member Function Documentation

void KPrefsDialog::addWid KPrefsWid  ) 
 

Register a custom KPrefsWid object.

Definition at line 286 of file kprefsdialog.cpp.

References QPtrList< KPrefsWid >::append().

Referenced by addWidBool(), addWidColor(), addWidFont(), addWidPassword(), addWidRadios(), addWidString(), and addWidTime().

KPrefsWidBool * KPrefsDialog::addWidBool const QString text,
bool *  reference,
QWidget parent
 

Register a KPrefsWidBool object.

Parameters:
text Text of bool widget.
reference Reference to variable storing the setting.
parent Parent widget.

Definition at line 291 of file kprefsdialog.cpp.

References addWid().

KPrefsWidTime * KPrefsDialog::addWidTime const QString text,
int *  reference,
QWidget parent
 

Register a KPrefsWidTime object.

Parameters:
text Text of time widget.
reference Reference to variable storing the setting.
parent Parent widget.

Definition at line 298 of file kprefsdialog.cpp.

References addWid().

KPrefsWidColor * KPrefsDialog::addWidColor const QString text,
QColor reference,
QWidget parent
 

Register a KPrefsWidColor object.

Parameters:
text Text of color widget.
reference Reference to variable storing the setting.
parent Parent widget.

Definition at line 305 of file kprefsdialog.cpp.

References addWid().

KPrefsWidRadios * KPrefsDialog::addWidRadios const QString text,
int *  reference,
QWidget parent
 

Register a KPrefsWidRadios object.

Parameters:
text Text of radio button box widget.
reference Reference to variable storing the setting.
parent Parent widget.

Definition at line 312 of file kprefsdialog.cpp.

References addWid().

KPrefsWidString * KPrefsDialog::addWidString const QString text,
QString reference,
QWidget parent
 

Register a KPrefsWidString object.

Parameters:
text Text of string widget.
reference Reference to variable storing the setting.
parent Parent widget.

Definition at line 319 of file kprefsdialog.cpp.

References addWid().

KPrefsWidString * KPrefsDialog::addWidPassword const QString text,
QString reference,
QWidget parent
 

Register a password KPrefsWidString object, with echomode set to QLineEdit::Password.

Parameters:
text Text of string widget.
reference Reference to variable storing the setting.
parent Parent widget.

Definition at line 326 of file kprefsdialog.cpp.

References addWid().

KPrefsWidFont * KPrefsDialog::addWidFont const QString sampleText,
const QString buttonText,
QFont reference,
QWidget parent
 

Register a KPrefsWidFont object.

Parameters:
sampleText Sample text of font widget.
buttonText Button text of font widget.
reference Reference to variable storing the setting.
parent Parent widget.

Definition at line 333 of file kprefsdialog.cpp.

References addWid().

void KPrefsDialog::setDefaults  )  [slot]
 

Set all widgets to default values.

Definition at line 341 of file kprefsdialog.cpp.

References readConfig(), and KPrefs::setDefaults().

Referenced by KPrefsDialog(), and slotDefault().

void KPrefsDialog::readConfig  )  [slot]
 

Read preferences from config file.

Definition at line 348 of file kprefsdialog.cpp.

References QPtrList< KPrefsWid >::first(), QPtrList< KPrefsWid >::next(), KPrefsWid::readConfig(), and usrReadConfig().

Referenced by setDefaults().

void KPrefsDialog::writeConfig  )  [slot]
 

Write preferences to config file.

Definition at line 360 of file kprefsdialog.cpp.

References QPtrList< KPrefsWid >::first(), QPtrList< KPrefsWid >::next(), usrWriteConfig(), KPrefs::writeConfig(), and KPrefsWid::writeConfig().

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

References slotApply().

void KPrefsDialog::slotDefault  )  [protected, slot]
 

Set preferences to default values.

Definition at line 391 of file kprefsdialog.cpp.

References setDefaults().

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

Implement this to read custom configuration widgets.

Definition at line 435 of file kprefsdialog.h.

Referenced by readConfig().

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

Implement this to write custom configuration widgets.

Definition at line 437 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 kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 15 11:40:23 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001