KConfig 5.109.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KConfigSkeletonItemabstract

Class for storing a preferences setting. More...

#include <KCoreConfigSkeleton>

Public Types

typedef QHash< QString, KConfigSkeletonItem * > Dict
 
typedef QHash< QString, KConfigSkeletonItem * >::Iterator DictIterator
 
typedef QList< KConfigSkeletonItem * > List
 

Public Member Functions

 KConfigSkeletonItem (const QString &_group, const QString &_key)
 Constructor.
 
virtual ~KConfigSkeletonItem ()
 Destructor.
 
KConfigGroup configGroup (KConfig *config) const
 Return a KConfigGroup, the one provided by setGroup(const KConfigGroup&) if it's valid, or make one from config and item's group.
 
QVariant getDefault () const
 Returns the default value.
 
QString group () const
 Return name of config file group.
 
bool isDefault () const
 Indicates if the item is set to its default value.
 
virtual bool isEqual (const QVariant &p) const =0
 Check whether the item is equal to p.
 
bool isImmutable () const
 Return if the entry can be modified.
 
bool isSaveNeeded () const
 Indicates if the item has a different value than the previously loaded value.
 
QString key () const
 Return config file key.
 
QString label () const
 Return the label of the item.
 
virtual QVariant maxValue () const
 Return maximum value of item or invalid if not specified.
 
virtual QVariant minValue () const
 Return minimum value of item or invalid if not specified.
 
QString name () const
 Return internal name of entry.
 
virtual QVariant property () const =0
 Return item as property.
 
virtual void readConfig (KConfig *)=0
 This function is called by KCoreConfigSkeleton to read the value for this setting from a config file.
 
virtual void readDefault (KConfig *)=0
 Read global default value.
 
virtual void setDefault ()=0
 Sets the current value to the default value.
 
void setGroup (const KConfigGroup &cg)
 Set config file group but giving the KConfigGroup.
 
void setGroup (const QString &_group)
 Set config file group.
 
void setKey (const QString &_key)
 Set config file key.
 
void setLabel (const QString &l)
 Set label providing a translated one-line description of the item.
 
void setName (const QString &_name)
 Set internal name of entry.
 
virtual void setProperty (const QVariant &p)=0
 Set item to p.
 
void setToolTip (const QString &t)
 Set ToolTip description of item.
 
void setWhatsThis (const QString &w)
 Set WhatsThis description of item.
 
void setWriteFlags (KConfigBase::WriteConfigFlags flags)
 The write flags to be used when writing configuration.
 
virtual void swapDefault ()=0
 Exchanges the current value with the default value Used by KCoreConfigSkeleton::useDefaults(bool);.
 
QString toolTip () const
 Return ToolTip description of item.
 
QString whatsThis () const
 Return WhatsThis description of item.
 
virtual void writeConfig (KConfig *)=0
 This function is called by KCoreConfigSkeleton to write the value of this setting to a config file.
 
KConfigBase::WriteConfigFlags writeFlags () const
 Return write flags to be used when writing configuration.
 

