kdecore Library API Documentation

KConfigSkeletonItem Class Reference

Class for storing a preferences setting. More...

#include <kconfigskeleton.h>

List of all members.

Public Methods

 KConfigSkeletonItem (const QString &group, const QString &key)
virtual ~KConfigSkeletonItem ()
void setGroup (const QString &group)
QString group () const
void setKey (const QString &key)
QString key () const
void setName (const QString &name)
QString name () const
void setLabel (const QString &l)
QString label () const
void setWhatsThis (const QString &w)
QString whatsThis () const
virtual void readConfig (KConfig *)=0
virtual void writeConfig (KConfig *)=0
virtual void readDefault (KConfig *)=0
virtual void setProperty (const QVariant &p)=0
virtual QVariant property () const=0
virtual QVariant minValue () const
virtual QVariant maxValue () const
virtual void setDefault ()=0
virtual void swapDefault ()=0
bool isImmutable () const


Detailed Description

Class for storing a preferences setting.

Author:
Cornelius Schumacher
See also:
KConfigSkeleton
This class represents one preferences setting as used by KConfigSkeleton. Subclasses of KConfigSkeletonItem 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 KConfigSkeleton instead. If you subclass this class you will have to register instances with the function KConfigSkeleton::addItem().

Definition at line 50 of file kconfigskeleton.h.


Constructor & Destructor Documentation

KConfigSkeletonItem::KConfigSkeletonItem const QString   group,
const QString   key
[inline]
 

Constructor.

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

Definition at line 63 of file kconfigskeleton.h.

References group(), and key().

virtual KConfigSkeletonItem::~KConfigSkeletonItem   [inline, virtual]
 

Destructor.

Definition at line 71 of file kconfigskeleton.h.


Member Function Documentation

void KConfigSkeletonItem::setGroup const QString   group [inline]
 

Set config file group.

Definition at line 78 of file kconfigskeleton.h.

References group().

QString KConfigSkeletonItem::group   const [inline]
 

Return config file group.

Definition at line 86 of file kconfigskeleton.h.

Referenced by KConfigSkeletonItem(), and setGroup().

void KConfigSkeletonItem::setKey const QString   key [inline]
 

Set config file key.

Definition at line 94 of file kconfigskeleton.h.

References key().

QString KConfigSkeletonItem::key   const [inline]
 

Return config file key.

Definition at line 102 of file kconfigskeleton.h.

Referenced by KConfigSkeleton::addItem(), KConfigSkeletonItem(), and setKey().

void KConfigSkeletonItem::setName const QString   name [inline]
 

Set internal name of entry.

Definition at line 110 of file kconfigskeleton.h.

References name().

Referenced by KConfigSkeleton::addItem().

QString KConfigSkeletonItem::name   const [inline]
 

Return internal name of entry.

Definition at line 118 of file kconfigskeleton.h.

Referenced by KConfigSkeleton::addItem(), setName(), and KConfigSkeleton::ItemEnum::writeConfig().

void KConfigSkeletonItem::setLabel const QString   l [inline]
 

Set label providing a translated one-line description of the item.

Definition at line 126 of file kconfigskeleton.h.

QString KConfigSkeletonItem::label   const [inline]
 

Return label of item.

See setLabel().

Definition at line 134 of file kconfigskeleton.h.

void KConfigSkeletonItem::setWhatsThis const QString   w [inline]
 

Set WhatsThis description og item.

Definition at line 142 of file kconfigskeleton.h.

QString KConfigSkeletonItem::whatsThis   const [inline]
 

Return WhatsThis description of item.

See setWhatsThis().

Definition at line 150 of file kconfigskeleton.h.

virtual void KConfigSkeletonItem::readConfig KConfig   [pure virtual]
 

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

value.

Implemented in KConfigSkeleton::ItemString, KConfigSkeleton::ItemProperty, KConfigSkeleton::ItemBool, KConfigSkeleton::ItemInt, KConfigSkeleton::ItemInt64, KConfigSkeleton::ItemEnum, KConfigSkeleton::ItemUInt, KConfigSkeleton::ItemLong, KConfigSkeleton::ItemULong, KConfigSkeleton::ItemUInt64, KConfigSkeleton::ItemDouble, KConfigSkeleton::ItemColor, KConfigSkeleton::ItemFont, KConfigSkeleton::ItemRect, KConfigSkeleton::ItemPoint, KConfigSkeleton::ItemSize, KConfigSkeleton::ItemDateTime, KConfigSkeleton::ItemStringList, and KConfigSkeleton::ItemIntList.

