bpssettings.h

Go to the documentation of this file.

 
#ifndef BPSSETTINGS_H
#define BPSSETTINGS_H
 
#include <QObject>
#include <QStringList>
#include "bps.h"
 
class BpsDatastore;
 
class BPSCORE_EXPORT BpsSettings : public QObject
{
    Q_OBJECT
    Q_FLAGS(Scopes)
    BPS_PRIVATE(BpsSettings)
 
public:
 
    enum Scope {
        NoScope             = 0x00000000,
 
        LocalUserScope      = 0x00000001,
 
        LocalInstallScope   = 0x00000002,
 
        LocalSystemScope    = 0x00000004,
 
        CentralUserScope    = 0x00000010,
 
        CentralSystemScope  = 0x00000020,
 
        LocalScopes         = LocalUserScope | LocalInstallScope | LocalSystemScope,
 
        CentralScopes       = CentralUserScope | CentralSystemScope,
 
        AllScopes           = LocalScopes | CentralScopes
 
    };
 
    Q_DECLARE_FLAGS(Scopes, Scope)
 
    
    BpsSettings(
        BpsDatastore* aDatastore,
        Scope aScope = BpsSettings::LocalUserScope,
        QObject* aParent = nullptr);
 
    BpsSettings(
        Scope aScope = BpsSettings::LocalUserScope,
        QObject* aParent = nullptr);
 
    virtual ~BpsSettings();
 
    Scope scope() const;
 
    Scope groupScope(const QString& aName, Scopes aSearchedScopes = (Scopes)AllScopes) const;
 
    void setScope(Scope aScope);
 
    QString root() const;
 
    void setRoot(const QString& aRoot);
 
    void open(const QString& aPath);
 
    void close();
 
    void closeAll();
 
    QStringList groups() const;
 
    bool groupExists(const QString& aGroup) const;
 
    QStringList keys() const;
 
    bool keyExists(const QString& aKey) const;
 
    QVariant value(const QString& aKey, const QVariant& aDefValue = QVariant()) const;
 
    QStringList allGroups(Scopes aSearchedScopes = (Scopes)AllScopes) const;
 
    QStringList allKeys(Scopes aSearchedScopes = (Scopes)AllScopes) const;
 
    QVariant findValue(
        const QString& aKey,
        const QVariant& aDefValue = QVariant(),
        Scopes aSearchedScopes = (Scopes)AllScopes) const;
 
    void setValue(const QString& aKey, const QVariant& aValue);
 
    void removeKey(const QString& aKey);
 
    void removeGroup(const QString& aName);
 
    QVariantMap valueMap(Scopes aSearchedScopes = (Scopes)AllScopes) const;
 
    void setValueMap(const QVariantMap& aMap);
 
}; // BpsSettings
 
Q_DECLARE_OPERATORS_FOR_FLAGS(BpsSettings::Scopes)
 
#endif // BPSSETTINGS_H