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

tdecore

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes

TDEConfigSkeletonItem Class Reference

Class for storing a preferences setting. More...

#include <tdeconfigskeleton.h>

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

List of all members.

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.


Constructor & Destructor Documentation

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.

virtual TDEConfigSkeletonItem::~TDEConfigSkeletonItem (  )  [inline, virtual]

Destructor.

Definition at line 71 of file tdeconfigskeleton.h.


Member Function Documentation

TQString TDEConfigSkeletonItem::group (  )  const [inline]

Return config file group.

Definition at line 86 of file tdeconfigskeleton.h.

bool TDEConfigSkeletonItem::isImmutable (  )  const [inline]

Return if the entry can be modified.

Definition at line 207 of file tdeconfigskeleton.h.

TQString TDEConfigSkeletonItem::key (  )  const [inline]

Return config file key.

Definition at line 102 of file tdeconfigskeleton.h.

TQString TDEConfigSkeletonItem::label (  )  const [inline]

Return label of item.

See setLabel().

Definition at line 134 of file tdeconfigskeleton.h.

virtual TQVariant TDEConfigSkeletonItem::maxValue (  )  const [inline, virtual]

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.

virtual TQVariant TDEConfigSkeletonItem::minValue (  )  const [inline, virtual]

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.

TQString TDEConfigSkeletonItem::name (  )  const [inline]

Return internal name of entry.

Definition at line 118 of file tdeconfigskeleton.h.

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.

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.

virtual void TDEConfigSkeletonItem::readDefault ( TDEConfig *   )  [pure virtual]

Read global default value.

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.

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

Sets the current value to the default value.

void TDEConfigSkeletonItem::setGroup ( const TQString &  group  )  [inline]

Set config file group.

Definition at line 78 of file tdeconfigskeleton.h.

void TDEConfigSkeletonItem::setKey ( const TQString &  key  )  [inline]

Set config file key.

Definition at line 94 of file tdeconfigskeleton.h.

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.

void TDEConfigSkeletonItem::setName ( const TQString &  name  )  [inline]

Set internal name of entry.

Definition at line 110 of file tdeconfigskeleton.h.

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.

void TDEConfigSkeletonItem::setWhatsThis ( const TQString &  w  )  [inline]

Set WhatsThis description og item.

Definition at line 142 of file tdeconfigskeleton.h.

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

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

TQString TDEConfigSkeletonItem::whatsThis (  )  const [inline]

Return WhatsThis description of item.

See setWhatsThis().

Definition at line 150 of file tdeconfigskeleton.h.

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.


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

tdecore

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

tdecore

Skip menu "tdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdecore by doxygen 1.7.1
This website is maintained by Timothy Pearson.