virtual void KConfigSkeletonItem::writeConfig KConfig   [pure virtual]
 

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

Implemented in KConfigSkeleton::ItemString, and KConfigSkeleton::ItemEnum.

virtual void KConfigSkeletonItem::readDefault KConfig   [pure virtual]
 

Read global default value.

Referenced by KConfigSkeleton::addItem().

virtual void KConfigSkeletonItem::setProperty const QVariant   p [pure virtual]
 

Set item to p.

Implemented in KConfigSkeleton::ItemString, KConfigSkeleton::ItemProperty, KConfigSkeleton::ItemBool, KConfigSkeleton::ItemInt, KConfigSkeleton::ItemInt64, KConfigSkeleton::ItemUInt, KConfigSkeleton::ItemLong, KConfigSkeleton::ItemULong, KConfigSkeleton::ItemUInt64, KConfigSkeleton::ItemDouble, KConfigSkeleton::ItemColor, KConfigSkeleton::ItemFont, KConfigSkeleton::ItemRect, KConfigSkeleton::ItemPoint, KConfigSkeleton::ItemSize, KConfigSkeleton::ItemDateTime, KConfigSkeleton::ItemStringList, and KConfigSkeleton::ItemIntList.

Referenced by KConfigDialogManager::updateSettings().

virtual QVariant KConfigSkeletonItem::property   [pure virtual]
 

Return item as property.

Implemented in KConfigSkeleton::ItemString, KConfigSkeleton::ItemProperty, KConfigSkeleton::ItemBool, KConfigSkeleton::ItemInt, KConfigSkeleton::ItemInt64, KConfigSkeleton::ItemUInt, KConfigSkeleton::ItemLong, KConfigSkeleton::ItemULong, KConfigSkeleton::ItemUInt64, KConfigSkeleton::ItemDouble, KConfigSkeleton::ItemColor, KConfigSkeleton::ItemFont, KConfigSkeleton::ItemRect, KConfigSkeleton::ItemPoint, KConfigSkeleton::ItemSize, KConfigSkeleton::ItemDateTime, KConfigSkeleton::ItemStringList, and KConfigSkeleton::ItemIntList.

Referenced by KConfigDialogManager::hasChanged(), KConfigDialogManager::updateSettings(), and KConfigDialogManager::updateWidgets().

virtual QVariant KConfigSkeletonItem::minValue   const [inline, virtual]
 

Return minimum value of item or invalid if not specified.

Reimplemented in KConfigSkeleton::ItemInt, KConfigSkeleton::ItemInt64, KConfigSkeleton::ItemUInt, KConfigSkeleton::ItemLong, KConfigSkeleton::ItemULong, KConfigSkeleton::ItemUInt64, and KConfigSkeleton::ItemDouble.

Definition at line 186 of file kconfigskeleton.h.

Referenced by KConfigDialogManager::setupWidget().

virtual QVariant KConfigSkeletonItem::maxValue   const [inline, virtual]
 

Return maximum value of item or invalid if not specified.

Reimplemented in KConfigSkeleton::ItemInt, KConfigSkeleton::ItemInt64, KConfigSkeleton::ItemUInt, KConfigSkeleton::ItemLong, KConfigSkeleton::ItemULong, KConfigSkeleton::ItemUInt64, and KConfigSkeleton::ItemDouble.

Definition at line 191 of file kconfigskeleton.h.

Referenced by KConfigDialogManager::setupWidget().

virtual void KConfigSkeletonItem::setDefault   [pure virtual]
 

Sets the current value to the default value.

virtual void KConfigSkeletonItem::swapDefault   [pure virtual]
 

Exchanges the current value with the default value Used by KConfigSkeleton::useDefaults(bool);.

bool KConfigSkeletonItem::isImmutable   const [inline]
 

Return if the entry can be modified.

Definition at line 207 of file kconfigskeleton.h.

Referenced by KConfigSkeleton::isImmutable(), and KConfigDialogManager::updateWidgets().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdecore Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:23:06 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003