Program Listing for File settings.h

Return to documentation for file (/tmp/ws/src/qt_gui_core/qt_gui_cpp/include/qt_gui_cpp/settings.h)

/*
 * Copyright (c) 2011, Dirk Thomas, TU Darmstadt
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the TU Darmstadt nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef qt_gui_cpp__Settings_H
#define qt_gui_cpp__Settings_H

#include "generic_proxy.h"

#include <QString>
#include <QStringList>
// Upstream issue: https://codereview.qt-project.org/c/qt/qtbase/+/272258
#if __GNUC__ >= 9
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wdeprecated-copy"
#endif
#include <QVariant>
#if __GNUC__ >= 9
# pragma GCC diagnostic pop
#endif

namespace qt_gui_cpp
{

class Settings
{

public:

  Settings(QObject* obj);

  Settings getSettings(const QString& prefix);

  QStringList allKeys() const;

//  int beginReadArray(const QString& prefix);

//  void beginWriteArray(const QString& prefix, int size = -1);

  QStringList childGroups() const;

  QStringList childKeys() const;

  bool contains(const QString& key) const;

//  void endArray();

  void remove(const QString& key);

//  void setArrayIndex(int i);

  void setValue(const QString& key, const QVariant& value);

  QVariant value(const QString& key, const QVariant& defaultValue = QVariant()) const;

protected:

  GenericProxy proxy_;

};

} // namespace

#endif // qt_gui_cpp__Settings_H