KConfig 5.109.0
Public Types | Public Member Functions | List of all members
KConfigCompilerSignallingItem

#include <KCoreConfigSkeleton>

Public Types

typedef void(QObject::* NotifyFunction) (quint64 arg)
 
- Public Types inherited from KConfigSkeletonItem
typedef QHash< QString, KConfigSkeletonItem * > Dict
 
typedef QHash< QString, KConfigSkeletonItem * >::Iterator DictIterator
 
typedef QList< KConfigSkeletonItem * > List
 

Public Member Functions

 KConfigCompilerSignallingItem (KConfigSkeletonItem *item, QObject *object, NotifyFunction targetFunction, quint64 userData)
 Constructor.
 
KConfigGroup configGroup (KConfig *config) const
 
bool isEqual (const QVariant &p) const override
 Check whether the item is equal to p.
 
QVariant maxValue () const override
 Return maximum value of item or invalid if not specified.
 
QVariant minValue () const override
 Return minimum value of item or invalid if not specified.
 
QVariant property () const override
 Return item as property.
 
void readConfig (KConfig *) override
 This function is called by KCoreConfigSkeleton to read the value for this setting from a config file.
 
void readDefault (KConfig *) override
 Read global default value.
 
void setDefault () override
 Sets the current value to the default value.
 
void setGroup (const KConfigGroup &cg)
 
void setProperty (const QVariant &p) override
 Set item to p.
 
void setWriteFlags (KConfigBase::WriteConfigFlags flags)
 
void swapDefault () override
 Exchanges the current value with the default value Used by KCoreConfigSkeleton::useDefaults(bool);.
 
void writeConfig (KConfig *) override
 This function is called by KCoreConfigSkeleton to write the value of this setting to a config file.
 
KConfigBase::WriteConfigFlags writeFlags () const
 
- Public Member Functions inherited from KConfigSkeletonItem
 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.
 

Additional Inherited Members

- Protected Member Functions inherited from KConfigSkeletonItem
 __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 inherited from KConfigSkeletonItem
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

Author
Alex Richardson

This class wraps a KConfigSkeletonItem and invokes a function whenever the value changes. That function must take one quint64 parameter. Whenever the property value of the wrapped KConfigSkeletonItem changes this function will be invoked with the stored user data passed in the constructor. It does not call a function with the new value since this class is designed solely for the The KDE Configuration Compiler generated code and is therefore probably not suited for any other usecases.

See also
KConfigSkeletonItem

Constructor & Destructor Documentation

◆ KConfigCompilerSignallingItem()

KConfigCompilerSignallingItem::KConfigCompilerSignallingItem ( KConfigSkeletonItem item,
QObject *  object,
NotifyFunction  targetFunction,
quint64  userData 
)

Constructor.

Parameters
itemthe KConfigSkeletonItem to wrap
targetFunctionthe method to invoke whenever the value of item changes
objectThe object on which the method is invoked.
userDataThis data will be passed to targetFunction on every property change

Member Function Documentation

◆ isEqual()

bool KConfigCompilerSignallingItem::isEqual ( const QVariant &  p) const
overridevirtual

Check whether the item is equal to p.

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

Parameters
pQVariant to compare to
Returns
true if the item is equal to p, false otherwise

Implements KConfigSkeletonItem.

◆ maxValue()

QVariant KConfigCompilerSignallingItem::maxValue ( ) const
overridevirtual

Return maximum value of item or invalid if not specified.

Reimplemented from KConfigSkeletonItem.

◆ minValue()

QVariant KConfigCompilerSignallingItem::minValue ( ) const
overridevirtual

Return minimum value of item or invalid if not specified.

Reimplemented from KConfigSkeletonItem.

◆ property()

QVariant KConfigCompilerSignallingItem::property ( ) const
overridevirtual

Return item as property.

Implements KConfigSkeletonItem.

◆ readConfig()

void KConfigCompilerSignallingItem::readConfig ( KConfig )
overridevirtual

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

Implements KConfigSkeletonItem.

◆ readDefault()

void KConfigCompilerSignallingItem::readDefault ( KConfig )
overridevirtual

Read global default value.

Implements KConfigSkeletonItem.

◆ setDefault()

void KConfigCompilerSignallingItem::setDefault ( )
overridevirtual

Sets the current value to the default value.

Implements KConfigSkeletonItem.

◆ setProperty()

void KConfigCompilerSignallingItem::setProperty ( const QVariant &  p)
overridevirtual

Set item to p.

Implements KConfigSkeletonItem.

◆ swapDefault()

void KConfigCompilerSignallingItem::swapDefault ( )
overridevirtual

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

Implements KConfigSkeletonItem.

◆ writeConfig()

void KConfigCompilerSignallingItem::writeConfig ( KConfig )
overridevirtual

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

Make sure to pass writeFlags() to every call of KConfigGroup::writeEntry() and KConfigGroup::revertToDefault().

Implements KConfigSkeletonItem.