KConfigSkeletonItem Class Reference

Class for storing a preferences setting. More...

#include <KConfigSkeletonItem>

Inheritance diagram for KConfigSkeletonItem:


Public Types
typedef QHash< QString, KConfigSkeletonItem * >	Dict
typedef QHash< QString, KConfigSkeletonItem * > ::Iterator	DictIterator
typedef QList < KConfigSkeletonItem * >	List
Public Member Functions
QString	group () const
virtual bool	isEqual (const QVariant &p) const =0
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	setToolTip (const QString &t)
void	setWhatsThis (const QString &w)
virtual void	swapDefault ()=0
QString	toolTip () const
QString	whatsThis () const
virtual void	writeConfig (KConfig *)=0
virtual	~KConfigSkeletonItem ()
Protected Member Functions
void	readImmutability (const KConfigGroup &group)
Protected Attributes
QString	mGroup
QString	mKey
QString	mName

Detailed Description

Class for storing a preferences setting.

Author:: Cornelius Schumacher

See also:: KCoreConfigSkeleton

This class represents one preferences setting as used by KCoreConfigSkeleton. 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 KCoreConfigSkeleton instead. If you subclass this class you will have to register instances with the function KCoreConfigSkeleton::addItem().

Definition at line 52 of file kcoreconfigskeleton.h.

Member Typedef Documentation

typedef QHash< QString, KConfigSkeletonItem* > KConfigSkeletonItem::Dict

Definition at line 56 of file kcoreconfigskeleton.h.

typedef QHash< QString, KConfigSkeletonItem* >::Iterator KConfigSkeletonItem::DictIterator

Definition at line 57 of file kcoreconfigskeleton.h.

typedef QList< KConfigSkeletonItem * > KConfigSkeletonItem::List

Definition at line 55 of file kcoreconfigskeleton.h.

Constructor & Destructor Documentation

KConfigSkeletonItem::KConfigSkeletonItem	(	const QString &	_group,
		const QString &	_key
	)

Constructor.

Parameters:

	_group	Config file group.
	_key	Config file key.

Definition at line 30 of file kcoreconfigskeleton.cpp.

KConfigSkeletonItem::~KConfigSkeletonItem ( ) [virtual]

Destructor.

Definition at line 38 of file kcoreconfigskeleton.cpp.

Member Function Documentation

QString KConfigSkeletonItem::group ( ) const

Return config file group.

Definition at line 48 of file kcoreconfigskeleton.cpp.

virtual bool KConfigSkeletonItem::isEqual ( const QVariant & p ) const [pure virtual]

Check whether the item is equal to p.

Use this function to compare items that use custom types such as KUrl, because QVariant::operator== will not work for those.

Parameters:

p

QVariant to compare to

Returns:: true if the item is equal to p, false otherwise

bool KConfigSkeletonItem::isImmutable ( ) const

Return if the entry can be modified.

Definition at line 113 of file kcoreconfigskeleton.cpp.

QString KConfigSkeletonItem::key ( ) const

Return config file key.

Definition at line 58 of file kcoreconfigskeleton.cpp.

QString KConfigSkeletonItem::label ( ) const

Return label of item.

See setLabel().

Definition at line 78 of file kcoreconfigskeleton.cpp.

QVariant KConfigSkeletonItem::maxValue ( ) const [virtual]

Return maximum value of item or invalid if not specified.

Reimplemented in KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, and KCoreConfigSkeleton::ItemDouble.

Definition at line 108 of file kcoreconfigskeleton.cpp.

QVariant KConfigSkeletonItem::minValue ( ) const [virtual]

Return minimum value of item or invalid if not specified.

Reimplemented in KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, and KCoreConfigSkeleton::ItemDouble.

Definition at line 103 of file kcoreconfigskeleton.cpp.

QString KConfigSkeletonItem::name ( ) const

Return internal name of entry.

Definition at line 68 of file kcoreconfigskeleton.cpp.

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

Return item as property.

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

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

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

Read global default value.

void KConfigSkeletonItem::readImmutability ( const KConfigGroup & group ) [protected]

sets mIsImmutable to true if mKey in config is immutable

Parameters:

group

KConfigGroup to check if mKey is immutable in

Definition at line 118 of file kcoreconfigskeleton.cpp.

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

Sets the current value to the default value.

void KConfigSkeletonItem::setGroup ( const QString & _group )

Set config file group.

Definition at line 43 of file kcoreconfigskeleton.cpp.

void KConfigSkeletonItem::setKey ( const QString & _key )

Set config file key.

Definition at line 53 of file kcoreconfigskeleton.cpp.

void KConfigSkeletonItem::setLabel ( const QString & l )

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

Definition at line 73 of file kcoreconfigskeleton.cpp.

void KConfigSkeletonItem::setName ( const QString & _name )

Set internal name of entry.

Definition at line 63 of file kcoreconfigskeleton.cpp.

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

Set item to p.

void KConfigSkeletonItem::setToolTip ( const QString & t )

Set ToolTip description of item.

Since:: 4.2

Definition at line 83 of file kcoreconfigskeleton.cpp.

void KConfigSkeletonItem::setWhatsThis ( const QString & w )

Set WhatsThis description of item.

Definition at line 93 of file kcoreconfigskeleton.cpp.

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

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

QString KConfigSkeletonItem::toolTip ( ) const

Return ToolTip description of item.

See setToolTip().

Since:: 4.2

Definition at line 88 of file kcoreconfigskeleton.cpp.

QString KConfigSkeletonItem::whatsThis ( ) const

Return WhatsThis description of item.

See setWhatsThis().

Definition at line 98 of file kcoreconfigskeleton.cpp.

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

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

Member Data Documentation

QString KConfigSkeletonItem::mGroup [protected]

The group name for this item.

Definition at line 205 of file kcoreconfigskeleton.h.

QString KConfigSkeletonItem::mKey [protected]

The config key for this item.

Definition at line 206 of file kcoreconfigskeleton.h.

QString KConfigSkeletonItem::mName [protected]

The name of this item.

Definition at line 207 of file kcoreconfigskeleton.h.

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

KDECore

KConfigSkeletonItem Class Reference

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

KDECore

kdelibs