• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KConfigSkeletonItem Class Reference

#include <KConfigSkeletonItem>

Inheritance diagram for KConfigSkeletonItem:

Inheritance graph
[legend]

List of all members.


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.


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 &v) 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 setWhatsThis (const QString &w)
virtual void swapDefault ()=0
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

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 31 of file kcoreconfigskeleton.cpp.

KConfigSkeletonItem::~KConfigSkeletonItem (  )  [virtual]

Destructor.

Definition at line 39 of file kcoreconfigskeleton.cpp.


Member Function Documentation

QString KConfigSkeletonItem::group (  )  const

Return config file group.

Definition at line 49 of file kcoreconfigskeleton.cpp.

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

Check whether the item is equal to v.

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

Parameters:
v QVariant to compare to
Returns:
true if the item is equal to v, false otherwise

Implemented in KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemProperty, KCoreConfigSkeleton::ItemBool, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, KCoreConfigSkeleton::ItemDouble, KCoreConfigSkeleton::ItemRect, KCoreConfigSkeleton::ItemPoint, KCoreConfigSkeleton::ItemSize, KCoreConfigSkeleton::ItemDateTime, KCoreConfigSkeleton::ItemStringList, KCoreConfigSkeleton::ItemUrlList, and KCoreConfigSkeleton::ItemIntList.

bool KConfigSkeletonItem::isImmutable (  )  const

Return if the entry can be modified.

Definition at line 104 of file kcoreconfigskeleton.cpp.

QString KConfigSkeletonItem::key (  )  const

Return config file key.

Definition at line 59 of file kcoreconfigskeleton.cpp.

QString KConfigSkeletonItem::label (  )  const

Return label of item.

See setLabel().

Definition at line 79 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 99 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 94 of file kcoreconfigskeleton.cpp.

QString KConfigSkeletonItem::name (  )  const

Return internal name of entry.

Definition at line 69 of file kcoreconfigskeleton.cpp.

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

Return item as property.

Implemented in KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemProperty, KCoreConfigSkeleton::ItemBool, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, KCoreConfigSkeleton::ItemDouble, KCoreConfigSkeleton::ItemRect, KCoreConfigSkeleton::ItemPoint, KCoreConfigSkeleton::ItemSize, KCoreConfigSkeleton::ItemDateTime, KCoreConfigSkeleton::ItemStringList, KCoreConfigSkeleton::ItemUrlList, and KCoreConfigSkeleton::ItemIntList.

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

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

Implemented in KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemProperty, KCoreConfigSkeleton::ItemBool, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemEnum, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, KCoreConfigSkeleton::ItemDouble, KCoreConfigSkeleton::ItemRect, KCoreConfigSkeleton::ItemPoint, KCoreConfigSkeleton::ItemSize, KCoreConfigSkeleton::ItemDateTime, KCoreConfigSkeleton::ItemStringList, KCoreConfigSkeleton::ItemPathList, KCoreConfigSkeleton::ItemUrlList, and KCoreConfigSkeleton::ItemIntList.

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

Read global default value.

Implemented in KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QVariant >, KConfigSkeletonGenericItem< KUrl >, KConfigSkeletonGenericItem< KUrl::List >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< QRect >, and KConfigSkeletonGenericItem< QPoint >.

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 109 of file kcoreconfigskeleton.cpp.

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

Sets the current value to the default value.

Implemented in KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QVariant >, KConfigSkeletonGenericItem< KUrl >, KConfigSkeletonGenericItem< KUrl::List >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< QRect >, and KConfigSkeletonGenericItem< QPoint >.

void KConfigSkeletonItem::setGroup ( const QString &  _group  ) 

Set config file group.

Definition at line 44 of file kcoreconfigskeleton.cpp.

void KConfigSkeletonItem::setKey ( const QString &  _key  ) 

Set config file key.

Definition at line 54 of file kcoreconfigskeleton.cpp.

void KConfigSkeletonItem::setLabel ( const QString &  l  ) 

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

Definition at line 74 of file kcoreconfigskeleton.cpp.

void KConfigSkeletonItem::setName ( const QString &  _name  ) 

Set internal name of entry.

Definition at line 64 of file kcoreconfigskeleton.cpp.

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

Set item to p.

Implemented in KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemProperty, KCoreConfigSkeleton::ItemBool, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, KCoreConfigSkeleton::ItemDouble, KCoreConfigSkeleton::ItemRect, KCoreConfigSkeleton::ItemPoint, KCoreConfigSkeleton::ItemSize, KCoreConfigSkeleton::ItemDateTime, KCoreConfigSkeleton::ItemStringList, KCoreConfigSkeleton::ItemUrlList, and KCoreConfigSkeleton::ItemIntList.

void KConfigSkeletonItem::setWhatsThis ( const QString &  w  ) 

Set WhatsThis description of item.

Definition at line 84 of file kcoreconfigskeleton.cpp.

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

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

Implemented in KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QVariant >, KConfigSkeletonGenericItem< KUrl >, KConfigSkeletonGenericItem< KUrl::List >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< QRect >, and KConfigSkeletonGenericItem< QPoint >.

QString KConfigSkeletonItem::whatsThis (  )  const

Return WhatsThis description of item.

See setWhatsThis().

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

Implemented in KConfigSkeletonGenericItem< T >, KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemEnum, KCoreConfigSkeleton::ItemPathList, KCoreConfigSkeleton::ItemUrlList, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QVariant >, KConfigSkeletonGenericItem< KUrl >, KConfigSkeletonGenericItem< KUrl::List >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< QRect >, and KConfigSkeletonGenericItem< QPoint >.


Member Data Documentation

QString KConfigSkeletonItem::mGroup [protected]

The group name for this item.

Definition at line 193 of file kcoreconfigskeleton.h.

QString KConfigSkeletonItem::mKey [protected]

The config key for this item.

Definition at line 194 of file kcoreconfigskeleton.h.

QString KConfigSkeletonItem::mName [protected]

The name of this item.

Definition at line 195 of file kcoreconfigskeleton.h.


The documentation for this class was generated from the following files:
  • kcoreconfigskeleton.h
  • kcoreconfigskeleton.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal