• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KConfigSkeletonItem Class Referenceabstract

#include <kconfigskeleton.h>

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

Public Types

typedef TQValueList
< KConfigSkeletonItem * > 
List
 
typedef TQDict
< KConfigSkeletonItem > 
Dict
 
typedef TQDictIterator
< KConfigSkeletonItem > 
DictIterator
 

Public Member Functions

 KConfigSkeletonItem (const TQString &group, const TQString &key)
 
virtual ~KConfigSkeletonItem ()
 
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 (KConfig *)=0
 
virtual void writeConfig (KConfig *)=0
 
virtual void readDefault (KConfig *)=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 (KConfig *config)
 

Protected Attributes

TQString mGroup
 
TQString mKey
 
TQString 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.

Constructor & Destructor Documentation

KConfigSkeletonItem::KConfigSkeletonItem ( const TQString &  group,
const TQString &  key 
)
inline

Constructor.

Parameters
groupConfig file group.
keyConfig file key.

Definition at line 63 of file kconfigskeleton.h.

virtual KConfigSkeletonItem::~KConfigSkeletonItem ( )
inlinevirtual

Destructor.

Definition at line 71 of file kconfigskeleton.h.

Member Function Documentation

TQString 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.

TQString KConfigSkeletonItem::key ( ) const
inline

Return config file key.

Definition at line 102 of file kconfigskeleton.h.

TQString KConfigSkeletonItem::label ( ) const
inline

Return label of item.

See setLabel().

Definition at line 134 of file kconfigskeleton.h.

virtual TQVariant KConfigSkeletonItem::maxValue ( ) const
inlinevirtual

Return maximum value of item or invalid if not specified.

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

Definition at line 191 of file kconfigskeleton.h.

virtual TQVariant KConfigSkeletonItem::minValue ( ) const
inlinevirtual

Return minimum value of item or invalid if not specified.

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

Definition at line 186 of file kconfigskeleton.h.

TQString KConfigSkeletonItem::name ( ) const
inline

Return internal name of entry.

Definition at line 118 of file kconfigskeleton.h.

virtual TQVariant KConfigSkeletonItem::property ( ) const
pure virtual

Return item as property.

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

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.

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

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
configKConfig 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 TQString &  group)
inline

Set config file group.

Definition at line 78 of file kconfigskeleton.h.

void KConfigSkeletonItem::setKey ( const TQString &  key)
inline

Set config file key.

Definition at line 94 of file kconfigskeleton.h.

void KConfigSkeletonItem::setLabel ( const TQString &  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 TQString &  name)
inline

Set internal name of entry.

Definition at line 110 of file kconfigskeleton.h.

virtual void KConfigSkeletonItem::setProperty ( const TQVariant &  p)
pure virtual

Set item to p.

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

void KConfigSkeletonItem::setWhatsThis ( const TQString &  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);.

TQString 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.

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


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

kdecore

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

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.8.6
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |