qgssettingsentrygroup.h

Go to the documentation of this file.

/***************************************************************************
  qgssettingsentrygroup.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 QGSSETTINGSENTRYGROUP_H
#define QGSSETTINGSENTRYGROUP_H
 
#include <limits>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QColor>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsSettingsEntryBase;
 

class CORE_DEPRECATED_EXPORT QgsSettingsEntryGroup SIP_DEPRECATED
{
  public:
    QgsSettingsEntryGroup( QList<const QgsSettingsEntryBase *> settings );
#ifdef SIP_RUN
    // clang-format off
    % MethodCode
    sipCpp = new QgsSettingsEntryGroup( *a0, false );
    sipIsErr = sipCpp->isValid() ? 0 : 1;
    if ( sipIsErr )
      PyErr_SetString( PyExc_ValueError, u"Settings do not share the same base definition key for this group. This will lead to unpredictable results."_s.toUtf8().constData() );
    % End
// clang-format on
#endif

      QgsSettingsEntryGroup( QList<const QgsSettingsEntryBase *> settings, bool fatalErrorIfInvalid ) SIP_SKIP;

    bool isValid() const { return mIsValid; }

    QString baseKey( const QStringList &dynamicKeyPartList = QStringList() ) const;

    const QList<const QgsSettingsEntryBase *> settings() const { return mSettings; }

    void removeAllSettingsAtBaseKey( const QStringList &dynamicKeyPartList = QStringList() ) const;

    void removeAllChildrenSettings( const QString &dynamicKeyPart = QString() ) const;

    void removeAllChildrenSettings( const QStringList &dynamicKeyPartList ) const;
 
  private:
    bool hasDynamicKey() const;
 
    QList<const QgsSettingsEntryBase *> mSettings;
    QString mDefinitionBaseKey;
    bool mIsValid = true;
};
 
 
#endif // QGSSETTINGSENTRYGROUP_H