TDEConfigSkeletonItem Class Reference

#include <tdeconfigskeleton.h>

Inherited by TDEConfigSkeletonGenericItem< bool >, TDEConfigSkeletonGenericItem< TQColor >, TDEConfigSkeletonGenericItem< TQDateTime >, TDEConfigSkeletonGenericItem< double >, TDEConfigSkeletonGenericItem< TQFont >, TDEConfigSkeletonGenericItem< int >, TDEConfigSkeletonGenericItem< TQ_INT64 >, TDEConfigSkeletonGenericItem< TQValueList< int > >, TDEConfigSkeletonGenericItem< long >, TDEConfigSkeletonGenericItem< TQPoint >, TDEConfigSkeletonGenericItem< TQVariant >, TDEConfigSkeletonGenericItem< TQRect >, TDEConfigSkeletonGenericItem< TQSize >, TDEConfigSkeletonGenericItem< TQString >, TDEConfigSkeletonGenericItem< TQStringList >, TDEConfigSkeletonGenericItem< unsigned int >, TDEConfigSkeletonGenericItem< TQ_UINT64 >, TDEConfigSkeletonGenericItem< unsigned long >, and TDEConfigSkeletonGenericItem< T >.

Public Types
typedef TQValueList< TDEConfigSkeletonItem * >	List
typedef TQDict< TDEConfigSkeletonItem >	Dict
typedef TQDictIterator< TDEConfigSkeletonItem >	DictIterator

Public Member Functions
	TDEConfigSkeletonItem (const TQString &group, const TQString &key)
virtual	~TDEConfigSkeletonItem ()
void	setGroup (const TQString &group)
TQString	group () const
void	setKey (const TQString &key)
TQString	key () const
void	setName (const TQString &name)
TQString	name () const
void	setLabel (const TQString &l)
TQString	label () const
void	setWhatsThis (const TQString &w)
TQString	whatsThis () const
virtual void	readConfig (TDEConfig *)=0
virtual void	writeConfig (TDEConfig *)=0
virtual void	readDefault (TDEConfig *)=0
virtual void	setProperty (const TQVariant &p)=0
virtual TQVariant	property () const =0
virtual TQVariant	minValue () const
virtual TQVariant	maxValue () const
virtual void	setDefault ()=0
virtual void	swapDefault ()=0
bool	isImmutable () const

Protected Member Functions
void	readImmutability (TDEConfig *config)

Protected Attributes
TQString	mGroup
TQString	mKey
TQString	mName

Detailed Description

Class for storing a preferences setting.

Author

Cornelius Schumacher

See also

TDEConfigSkeleton

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

Definition at line 50 of file tdeconfigskeleton.h.

Member Typedef Documentation

Dict

typedef TQDict< TDEConfigSkeletonItem > TDEConfigSkeletonItem::Dict

Definition at line 54 of file tdeconfigskeleton.h.

DictIterator

typedef TQDictIterator< TDEConfigSkeletonItem > TDEConfigSkeletonItem::DictIterator

Definition at line 55 of file tdeconfigskeleton.h.

List

typedef TQValueList< TDEConfigSkeletonItem * > TDEConfigSkeletonItem::List

Definition at line 53 of file tdeconfigskeleton.h.

Constructor & Destructor Documentation

TDEConfigSkeletonItem()

TDEConfigSkeletonItem::TDEConfigSkeletonItem ( const TQString &  group, const TQString &  key  )

inline

Constructor.

Parameters

group	Config file group.
key	Config file key.

Definition at line 63 of file tdeconfigskeleton.h.

~TDEConfigSkeletonItem()

virtual TDEConfigSkeletonItem::~TDEConfigSkeletonItem ( )

inlinevirtual

Destructor.

Definition at line 71 of file tdeconfigskeleton.h.

Member Function Documentation

group()

TQString TDEConfigSkeletonItem::group ( ) const

inline

Return config file group.

Definition at line 86 of file tdeconfigskeleton.h.

isImmutable()

