libkdepim Library API Documentation

KPrefsItem Class Reference

Class for storing a preferences setting. More...

#include <kprefs.h>

List of all members.

Public Member Functions

 KPrefsItem (const QString &group, const QString &name)
 Constructor.

virtual ~KPrefsItem ()
 Destructor.

virtual void setDefault ()=0
 This function is called by KPrefs to set this setting to its default value.

virtual void readConfig (KConfig *)=0
 This function is called by KPrefs to read the value for this setting from a config file.

virtual void writeConfig (KConfig *)=0
 This function is called by KPrefs to write the value of this setting to a config file.


Protected Attributes

QString mGroup
QString mName


Detailed Description

Class for storing a preferences setting.

Author:
Cornelius Schumacher
See also:
KPref
This class represents one preferences setting as used by KPrefs. Subclasses of KPrefsItem implement storage functions for a certain type of setting. Normally you don't have to use this class directly. Use the special addItem() functions of KPrefs instead. If you subclass this class you will have to register instances with the function KPrefs::addItem().

Definition at line 42 of file kprefs.h.


Constructor & Destructor Documentation

KPrefsItem::KPrefsItem const QString group,
const QString name
[inline]
 

Constructor.

Parameters:
group Config file group.
name Config file key.

Definition at line 50 of file kprefs.h.

virtual KPrefsItem::~KPrefsItem  )  [inline, virtual]
 

Destructor.

Definition at line 55 of file kprefs.h.


Member Function Documentation

virtual void KPrefsItem::setDefault  )  [pure virtual]
 

This function is called by KPrefs to set this setting to its default value.

Referenced by KPrefs::setDefaults().

virtual void KPrefsItem::readConfig KConfig *   )  [pure virtual]
 

This function is called by KPrefs to read the value for this setting from a config file.

value.

Referenced by KPrefs::readConfig().

virtual void KPrefsItem::writeConfig KConfig *   )  [pure virtual]
 

This function is called by KPrefs to write the value of this setting to a config file.

Referenced by KPrefs::writeConfig().


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sat Oct 18 02:47:00 2003 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001