qgssettingsregistry.h

Go to the documentation of this file.

/***************************************************************************
  qgssettingsregistry.h
  --------------------------------------
  Date                 : February 2021
  Copyright            : (C) 2021 by Damiano Lombardi
  Email                : damiano at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
 
#ifndef QGSSETTINGSREGISTRY_H
#define QGSSETTINGSREGISTRY_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QMap>
 
class QgsSettingsEntryBase;
class QgsSettingsEntryGroup;

class CORE_DEPRECATED_EXPORT QgsSettingsRegistry
{
  public:
 
    QgsSettingsRegistry();
    virtual ~QgsSettingsRegistry();

    QList<const QgsSettingsEntryBase *> settingEntries() const;

    const QgsSettingsEntryBase *settingsEntry( const QString &key, bool searchChildRegistries = true ) const;

    void addSubRegistry( const QgsSettingsRegistry *settingsRegistry );

    void removeSubRegistry( const QgsSettingsRegistry *settingsRegistry );

    QList<const QgsSettingsRegistry *> subRegistries() const;
 
  protected:

    bool addSettingsEntry( const QgsSettingsEntryBase *settingsEntry );

    Q_DECL_DEPRECATED void addSettingsEntryGroup( const QgsSettingsEntryGroup *settingsGroup ) SIP_DEPRECATED;
 
  private:
 
    QMap<QString, const QgsSettingsEntryBase *> mSettingsEntriesMap;
 
    Q_NOWARN_DEPRECATED_PUSH
    QMap<const QgsSettingsEntryBase *, const QgsSettingsEntryGroup *> mSettingsEntriesGroupMap;
    Q_NOWARN_DEPRECATED_POP
 
    QList<const QgsSettingsRegistry *> mSettingsRegistryChildList;
 
    friend class QgsSettingsEntryBase;
 
};
 
#endif // QGSSETTINGSREGISTRY_H