bool TDEConfigSkeletonItem::isImmutable ( ) const

inline

Return if the entry can be modified.

Definition at line 207 of file tdeconfigskeleton.h.

key()

TQString TDEConfigSkeletonItem::key ( ) const

inline

Return config file key.

Definition at line 102 of file tdeconfigskeleton.h.

label()

TQString TDEConfigSkeletonItem::label ( ) const

inline

Return label of item.

See setLabel().

Definition at line 134 of file tdeconfigskeleton.h.

maxValue()

virtual TQVariant TDEConfigSkeletonItem::maxValue ( ) const

inlinevirtual

Return maximum value of item or invalid if not specified.

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

Definition at line 191 of file tdeconfigskeleton.h.

minValue()

virtual TQVariant TDEConfigSkeletonItem::minValue ( ) const

inlinevirtual

Return minimum value of item or invalid if not specified.

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

Definition at line 186 of file tdeconfigskeleton.h.

name()

TQString TDEConfigSkeletonItem::name ( ) const

inline

Return internal name of entry.

Definition at line 118 of file tdeconfigskeleton.h.

property()

virtual TQVariant TDEConfigSkeletonItem::property ( ) const

pure virtual

Return item as property.

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

readConfig()

virtual void TDEConfigSkeletonItem::readConfig ( TDEConfig *  )

pure virtual

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

value.

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

readDefault()

virtual void TDEConfigSkeletonItem::readDefault ( TDEConfig *  )

pure virtual

Read global default value.

readImmutability()

void TDEConfigSkeletonItem::readImmutability ( TDEConfig *  config )

protected

sets mIsImmutable to true if mKey in config is immutable

Parameters

config

TDEConfig to check if mKey is immutable in

Definition at line 35 of file tdeconfigskeleton.cpp.

setDefault()

virtual void TDEConfigSkeletonItem::setDefault ( )

pure virtual

Sets the current value to the default value.

setGroup()

void TDEConfigSkeletonItem::setGroup ( const TQString &  group )

inline

Set config file group.

Definition at line 78 of file tdeconfigskeleton.h.

setKey()

void TDEConfigSkeletonItem::setKey ( const TQString &  key )

inline

Set config file key.

Definition at line 94 of file tdeconfigskeleton.h.

setLabel()

void TDEConfigSkeletonItem::setLabel ( const TQString &  l )

inline

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

Definition at line 126 of file tdeconfigskeleton.h.

setName()

void TDEConfigSkeletonItem::setName ( const TQString &  name )

inline

Set internal name of entry.

Definition at line 110 of file tdeconfigskeleton.h.

setProperty()

virtual void TDEConfigSkeletonItem::setProperty ( const TQVariant &  p )

pure virtual

Set item to p.

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

setWhatsThis()

void TDEConfigSkeletonItem::setWhatsThis ( const TQString &  w )

inline

Set WhatsThis description og item.

Definition at line 142 of file tdeconfigskeleton.h.

swapDefault()

virtual void TDEConfigSkeletonItem::swapDefault ( )

pure virtual

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

whatsThis()

TQString TDEConfigSkeletonItem::whatsThis ( ) const

inline

Return WhatsThis description of item.

See setWhatsThis().

Definition at line 150 of file tdeconfigskeleton.h.

writeConfig()

virtual void TDEConfigSkeletonItem::writeConfig ( TDEConfig *  )

pure virtual

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

Implemented in TDEConfigSkeleton::ItemString, TDEConfigSkeleton::ItemEnum, and TDEConfigSkeleton::ItemPathList.

Member Data Documentation

mGroup

TQString TDEConfigSkeletonItem::mGroup

protected

Definition at line 219 of file tdeconfigskeleton.h.

mKey

TQString TDEConfigSkeletonItem::mKey

protected

Definition at line 220 of file tdeconfigskeleton.h.

mName

TQString TDEConfigSkeletonItem::mName

protected

Definition at line 221 of file tdeconfigskeleton.h.

---

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

• tdeconfigskeleton.h
• tdeconfigskeleton.cpp