ecvSettingManager.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <QCoreApplication>
#include <QSettings>
#include <QSharedPointer>
// Qt5/Qt6 Compatibility
#include <QtCompat.h>
 
#include "CVAppCommon.h"
 
class QDialog;
class QMainWindow;
class QDockWidget;
class CVAPPCOMMON_LIB_API ecvSettingManager : public QSettings {
    Q_OBJECT
    typedef QSettings Superclass;
 
public:
    ~ecvSettingManager() override {}
 
 
    static ecvSettingManager *TheInstance(bool autoInit = true);
 
    static void ReleaseInstance();
 
    static void Init(const QString &path);  //
    static void setValue(const QString &section,
                         const QString &key,
                         const QVariant &value);                        //
    static void removeNode(const QString &section);                     //
    static void removeKey(const QString &section, const QString &key);  //
    static QVariant getValue(const QString &section,
                             const QString &key,
                             const QVariant &defaultValue = QVariant());  //
 
    virtual void saveState(const QMainWindow &window, const QString &key);
    virtual void saveState(const QDialog &dialog, const QString &key);
 
    virtual void restoreState(const QString &key, QMainWindow &window);
    virtual void restoreState(const QString &key, QDialog &dialog);
 
    virtual void alertSettingsModified();
 
    QString backup(const QString &filename = QString());
 
public:
    virtual void clear();
    virtual void sync();
    virtual Status status() const;
    virtual bool isAtomicSyncRequired() const;
    virtual void setAtomicSyncRequired(bool enable);
 
    virtual void beginGroup(const QString &prefix);
    virtual void endGroup();
    virtual QString group() const;
 
    virtual int beginReadArray(const QString &prefix);
    virtual void beginWriteArray(const QString &prefix, int size = -1);
    virtual void endArray();
    virtual void setArrayIndex(int i);
 
    virtual QStringList allKeys() const;
    virtual QStringList childKeys() const;
    virtual QStringList childGroups() const;
    virtual bool isWritable() const;
 
    virtual void setValue(const QString &key, const QVariant &value);
    virtual QVariant value(const QString &key,
                           const QVariant &defaultValue = QVariant()) const;
 
    virtual void remove(const QString &key);
    virtual bool contains(const QString &key) const;
 
    virtual void setFallbacksEnabled(bool b);
    virtual bool fallbacksEnabled() const;
 
    virtual QString fileName() const;
    virtual Format format() const;
    virtual Scope scope() const;
    virtual QString organizationName() const;
    virtual QString applicationName() const;
 
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
#if defined(QT_CONFIG) && QT_CONFIG(textcodec)
    void setIniCodec(QTextCodec *codec);
    void setIniCodec(const char *codecName);
    QTextCodec *iniCoxdec() const;
#endif
#endif
protected:
    virtual void sanityCheckDock(QDockWidget *docke_widget);
 
private:
 
    ecvSettingManager() {}
 
    QSharedPointer<QSettings> m_iniFile;
 
signals:
    void modified();
};