qgssettingsentry.h

Go to the documentation of this file.

/***************************************************************************
  qgssettingsentry.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 QGSSETTINGSENTRY_H
#define QGSSETTINGSENTRY_H
 
#include <QString>
#include <QColor>
#include <limits>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgssettings.h"
 
class QgsSettingsEntryBase;
 
 
class CORE_EXPORT QgsSettingsEntryGroup
{
  public:
    QgsSettingsEntryGroup( const QList<const QgsSettingsEntryBase *> settings )
      : QgsSettingsEntryGroup( settings, true )
    {}
#ifdef SIP_RUN
    % MethodCode
    sipCpp = new QgsSettingsEntryGroup( *a0, false );
    sipIsErr = sipCpp->isValid() ? 0 : 1;
    if ( sipIsErr )
      PyErr_SetString( PyExc_ValueError, QStringLiteral( "Settings do not share the same base definition key for this group. This will lead to unpredictable results." ).toUtf8().constData() );
    % End
#endif
 
    QgsSettingsEntryGroup( const 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;
};
 
class CORE_EXPORT QgsSettingsEntryBase
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast< QgsSettingsEntryVariant * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryVariant;
    else if ( dynamic_cast< QgsSettingsEntryString * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryString;
    else if ( dynamic_cast< QgsSettingsEntryStringList * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryStringList;
    else if ( dynamic_cast< QgsSettingsEntryBool * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryBool;
    else if ( dynamic_cast< QgsSettingsEntryInteger * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryInteger;
    else if ( dynamic_cast< QgsSettingsEntryDouble * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryDouble;
    else if ( dynamic_cast< QgsSettingsEntryColor * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryColor;
    else
      sipType = NULL;
    SIP_END
#endif
 
  public:
 
    static QStringList dynamicKeyPartToList( const QString &dynamicKeyPart );
 
 
    QgsSettingsEntryBase( const QString &key,
                          const QString &section,
                          const QVariant &defaultValue = QVariant(),
                          const QString &description = QString(),
                          Qgis::SettingsOptions options = Qgis::SettingsOptions() )
      : mKey( QStringLiteral( "%1/%2" ).arg( section, key ) )
      , mDefaultValue( defaultValue )
      , mDescription( description )
      , mPluginName()
      , mOptions( options )
    {}
 
    virtual ~QgsSettingsEntryBase() {}
 
    QString key( const QString &dynamicKeyPart = QString() ) const;
 
    QString key( const QStringList &dynamicKeyPartList ) const;
 
    bool keyIsValid( const QString &key ) const;
 
    QString definitionKey() const;
 
    bool hasDynamicKey() const;
 
    Qgis::SettingsOptions options() const {return mOptions;}
 
    bool exists( const QString &dynamicKeyPart = QString() ) const;
 
    bool exists( const QStringList &dynamicKeyPartList ) const;
 
    void remove( const QString &dynamicKeyPart = QString() ) const;
 
    void remove( const QStringList &dynamicKeyPartList ) const;
 
    Q_DECL_DEPRECATED QgsSettings::Section section() const {return QgsSettings::NoSection;}
 
    Q_DECL_DEPRECATED virtual bool setVariantValue( const QVariant &value, const QString &dynamicKeyPart = QString() ) const SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED virtual bool setVariantValue( const QVariant &value, const QStringList &dynamicKeyPartList ) const SIP_DEPRECATED;
 
    QVariant valueAsVariant( const QString &dynamicKeyPart = QString() ) const;
 
    QVariant valueAsVariant( const QStringList &dynamicKeyPartList ) const;
 
    QVariant valueAsVariantWithDefaultOverride( const QVariant &defaultValueOverride, const QString &dynamicKeyPart = QString() ) const;
 
    QVariant valueAsVariantWithDefaultOverride( const QVariant &defaultValueOverride, const QStringList &dynamicKeyPartList ) const;
 
    Q_DECL_DEPRECATED QVariant valueAsVariant( const QString &dynamicKeyPart, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED QVariant valueAsVariant( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const SIP_DEPRECATED;
 
 
    QVariant defaultValueAsVariant() const;
 
    virtual Qgis::SettingsType settingsType() const = 0;
 
    QString description() const;
 
    QVariant formerValueAsVariant( const QString &dynamicKeyPart ) const;
 
    QVariant formerValueAsVariant( const QStringList &dynamicKeyPartList ) const;
 
  protected:
 
    bool setVariantValuePrivate( const QVariant &value, const QStringList &dynamicKeyPartList = QStringList() ) const;
 
  private:
    QString formerValuekey( const QStringList &dynamicKeyPartList ) const;
 
    QString mKey;
    QVariant mDefaultValue;
    QString mDescription;
    QString mPluginName;
    Qgis::SettingsOptions mOptions;
};
 
 
template<class T>
class QgsSettingsEntryByReference : public QgsSettingsEntryBase
{
  public:
 
    QgsSettingsEntryByReference( const QString &key,
                                 const QString &section,
                                 const T &defaultValue,
                                 const QString &description = QString(),
                                 Qgis::SettingsOptions options = Qgis::SettingsOptions() )
      : QgsSettingsEntryBase( key, section, defaultValue, description, options )
    {}
 
 
    virtual Qgis::SettingsType settingsType() const override = 0;
 
    T value( const QString &dynamicKeyPart = QString() ) const { return this->convertFromVariant( valueAsVariant( dynamicKeyPart ) );}
 
    T value( const QStringList &dynamicKeyPartList )  const { return this->convertFromVariant( valueAsVariant( dynamicKeyPartList ) );}
 
    T valueWithDefaultOverride( const T &defaultValueOverride, const QString &dynamicKeyPart = QString() ) const { return this->convertFromVariant( valueAsVariantWithDefaultOverride( defaultValueOverride, dynamicKeyPart ) );}
    T valueWithDefaultOverride( const T &defaultValueOverride, const QStringList &dynamicKeyPartList ) const { return this->convertFromVariant( valueAsVariantWithDefaultOverride( defaultValueOverride, dynamicKeyPartList ) );}
 
    Q_DECL_DEPRECATED T value( const QString &dynamicKeyPart, bool useDefaultValueOverride, const T &defaultValueOverride ) const SIP_DEPRECATED
    {
      if ( useDefaultValueOverride )
        return this->convertFromVariant( valueAsVariantWithDefaultOverride( defaultValueOverride, dynamicKeyPart ) );
      else
        return this->convertFromVariant( valueAsVariant( dynamicKeyPart ) );
    }
 
    Q_DECL_DEPRECATED T value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const T &defaultValueOverride ) const SIP_DEPRECATED
    {
      if ( useDefaultValueOverride )
        return this->convertFromVariant( valueAsVariantWithDefaultOverride( defaultValueOverride, dynamicKeyPartList ) );
      else
        return this->convertFromVariant( valueAsVariant( dynamicKeyPartList ) );
    }
 
    bool setValue( const T &value, const QString &dynamicKeyPart = QString() ) const
    {
      return setValuePrivate( value, dynamicKeyPartToList( dynamicKeyPart ) );
    }
 
    bool setValue( const T &value, const QStringList &dynamicKeyPartList ) const
    {
      return setValuePrivate( value, dynamicKeyPartList );
    }
 
    T defaultValue() const {return convertFromVariant( defaultValueAsVariant() );}
 
    T formerValue( const QString &dynamicKeyPart = QString() ) const {return convertFromVariant( formerValueAsVariant( dynamicKeyPart ) );}
 
    T formerValue( const QStringList &dynamicKeyPartList ) const {return convertFromVariant( formerValueAsVariant( dynamicKeyPartList ) );}
 
  protected:
    bool setValuePrivate( const T &value, const QStringList &dynamicKeyPartList ) const
    {
      if ( checkValue( value ) )
        return QgsSettingsEntryBase::setVariantValuePrivate( convertToVariant( value ), dynamicKeyPartList );
      else
        return false;
    }
 
    virtual T convertFromVariant( const QVariant &value ) const = 0;
 
    virtual QVariant convertToVariant( const T &value ) const
    {
      return QVariant::fromValue( value );
    }
 
    virtual bool checkValue( const T &value ) const
    {
      Q_UNUSED( value )
      return true;
    }
};
 
 
template<class T>
class QgsSettingsEntryByValue : public QgsSettingsEntryBase
{
  public:
 
 
    QgsSettingsEntryByValue( const QString &key, const QString &section, QVariant defaultValue, const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions() )
      : QgsSettingsEntryBase( key, section, defaultValue, description, options )
    {}
 
    virtual Qgis::SettingsType settingsType() const override = 0;
 
    T value( const QString &dynamicKeyPart = QString() ) const { return this->convertFromVariant( valueAsVariant( dynamicKeyPart ) );}
 
    T value( const QStringList &dynamicKeyPartList )  const { return this->convertFromVariant( valueAsVariant( dynamicKeyPartList ) );}
 
    T valueWithDefaultOverride( T defaultValueOverride, const QString &dynamicKeyPart = QString() ) const { return this->convertFromVariant( valueAsVariantWithDefaultOverride( defaultValueOverride, dynamicKeyPart ) );}
    T valueWithDefaultOverride( T defaultValueOverride, const QStringList &dynamicKeyPartList ) const { return this->convertFromVariant( valueAsVariantWithDefaultOverride( defaultValueOverride, dynamicKeyPartList ) );}
 
    Q_DECL_DEPRECATED T value( const QString &dynamicKeyPart, bool useDefaultValueOverride, T defaultValueOverride ) const SIP_DEPRECATED
    {
      if ( useDefaultValueOverride )
        return this->convertFromVariant( valueAsVariantWithDefaultOverride( defaultValueOverride, dynamicKeyPart ) );
      else
        return this->convertFromVariant( valueAsVariant( dynamicKeyPart ) );
    }
 
    Q_DECL_DEPRECATED T value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, T defaultValueOverride ) const  SIP_DEPRECATED
    {
      if ( useDefaultValueOverride )
        return this->convertFromVariant( valueAsVariantWithDefaultOverride( defaultValueOverride, dynamicKeyPartList ) );
      else
        return this->convertFromVariant( valueAsVariant( dynamicKeyPartList ) );
    }
 
    bool setValue( T value, const QString &dynamicKeyPart = QString() ) const
    {
      return setValuePrivate( value, dynamicKeyPartToList( dynamicKeyPart ) );
    }
 
    bool setValue( T value, const QStringList &dynamicKeyPartList ) const
    {
      return setValuePrivate( value, dynamicKeyPartList );
    }
 
    T defaultValue() const {return convertFromVariant( defaultValueAsVariant() );}
 
    T formerValue( const QString &dynamicKeyPart = QString() ) const {return convertFromVariant( formerValueAsVariant( dynamicKeyPart ) );}
 
    T formerValue( const QStringList &dynamicKeyPartList ) const {return convertFromVariant( formerValueAsVariant( dynamicKeyPartList ) );}
 
  protected:
    virtual bool setValuePrivate( T value, const QStringList &dynamicKeyPartList ) const
    {
      if ( checkValue( value ) )
        return QgsSettingsEntryBase::setVariantValuePrivate( convertToVariant( value ), dynamicKeyPartList );
      else
        return false;
    }
 
    virtual T convertFromVariant( const QVariant &value ) const = 0;
 
    virtual QVariant convertToVariant( T value ) const
    {
      return QVariant::fromValue( value );
    }
 
    virtual bool checkValue( T value ) const
    {
      Q_UNUSED( value )
      return true;
    }
};
 
 
#endif // QGSSETTINGSENTRY_H