KCoreConfigSkeleton::ItemProperty

Search for usage in LXR

KCoreConfigSkeleton::ItemProperty Class Reference

#include <kcoreconfigskeleton.h>

Inheritance diagram for KCoreConfigSkeleton::ItemProperty:

Public Member Functions

 ItemProperty (const QString &_group, const QString &_key, QVariant &reference, const QVariant &defaultValue=QVariant())
 
bool isEqual (const QVariant &p) const override
 
QVariant property () const override
 
void readConfig (KConfig *config) override
 
void setProperty (const QVariant &p) override
 
- Public Member Functions inherited from KConfigSkeletonGenericItem< QVariant >
 KConfigSkeletonGenericItem (const QString &_group, const QString &_key, QVariant &reference, QVariant defaultValue)
 
void readDefault (KConfig *config) override
 
void setDefault () override
 
virtual void setDefaultValue (const QVariant &v)
 
void setValue (const QVariant &v)
 
void swapDefault () override
 
QVariantvalue ()
 
const QVariantvalue () const
 
void writeConfig (KConfig *config) override
 
- Public Member Functions inherited from KConfigSkeletonItem
 KConfigSkeletonItem (const QString &_group, const QString &_key)
 
virtual ~KConfigSkeletonItem ()
 
KConfigGroup configGroup (KConfig *config) const
 
QVariant getDefault () const
 
QString group () const
 
bool isDefault () const
 
bool isImmutable () const
 
bool isSaveNeeded () const
 
QString key () const
 
QString label () const
 
virtual QVariant maxValue () const
 
virtual QVariant minValue () const
 
QString name () const
 
void setGroup (const KConfigGroup &cg)
 
void setGroup (const QString &_group)
 
void setKey (const QString &_key)
 
void setLabel (const QString &l)
 
void setName (const QString &_name)
 
void setToolTip (const QString &t)
 
void setWhatsThis (const QString &w)
 
void setWriteFlags (KConfigBase::WriteConfigFlags flags)
 
QString toolTip () const
 
QString whatsThis () const
 
KConfigBase::WriteConfigFlags writeFlags () const
 

Additional Inherited Members

- Public Types inherited from KConfigSkeletonItem
typedef QHash< QString, KConfigSkeletonItem * > Dict
 
typedef QHash< QString, KConfigSkeletonItem * >::Iterator DictIterator
 
typedef QList< KConfigSkeletonItem * > List
 
- Protected Member Functions inherited from KConfigSkeletonItem
KCONFIGCORE_NO_EXPORT KConfigSkeletonItem (KConfigSkeletonItemPrivate &dd, const QString &_group, const QString &_key)
 
void readImmutability (const KConfigGroup &group)
 
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 KConfigSkeletonGenericItem< QVariant >
QVariant mDefault
 
QVariant mLoadedValue
 
QVariantmReference
 
- Protected Attributes inherited from KConfigSkeletonItem
KConfigSkeletonItemPrivate *const d_ptr
 
QString mGroup
 
QString mKey
 
QString mName
 

Detailed Description

Class for handling a QVariant preferences item.

Definition at line 645 of file kcoreconfigskeleton.h.

Constructor & Destructor Documentation

◆ ItemProperty()

KCoreConfigSkeleton::ItemProperty::ItemProperty ( const QString & _group,
const QString & _key,
QVariant & reference,
const QVariant & defaultValue = QVariant() )

Constructor.

Parameters
_groupConfig file group.
_keyConfig file key.
referenceThe initial value to hold in the item
defaultValueThe default value for the item

Definition at line 395 of file kcoreconfigskeleton.cpp.

Member Function Documentation

◆ isEqual()

bool KCoreConfigSkeleton::ItemProperty::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.

Definition at line 414 of file kcoreconfigskeleton.cpp.

◆ property()

QVariant KCoreConfigSkeleton::ItemProperty::property ( ) const
overridevirtual

Return item as property.

Implements KConfigSkeletonItem.

Definition at line 420 of file kcoreconfigskeleton.cpp.

◆ readConfig()

void KCoreConfigSkeleton::ItemProperty::readConfig ( KConfig * )
overridevirtual

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

Implements KConfigSkeletonItem.

Definition at line 400 of file kcoreconfigskeleton.cpp.

◆ setProperty()

void KCoreConfigSkeleton::ItemProperty::setProperty ( const QVariant & p)
overridevirtual

Set item to p.

Implements KConfigSkeletonItem.

Definition at line 409 of file kcoreconfigskeleton.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:18:27 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.