Protected Member Functions

 __attribute__ ((visibility("hidden"))) explicit KConfigSkeletonItem(KConfigSkeletonItemPrivate &dd
 
void readImmutability (const KConfigGroup &group)
 Sets mIsImmutable to true if mKey in config is immutable.
 
void setGetDefaultImpl (const std::function< QVariant()> &impl)
 
void setIsDefaultImpl (const std::function< bool()> &impl)
 
void setIsSaveNeededImpl (const std::function< bool()> &impl)
 

Protected Attributes

const QString & _group
 
const QString const QString & _key
 
KConfigSkeletonItemPrivate *const d_ptr
 
QString mGroup
 The group name for this item.
 
QString mKey
 The config key for this item.
 
QString mName
 The name of this item.
 

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().

Constructor & Destructor Documentation

◆ KConfigSkeletonItem()

KConfigSkeletonItem::KConfigSkeletonItem ( const QString &  _group,
const QString &  _key 
)

Constructor.

Parameters
_groupConfig file group.
_keyConfig file key.

◆ ~KConfigSkeletonItem()

virtual KConfigSkeletonItem::~KConfigSkeletonItem ( )
virtual

Destructor.

Member Function Documentation

◆ configGroup()

KConfigGroup KConfigSkeletonItem::configGroup ( KConfig config) const

Return a KConfigGroup, the one provided by setGroup(const KConfigGroup&) if it's valid, or make one from config and item's group.

See also
setGroup(const QString &_group)
setGroup(KConfigGroup cg)
Since
5.68

◆ getDefault()

QVariant KConfigSkeletonItem::getDefault ( ) const

Returns the default value.

Since
5.74

◆ group()

QString KConfigSkeletonItem::group ( ) const

Return name of config file group.

◆ isDefault()

bool KConfigSkeletonItem::isDefault ( ) const

Indicates if the item is set to its default value.

Since
5.64

◆ isEqual()

virtual bool KConfigSkeletonItem::isEqual ( const QVariant &  p) const
pure virtual

◆ isImmutable()

bool KConfigSkeletonItem::isImmutable ( ) const

Return if the entry can be modified.

◆ isSaveNeeded()

bool KConfigSkeletonItem::isSaveNeeded ( ) const

Indicates if the item has a different value than the previously loaded value.

Since
5.64

◆ key()

QString KConfigSkeletonItem::key ( ) const

Return config file key.

◆ label()

QString KConfigSkeletonItem::label ( ) const

Return the label of the item.

See also
setLabel()

◆ maxValue()

virtual QVariant KConfigSkeletonItem::maxValue ( ) const
virtual

◆ minValue()

virtual QVariant KConfigSkeletonItem::minValue ( ) const
virtual

◆ name()

QString KConfigSkeletonItem::name ( ) const

Return internal name of entry.

◆ property()

virtual QVariant KConfigSkeletonItem::property ( ) const
pure virtual

◆ readConfig()

virtual void KConfigSkeletonItem::readConfig ( KConfig )
pure virtual

◆ readDefault()

virtual void KConfigSkeletonItem::readDefault ( KConfig )
pure virtual

◆ readImmutability()

void KConfigSkeletonItem::readImmutability ( const KConfigGroup group)
protected

Sets mIsImmutable to true if mKey in config is immutable.

Parameters
groupKConfigGroup to check if mKey is immutable in

◆ setDefault()

virtual void KConfigSkeletonItem::setDefault ( )
pure virtual

◆ setGroup() [1/2]

void KConfigSkeletonItem::setGroup ( const KConfigGroup cg)

Set config file group but giving the KConfigGroup.

Allow the item to be in nested groups.

Since
5.68

◆ setGroup() [2/2]

void KConfigSkeletonItem::setGroup ( const QString &  _group)

Set config file group.

◆ setKey()

void KConfigSkeletonItem::setKey ( const QString &  _key)

Set config file key.

◆ setLabel()

void KConfigSkeletonItem::setLabel ( const QString &  l)

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

◆ setName()

void KConfigSkeletonItem::setName ( const QString &  _name)

Set internal name of entry.

◆ setProperty()

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

◆ setToolTip()

void KConfigSkeletonItem::setToolTip ( const QString &  t)

Set ToolTip description of item.

Since
4.2

◆ setWhatsThis()

void KConfigSkeletonItem::setWhatsThis ( const QString &  w)

Set WhatsThis description of item.

◆ setWriteFlags()

void KConfigSkeletonItem::setWriteFlags ( KConfigBase::WriteConfigFlags  flags)

The write flags to be used when writing configuration.

Since
5.58

◆ swapDefault()

virtual void KConfigSkeletonItem::swapDefault ( )
pure virtual

◆ toolTip()

QString KConfigSkeletonItem::toolTip ( ) const

Return ToolTip description of item.

See also
setToolTip()
Since
4.2

◆ whatsThis()

QString KConfigSkeletonItem::whatsThis ( ) const

Return WhatsThis description of item.

See also
setWhatsThis()

◆ writeConfig()

virtual void KConfigSkeletonItem::writeConfig ( KConfig )
pure virtual

◆ writeFlags()

KConfigBase::WriteConfigFlags KConfigSkeletonItem::writeFlags ( ) const

Return write flags to be used when writing configuration.

They should be passed to every call of KConfigGroup::writeEntry() and KConfigGroup::revertToDefault().

Since
5.58

Member Data Documentation

◆ mGroup

QString KConfigSkeletonItem::mGroup
protected

The group name for this item.

◆ mKey

QString KConfigSkeletonItem::mKey
protected

The config key for this item.

◆ mName

QString KConfigSkeletonItem::mName
protected

The name of this item.