KCoreConfigSkeleton::ItemString Class Reference

#include <kcoreconfigskeleton.h>

Inheritance diagram for KCoreConfigSkeleton::ItemString:

Public Types
enum	Type { Normal, Password, Path }
Public Types inherited from KConfigSkeletonItem
typedef QHash< QString, KConfigSkeletonItem * >	Dict
typedef QHash< QString, KConfigSkeletonItem * > ::Iterator	DictIterator
typedef QList < KConfigSkeletonItem * >	List

Public Member Functions
	ItemString (const QString &_group, const QString &_key, QString &reference, const QString &defaultValue=QLatin1String(""), Type type=Normal)
bool	isEqual (const QVariant &p) const
QVariant	property () const
void	readConfig (KConfig *config)
void	setProperty (const QVariant &p)
void	writeConfig (KConfig *config)
Public Member Functions inherited from KConfigSkeletonGenericItem< QString >
	KConfigSkeletonGenericItem (const QString &_group, const QString &_key, QString &reference, QStringdefaultValue)
void	readDefault (KConfig *config)
virtual void	setDefault ()
virtual void	setDefaultValue (const QString &v)
void	setValue (const QString &v)
void	swapDefault ()
QString &	value ()
const QString &	value () const
Public Member Functions inherited from KConfigSkeletonItem
	KConfigSkeletonItem (const QString &_group, const QString &_key)
virtual	~KConfigSkeletonItem ()
QString	group () const
bool	isImmutable () const
QString	key () const
QString	label () const
virtual QVariant	maxValue () const
virtual QVariant	minValue () const
QString	name () const
void	setGroup (const QString &_group)
void	setKey (const QString &_key)
void	setLabel (const QString &l)
void	setName (const QString &_name)
void	setToolTip (const QString &t)
void	setWhatsThis (const QString &w)
QString	toolTip () const
QString	whatsThis () const

Additional Inherited Members
Protected Member Functions inherited from KConfigSkeletonItem
void	readImmutability (const KConfigGroup &group)
Protected Attributes inherited from KConfigSkeletonGenericItem< QString >
QString	mDefault
QString	mLoadedValue
QString &	mReference
Protected Attributes inherited from KConfigSkeletonItem
QString	mGroup
QString	mKey
QString	mName

Detailed Description

Class for handling a string preferences item.

Definition at line 373 of file kcoreconfigskeleton.h.

Member Enumeration Documentation

enum KCoreConfigSkeleton::ItemString::Type

The type of string that is held in this item.

Enumerator
Normal	A normal string.
Password	A password string.
Path	A path to a file or directory.

Definition at line 376 of file kcoreconfigskeleton.h.

Constructor & Destructor Documentation

KCoreConfigSkeleton::ItemString::ItemString	(	const QString &	_group,
		const QString &	_key,
		QString &	reference,
		const QString &	defaultValue = QLatin1String(""),
		Type	type = Normal
	)

Constructor.

Parameters

_group	Config file group.
_key	Config file key.
reference	The initial value to hold in the item
defaultValue	The default value for the item
type	The type of string held by the item

Definition at line 124 of file kcoreconfigskeleton.cpp.

Member Function Documentation

bool KCoreConfigSkeleton::ItemString::isEqual ( const QVariant &  p ) const

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

Implements KConfigSkeletonItem.

Definition at line 178 of file kcoreconfigskeleton.cpp.

QVariant KCoreConfigSkeleton::ItemString::property ( ) const

virtual

Return item as property.

Implements KConfigSkeletonItem.

Definition at line 183 of file kcoreconfigskeleton.cpp.

void KCoreConfigSkeleton::ItemString::readConfig ( KConfig *  config )

virtual

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

Implements KConfigSkeletonItem.

Definition at line 150 of file kcoreconfigskeleton.cpp.

void KCoreConfigSkeleton::ItemString::setProperty ( const QVariant &  p )

virtual

Set item to p.

Implements KConfigSkeletonItem.

Definition at line 173 of file kcoreconfigskeleton.cpp.

void KCoreConfigSkeleton::ItemString::writeConfig ( KConfig *  config )

virtual

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

Reimplemented from KConfigSkeletonGenericItem< QString >.

Definition at line 133 of file kcoreconfigskeleton.cpp.

---

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

• kcoreconfigskeleton.h
• kcoreconfigskeleton.cpp