class MyPrefs : public KCoreConfigSkeleton
{
  public:
    MyPrefs()
    {
      setCurrentGroup("MyGroup");
      addItemBool("MySetting1", mMyBool, false);
      addItemPoint("MySetting2", mMyPoint, QPoint(100, 200));

      setCurrentGroup("MyOtherGroup");
      addItemDouble("MySetting3", mMyDouble, 3.14);
    }

    bool mMyBool;
    QPoint mMyPoint;
    double mMyDouble;
}

Member Function Documentation

[explicit] KCoreConfigSkeleton::KCoreConfigSkeleton(KSharedConfig::Ptr config, QObject *parent = nullptr)

Constructor.

config configuration object to use

parent the parent object (see QObject documentation)

[explicit] KCoreConfigSkeleton::KCoreConfigSkeleton(const QString &configname = QString(), QObject *parent = nullptr)

Constructor.

configname name of config file. If no name is given, the default config file as returned by KSharedConfig::openConfig() is used

parent the parent object (see QObject documentation)

void KCoreConfigSkeleton::addItem(KConfigSkeletonItem *item, const QString &name = QString())

Register a custom KConfigSkeletonItem item with a given name.

If name is a null string, take the name from KConfigSkeletonItem::key().

KCoreConfigSkeleton takes ownership of item.

KCoreConfigSkeleton::ItemBool *KCoreConfigSkeleton::addItemBool(const QString &name, bool &reference, bool defaultValue = false, const QString &key = QString())

Register an item of type bool.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemDateTime *KCoreConfigSkeleton::addItemDateTime(const QString &name, QDateTime &reference, const QDateTime &defaultValue = QDateTime(), const QString &key = QString())

Register an item of type QDateTime.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemDouble *KCoreConfigSkeleton::addItemDouble(const QString &name, double &reference, double defaultValue = 0.0, const QString &key = QString())

Register an item of type double.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemInt *KCoreConfigSkeleton::addItemInt(const QString &name, qint32 &reference, qint32 defaultValue = 0, const QString &key = QString())

Register an item of type qint32.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemIntList *KCoreConfigSkeleton::addItemIntList(const QString &name, QList<int> &reference, const QList<int> &defaultValue = QList<int>(), const QString &key = QString())

Register an item of type QList<int>.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemLongLong *KCoreConfigSkeleton::addItemLongLong(const QString &name, qint64 &reference, qint64 defaultValue = 0, const QString &key = QString())

Register an item of type qint64.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemPassword *KCoreConfigSkeleton::addItemPassword(const QString &name, QString &reference, const QString &defaultValue = QLatin1String(""), const QString &key = QString())

Register a password item of type QString. The string value is written encrypted to the config file.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemPath *KCoreConfigSkeleton::addItemPath(const QString &name, QString &reference, const QString &defaultValue = QLatin1String(""), const QString &key = QString())

Register a path item of type QString. The string value is interpreted as a path. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemPoint *KCoreConfigSkeleton::addItemPoint(const QString &name, QPoint &reference, const QPoint &defaultValue = QPoint(), const QString &key = QString())

Register an item of type QPoint.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemPointF *KCoreConfigSkeleton::addItemPointF(const QString &name, QPointF &reference, const QPointF &defaultValue = QPointF(), const QString &key = QString())

Register an item of type QPointF.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemProperty *KCoreConfigSkeleton::addItemProperty(const QString &name, QVariant &reference, const QVariant &defaultValue = QVariant(), const QString &key = QString())

Register a property item of type QVariant.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemRect *KCoreConfigSkeleton::addItemRect(const QString &name, QRect &reference, const QRect &defaultValue = QRect(), const QString &key = QString())

Register an item of type QRect.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemRectF *KCoreConfigSkeleton::addItemRectF(const QString &name, QRectF &reference, const QRectF &defaultValue = QRectF(), const QString &key = QString())

Register an item of type QRectF.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemSize *KCoreConfigSkeleton::addItemSize(const QString &name, QSize &reference, const QSize &defaultValue = QSize(), const QString &key = QString())

Register an item of type QSize.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemSizeF *KCoreConfigSkeleton::addItemSizeF(const QString &name, QSizeF &reference, const QSizeF &defaultValue = QSizeF(), const QString &key = QString())

Register an item of type QSizeF.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemString *KCoreConfigSkeleton::addItemString(const QString &name, QString &reference, const QString &defaultValue = QLatin1String(""), const QString &key = QString())

Register an item of type QString.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemStringList *KCoreConfigSkeleton::addItemStringList(const QString &name, QStringList &reference, const QStringList &defaultValue = QStringList(), const QString &key = QString())

Register an item of type QStringList.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemUInt *KCoreConfigSkeleton::addItemUInt(const QString &name, quint32 &reference, quint32 defaultValue = 0, const QString &key = QString())

Register an item of type quint32.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

