File indexing completed on 2024-05-12 03:54:28

 /*
     This file is part of KDE.
     SPDX-FileCopyrightText: 2001, 2002, 2003 Cornelius Schumacher <schumacher@kde.org>
     SPDX-FileCopyrightText: 2003 Waldo Bastian <bastian@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KCONFIGSKELETON_H
 #define KCONFIGSKELETON_H
 
 #include <kconfiggui_export.h>
 
 #include <kcoreconfigskeleton.h>
 
 #include <QColor>
 #include <QFont>
 
 /**
  * @class KConfigSkeleton kconfigskeleton.h <KConfigSkeleton>
  *
  * @short Class for handling preferences settings for an application.
  * @author Cornelius Schumacher
  *
  * This class extends KCoreConfigSkeleton by support for GUI types.
  */
 class KCONFIGGUI_EXPORT KConfigSkeleton : public KCoreConfigSkeleton
 {
     Q_OBJECT
 public:
     /**
      * Class for handling a color preferences item.
      */
     class KCONFIGGUI_EXPORT ItemColor : public KConfigSkeletonGenericItem<QColor>
     {
     public:
         /** @copydoc KConfigSkeletonGenericItem::KConfigSkeletonGenericItem */
         ItemColor(const QString &_group, const QString &_key, QColor &reference, const QColor &defaultValue = QColor(128, 128, 128));
 
         /** @copydoc KConfigSkeletonItem::readConfig(KConfig*) */
         void readConfig(KConfig *config) override;
 
         /** @copydoc KConfigSkeletonItem::setProperty(const QVariant&) */
         void setProperty(const QVariant &p) override;
 
         /** @copydoc KConfigSkeletonItem::isEqual(const QVariant &) */
         bool isEqual(const QVariant &p) const override;
 
         /** @copydoc KConfigSkeletonItem::property() */
         QVariant property() const override;
     };
 
     /**
      * Class for handling a font preferences item.
      */
     class KCONFIGGUI_EXPORT ItemFont : public KConfigSkeletonGenericItem<QFont>
     {
     public:
         /** @copydoc KConfigSkeletonGenericItem::KConfigSkeletonGenericItem */
         ItemFont(const QString &_group, const QString &_key, QFont &reference, const QFont &defaultValue = QFont());
 
         /** @copydoc KConfigSkeletonItem::readConfig(KConfig*) */
         void readConfig(KConfig *config) override;
 
         /** @copydoc KConfigSkeletonItem::setProperty(const QVariant&) */
         void setProperty(const QVariant &p) override;
 
         /** @copydoc KConfigSkeletonItem::isEqual(const QVariant &) */
         bool isEqual(const QVariant &p) const override;
 
         /** @copydoc KConfigSkeletonItem::property() */
         QVariant property() const override;
     };
 
 public:
     /**
      * Constructor.
      *
      * @param configname name of config file. If no name is given, the default
      * config file as returned by KSharedConfig::openConfig() is used.
      */
     explicit KConfigSkeleton(const QString &configname = QString(), QObject *parent = nullptr);
 
     /**
      * Constructor.
      *
      * @param config configuration object to use.
      */
     explicit KConfigSkeleton(KSharedConfig::Ptr config, QObject *parent = nullptr);
 
     /**
      * Register an item of type QColor.
      *
      * @param name Name used to identify this setting. Names must be unique.
      * @param reference Pointer to the variable, which is set by read()
      * calls and read by save() calls.
      * @param defaultValue Default value, which is used when the config file
      * does not yet contain the key of this item.
      * @param key Key used in config file. If @p key is a null string, @p name is used as key.
      * @return The created item
      */
     ItemColor *addItemColor(const QString &name, QColor &reference, const QColor &defaultValue = QColor(128, 128, 128), const QString &key = QString());
 
     /**
      * Register an item of type QFont.
      *
      * @param name Name used to identify this setting. Names must be unique.
      * @param reference Pointer to the variable, which is set by read()
      * calls and read by save() calls.
      * @param defaultValue Default value, which is used when the config file
      * does not yet contain the key of this item.
      * @param key Key used in config file. If @p key is a null string, @p name is used as key.
      * @return The created item
      */
     ItemFont *addItemFont(const QString &name, QFont &reference, const QFont &defaultValue = QFont(), const QString &key = QString());
 };
 
 #endif