isettings.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018-2026 QuasarApp.
 * Distributed under the lgplv3 software license, see the accompanying
 * Everyone is permitted to copy and distribute verbatim copies
 * of this license document, but changing it is not allowed.
*/
 
#ifndef ISETTINGS_H
#define ISETTINGS_H
 
#include "qaservice.h"
#include "quasarapp_global.h"
#include <QObject>
#include <QVariant>
 
class QSettings;
 
namespace QuasarAppUtils {

enum class SettingsSaveMode: quint64 {
    Auto,
    Manual
};

class QUASARAPPSHARED_EXPORT ISettings : public QObject, public Service<ISettings>
{
    Q_OBJECT
 
public:
    ~ISettings() override;

    Q_INVOKABLE QVariant getValue(const QString &key, const QVariant& def = {});

    Q_INVOKABLE QString getStrValue(const QString &key, const QString& def = {});

    Q_INVOKABLE void resetToDefault();

    virtual bool ignoreToRest(const QString& key) const;

    void sync();

    void forceReloadCache();

    SettingsSaveMode getMode() const;

    void setMode(const SettingsSaveMode &mode);

    static ISettings* instance();

    static bool initService(std::unique_ptr<ISettings> obj);
 
public slots:
    void setValue(const QString &key, const QVariant& value);

    void setStrValue(const QString& key, const QString& value);
 
 
signals:
    void valueChanged(QString key, QVariant value);

    void valueStrChanged(QString key, QString value);
 
protected:
 
    explicit ISettings(SettingsSaveMode mode = SettingsSaveMode::Auto);

    virtual QHash<QString, QVariant> defaultSettings() = 0;

    virtual void syncImplementation() = 0;

    virtual QVariant getValueImplementation(const QString &key, const QVariant& def) = 0;

    virtual void setValueImplementation(const QString key, const QVariant& value) = 0;

    void clearCache();

    QHash<QString, QVariant>& settingsMap();
 
private:
 
    SettingsSaveMode _mode = SettingsSaveMode::Auto;
 
    QHash<QString, QVariant> _cache;
    QHash<QString, QVariant> *_defaultConfig = nullptr;
 
    friend class Service<ISettings>;
};
 
 
};
 
 
#endif // ISETTINGS_H