KConfigSkeletonItem Class Reference

Class for storing a preferences setting. More...

#include <kconfigskeleton.h>

Inheritance diagram for KConfigSkeletonItem:


Public Types
typedef QDict < KConfigSkeletonItem >	Dict
typedef QDictIterator < KConfigSkeletonItem >	DictIterator
typedef QValueList < KConfigSkeletonItem * >	List
Public Member Functions
QString	group () const
bool	isImmutable () const
	KConfigSkeletonItem (const QString &group, const QString &key)
QString	key () const
QString	label () const
virtual QVariant	maxValue () const
virtual QVariant	minValue () const
QString	name () const
virtual QVariant	property () const =0
virtual void	readConfig (KConfig *)=0
virtual void	readDefault (KConfig *)=0
virtual void	setDefault ()=0
void	setGroup (const QString &group)
void	setKey (const QString &key)
void	setLabel (const QString &l)
void	setName (const QString &name)
virtual void	setProperty (const QVariant &p)=0
void	setWhatsThis (const QString &w)
virtual void	swapDefault ()=0
QString	whatsThis () const
virtual void	writeConfig (KConfig *)=0
virtual	~KConfigSkeletonItem ()
Protected Member Functions
void	readImmutability (KConfig *config)
Protected Attributes
QString	mGroup
QString	mKey
QString	mName

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.

Member Typedef Documentation

typedef QDict< KConfigSkeletonItem > KConfigSkeletonItem::Dict

Definition at line 54 of file kconfigskeleton.h.

typedef QDictIterator< KConfigSkeletonItem > KConfigSkeletonItem::DictIterator

Definition at line 55 of file kconfigskeleton.h.

typedef QValueList< KConfigSkeletonItem * > KConfigSkeletonItem::List

Definition at line 53 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.

virtual KConfigSkeletonItem::~KConfigSkeletonItem ( ) [inline, virtual]

Destructor.

Definition at line 71 of file kconfigskeleton.h.

Member Function Documentation

QString KConfigSkeletonItem::group ( ) const [inline]

Return config file group.

Definition at line 86 of file kconfigskeleton.h.

bool KConfigSkeletonItem::isImmutable ( ) const [inline]

Return if the entry can be modified.

Definition at line 207 of file kconfigskeleton.h.

QString KConfigSkeletonItem::key ( ) const [inline]

Return config file key.

Definition at line 102 of file kconfigskeleton.h.

QString KConfigSkeletonItem::label ( ) const [inline]

Return label of item.

See setLabel().

Definition at line 134 of file kconfigskeleton.h.

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.

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.

QString KConfigSkeletonItem::name ( ) const [inline]

Return internal name of entry.

Definition at line 118 of file kconfigskeleton.h.

virtual QVariant KConfigSkeletonItem::property ( ) const [pure virtual]

Return item as property.

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.

virtual void KConfigSkeletonItem::readDefault ( KConfig * ) [pure virtual]

Read global default value.

void KConfigSkeletonItem::readImmutability ( KConfig * config ) [protected]

sets mIsImmutable to true if mKey in config is immutable

Parameters:

config

KConfig to check if mKey is immutable in

Definition at line 35 of file kconfigskeleton.cpp.

virtual void KConfigSkeletonItem::setDefault ( ) [pure virtual]

Sets the current value to the default value.

void KConfigSkeletonItem::setGroup ( const QString & group ) [inline]

Set config file group.

Definition at line 78 of file kconfigskeleton.h.

void KConfigSkeletonItem::setKey ( const QString & key ) [inline]

Set config file key.

Definition at line 94 of file kconfigskeleton.h.

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.

void KConfigSkeletonItem::setName ( const QString & name ) [inline]

Set internal name of entry.

Definition at line 110 of file kconfigskeleton.h.

virtual void KConfigSkeletonItem::setProperty ( const QVariant & p ) [pure virtual]

Set item to p.

void KConfigSkeletonItem::setWhatsThis ( const QString & w ) [inline]

Set WhatsThis description og item.

Definition at line 142 of file kconfigskeleton.h.

virtual void KConfigSkeletonItem::swapDefault ( ) [pure virtual]

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

QString KConfigSkeletonItem::whatsThis ( ) const [inline]

Return WhatsThis description of item.

See setWhatsThis().

Definition at line 150 of file kconfigskeleton.h.

virtual void KConfigSkeletonItem::writeConfig ( KConfig * ) [pure virtual]

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

Member Data Documentation

QString KConfigSkeletonItem::mGroup [protected]

Definition at line 219 of file kconfigskeleton.h.

QString KConfigSkeletonItem::mKey [protected]

Definition at line 220 of file kconfigskeleton.h.

QString KConfigSkeletonItem::mName [protected]

Definition at line 221 of file kconfigskeleton.h.

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

KDECore

KConfigSkeletonItem Class Reference

Public Types

Public Member Functions

Protected Member Functions