qxsettings.h

浏览该文件的文档.

 
#ifndef QXSETTINGS_H
#define QXSETTINGS_H
 
#include "qxcore_global.h"
 
#include <QtCore/QObject>
#include <QtCore/QSettings>
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QVariant>
 
#include <functional>
 
QX_CORE_BEGIN_NAMESPACE
 
class QxSettingsPrivate;
 
class QX_CORE_EXPORT QxSettings : public QObject
{
    Q_OBJECT
public:
    using Migration = std::function<void(QxSettings &settings)>;
 
    explicit QxSettings(const QString &organization, const QString &application = QString(), QObject *parent = nullptr);
    explicit QxSettings(const QString &fileName, QSettings::Format format, QObject *parent = nullptr);
    ~QxSettings() override;
 
    QSettings *settings() const;
    QString fileName() const;
 
    // Group -----------------------------------------------------------------
    void beginGroup(const QString &prefix);
    void endGroup();
    QString group() const;
 
    // Read ------------------------------------------------------------------
    bool contains(const QString &key) const;
    QVariant value(const QString &key, const QVariant &defaultValue = QVariant()) const;
    QString stringValue(const QString &key, const QString &defaultValue = QString()) const;
    int intValue(const QString &key, int defaultValue = 0) const;
    bool boolValue(const QString &key, bool defaultValue = false) const;
    QStringList stringListValue(const QString &key, const QStringList &defaultValue = QStringList()) const;
    QStringList allKeys() const;
 
    // Write -----------------------------------------------------------------
    void setValue(const QString &key, const QVariant &value);
    void remove(const QString &key);
    void clear();
    void sync();
 
    // Migration -------------------------------------------------------------
    void setVersionKey(const QString &key);
    QString versionKey() const;
    int version() const;
    void setVersion(int version);
 
    void addMigration(int version, Migration migration);
 
    int migrate(int targetVersion);
 
Q_SIGNALS:
    void valueChanged(const QString &key, const QVariant &value);
private:
    Q_DISABLE_COPY(QxSettings)
    QX_DECLARE_PRIVATE(QxSettings)
};
 
QX_CORE_END_NAMESPACE
 
#endif   // QXSETTINGS_H