KCoreConfigSkeleton::ItemULongLong *KCoreConfigSkeleton::addItemULongLong(const QString &name, quint64 &reference, quint64 defaultValue = 0, const QString &key = QString())

Register an item of type quint64.

name Name used to identify this setting. Names must be unique.

reference Pointer to the variable, which is set by readConfig() calls and read by save() calls.

defaultValue Default value, which is used when the config file does not yet contain the key of this item.

key Key used in config file. If key is a null string, name is used as key.

Returns the created item

void KCoreConfigSkeleton::clearItems()

Removes and deletes all items

KConfig *KCoreConfigSkeleton::config()

Return the KConfig object used for reading and writing the settings.

const KConfig *KCoreConfigSkeleton::config() const

Return the KConfig object used for reading and writing the settings.

[signal] void KCoreConfigSkeleton::configChanged()

This signal is emitted when the configuration change.

QString KCoreConfigSkeleton::currentGroup() const

Returns the current group used for addItem() calls.

See also setCurrentGroup().

[since 4.4] KConfigSkeletonItem *KCoreConfigSkeleton::findItem(const QString &name) const

Lookup item by name

This function was introduced in 4.4.

[since 5.64] bool KCoreConfigSkeleton::isDefaults() const

Indicates if all the registered items are set to their default value.

This function was introduced in 5.64.

[invokable, since 4.4] bool KCoreConfigSkeleton::isImmutable(const QString &name) const

Return whether a certain item is immutable

This function was introduced in 4.4.

[since 5.64] bool KCoreConfigSkeleton::isSaveNeeded() const

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

This function was introduced in 5.64.

KConfigSkeletonItem::List KCoreConfigSkeleton::items() const

Return list of items managed by this KCoreConfigSkeleton object.

void KCoreConfigSkeleton::load()

Read preferences from config file. All registered items are set to the values read from disk.

This method calls usrRead() after reading the settings of the registered items from the KConfig. You can override usrRead() in derived classes if you have special requirements.

[since 5.0] void KCoreConfigSkeleton::read()

Read preferences from the KConfig object. This method assumes that the KConfig object was previously loaded, i.e. it uses the in-memory values from KConfig without reloading from disk.

This method calls usrRead() after reading the settings of the registered items from the KConfig. You can override usrRead() in derived classes if you have special requirements.

This function was introduced in 5.0.

void KCoreConfigSkeleton::removeItem(const QString &name)

Removes and deletes an item by name

name the name of the item to remove

[slot] bool KCoreConfigSkeleton::save()

Write preferences to config file. The values of all registered items are written to disk. This method calls usrSave() after writing the settings from the registered items to the KConfig. You can override usrSave() in derived classes if you have special requirements.

void KCoreConfigSkeleton::setCurrentGroup(const QString &group)

Set the config file group for subsequent addItem() calls. It is valid until setCurrentGroup() is called with a new argument. Call this before you add any items. The default value is "No Group".

See also currentGroup().

[virtual] void KCoreConfigSkeleton::setDefaults()

Set all registered items to their default values.

This method calls usrSetDefaults() after setting the defaults for the registered items. You can override usrSetDefaults() in derived classes if you have special requirements.

If you need more fine-grained control of setting the default values of the registered items you can override setDefaults() in a derived class.

See also isDefaults().

void KCoreConfigSkeleton::setSharedConfig(KSharedConfig::Ptr pConfig)

Set the KSharedConfig object used for reading and writing the settings.

See also sharedConfig().

[since 5.0] KSharedConfig::Ptr KCoreConfigSkeleton::sharedConfig() const

Return the KConfig object used for reading and writing the settings.

This function was introduced in 5.0.

See also setSharedConfig().

[virtual] bool KCoreConfigSkeleton::useDefaults(bool b)

Specify whether this object should reflect the actual values or the default values. This method is implemented by usrUseDefaults(), which can be overridden in derived classes if you have special requirements and can call usrUseDefaults() directly. If you don't have control whether useDefaults() or usrUseDefaults() is called override useDefaults() directly.

b true to make this object reflect the default values, false to make it reflect the actual values. Returns the state prior to this call

[virtual protected] void KCoreConfigSkeleton::usrRead()

Perform the actual reading of the configuration file. Override in derived classes to read special config values. Called from read()

[virtual protected] bool KCoreConfigSkeleton::usrSave()

Perform the actual writing of the configuration file. Override in derived classes to write special config values. Called from save()

[virtual protected] void KCoreConfigSkeleton::usrSetDefaults()

Perform the actual setting of default values. Override in derived classes to set special default values. Called from setDefaults()

[virtual protected] bool KCoreConfigSkeleton::usrUseDefaults(bool b)

Implemented by subclasses that use special defaults. It replaces the default values with the actual values and vice versa. Called from useDefaults()

b true to make this object reflect the default values, false to make it reflect the actual values.

Returns the state prior to this call