File indexing completed on 2024-04-21 16:20:31

 /*
  * SPDX-FileCopyrightText: 2009 Nokia Corporation.
  * SPDX-FileCopyrightText: 2016 David Edmundson <davidedmundson@kde.org>
  *
  * Contact: Marius Vollmer <marius.vollmer@nokia.com>
  *
  * SPDX-License-Identifier: LGPL-2.1-only
  *
  */
 
 #ifndef GCONFITEM_H
 #define GCONFITEM_H
 
 #include <QObject>
 #include <QStringList>
 #include <QVariant>
 
 /*!
 
   \brief GConfItem is a simple C++ wrapper for GConf.
 
   Creating a GConfItem instance gives you access to a single GConf
   key.  You can get and set its value, and connect to its
   valueChanged() signal to be notified about changes.
 
   The value of a GConf key is returned to you as a QVariant, and you
   pass in a QVariant when setting the value.  GConfItem converts
   between a QVariant and GConf values as needed, and according to the
   following rules:
 
   - A QVariant of type QVariant::Invalid denotes an unset GConf key.
 
   - QVariant::Int, QVariant::Double, QVariant::Bool are converted to
     and from the obvious equivalents.
 
   - QVariant::String is converted to/from a GConf string and always
     uses the UTF-8 encoding.  No other encoding is supported.
 
   - QVariant::StringList is converted to a list of UTF-8 strings.
 
   - QVariant::List (which denotes a QList<QVariant>) is converted
     to/from a GConf list.  All elements of such a list must have the
     same type, and that type must be one of QVariant::Int,
     QVariant::Double, QVariant::Bool, or QVariant::String.  (A list of
     strings is returned as a QVariant::StringList, however, when you
     get it back.)
 
   - Any other QVariant or GConf value is essentially ignored.
 
   - This is fored by Dave from libqtgconf to really reduce the amount of QObjects needed
     to manipulate various items in a tree.
 
 
   \warning GConfItem is as thread-safe as GConf.
 
 */
 
 class GConfItem : public QObject
 {
     Q_OBJECT
 
 public:
     /*! Initializes a GConfItem to access the GConf key denoted by
         \a key.  Key names should follow the normal GConf conventions
         like "/myapp/settings/first".
 
         \param key    The name of the key.
         \param parent Parent object
     */
     explicit GConfItem(const QString &keyRoot, QObject *parent = nullptr);
 
     /*! Finalizes a GConfItem.
      */
     ~GConfItem() override;
 
     /*! Returns the root of this item, as given to the constructor.
      */
     QString root() const;
 
     /*! Returns the current value of this item, as a QVariant.
      * subkey is relative to the provided root.
      */
     QVariant value(const QString &subKey) const;
 
     /*! Returns the current value of this item, as a QVariant.  If
      *  there is no value for this item, return \a def instead.
 
     */
     void set(const QString &subKey, const QVariant &val);
 
     /*! Return a list of the directories below this item.  The
         returned strings are absolute key names like
         "/myapp/settings".
 
         A directory is a key that has children.  The same key might
         also have a value, but that is confusing and best avoided.
     */
     QList<QString> listDirs() const;
 
     /*! Return a list of entries below this item.  The returned
         strings are absolute key names like "/myapp/settings/first".
 
         A entry is a key that has a value.  The same key might also
         have children, but that is confusing and is best avoided.
     */
     QList<QString> listEntries() const;
 
 Q_SIGNALS:
     /*! Emitted when some value in subtree of this item changes
      */
 
     void subtreeChanged(const QString &key, const QVariant &value);
 
 private:
     friend struct GConfItemPrivate;
     struct GConfItemPrivate *priv;
 
     void update_value(bool emit_signal, const QString &key, const QVariant &value);
 };
 
 #endif // GCONFITEM_H