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_core.h"
#include "qgis_sip.h"
#include "qgssettings.h"
 
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:
 
    enum class SettingsType : int
    {
      Variant, 
      String, 
      StringList, 
      Bool, 
      Integer, 
      Double, 
      EnumFlag, 
      Color 
    };
 
#ifndef SIP_RUN
 
    QgsSettingsEntryBase( const QString &key,
                          QgsSettings::Section section,
                          const QVariant &defaultValue = QVariant(),
                          const QString &description = QString() );
 
#endif
 
    QgsSettingsEntryBase( const QString &key,
                          const QString &pluginName,
                          const QVariant &defaultValue = QVariant(),
                          const QString &description = QString() );
 
    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;
 
    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;
 
    QgsSettings::Section section() const;
 
    virtual bool setVariantValue( const QVariant &value, const QString &dynamicKeyPart = QString() ) const;
 
    virtual bool setVariantValue( const QVariant &value, const QStringList &dynamicKeyPartList ) const;
 
    QVariant valueAsVariant( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, const QVariant &defaultValueOverride = QVariant() ) const;
 
    QVariant valueAsVariant( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, const QVariant &defaultValueOverride = QVariant() ) const;
 
    QVariant defaultValueAsVariant() const;
 
    virtual SettingsType settingsType() const = 0;
 
    QString description() const;
 
  private:
 
    QString mKey;
    QVariant mDefaultValue;
    QgsSettings::Section mSection;
    QString mDescription;
    QString mPluginName;
};
 
 
class CORE_EXPORT QgsSettingsEntryVariant : public QgsSettingsEntryBase
{
  public:
 
#ifndef SIP_RUN
 
    QgsSettingsEntryVariant( const QString &key,
                             QgsSettings::Section section,
                             const QVariant &defaultValue = QVariant(),
                             const QString &description = QString() );
 
#endif
 
    QgsSettingsEntryVariant( const QString &key,
                             const QString &pluginName,
                             const QVariant &defaultValue = QVariant(),
                             const QString &description = QString() );
 
    bool setValue( const QVariant &value, const QString &dynamicKeyPart = QString() ) const;
 
    bool setValue( const QVariant &value, const QStringList &dynamicKeyPartList ) const;
 
    QVariant value( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, const QVariant &defaultValueOverride = QVariant() ) const;
 
    QVariant value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, const QVariant &defaultValueOverride = QVariant() ) const;
 
    QVariant defaultValue() const;
 
    virtual SettingsType settingsType() const override;
};
 
 
class CORE_EXPORT QgsSettingsEntryString : public QgsSettingsEntryBase
{
  public:
 
#ifndef SIP_RUN
 
    QgsSettingsEntryString( const QString &key,
                            QgsSettings::Section section,
                            const QString &defaultValue = QString(),
                            const QString &description = QString(),
                            int minLength = 0,
                            int maxLength = -1 );
 
#endif
 
    QgsSettingsEntryString( const QString &key,
                            const QString &pluginName,
                            const QString &defaultValue = QString(),
                            const QString &description = QString() );
 
    bool setValue( const QString &value, const QString &dynamicKeyPart = QString() ) const;
 
    bool setValue( const QString &value, const QStringList &dynamicKeyPartList ) const;
 
    QString value( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, const QString &defaultValueOverride = QString() ) const;
 
    QString value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, const QString &defaultValueOverride = QString() ) const;
 
    QString defaultValue() const;
 
    virtual SettingsType settingsType() const override;
 
    void setMinLength( int minLength );
 
    int minLength();
 
    void setMaxLength( int maxLength );
 
    int maxLength();
 
  private:
 
    int mMinLength;
    int mMaxLength;
 
};
 
 
class CORE_EXPORT QgsSettingsEntryStringList : public QgsSettingsEntryBase
{
  public:
 
#ifndef SIP_RUN
 
    QgsSettingsEntryStringList( const QString &key,
                                QgsSettings::Section section,
                                const QStringList &defaultValue = QStringList(),
                                const QString &description = QString() );
 
#endif
 
    QgsSettingsEntryStringList( const QString &key,
                                const QString &pluginName,
                                const QStringList &defaultValue = QStringList(),
                                const QString &description = QString() );
 
    bool setValue( const QStringList &value, const QString &dynamicKeyPart = QString() ) const;
 
    bool setValue( const QStringList &value, const QStringList &dynamicKeyPartList ) const;
 
    QStringList value( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, const QStringList &defaultValueOverride = QStringList() ) const;
 
    QStringList value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, const QStringList &defaultValueOverride = QStringList() ) const;
 
    QStringList defaultValue() const;
 
    virtual SettingsType settingsType() const override;
 
};
 
 
class CORE_EXPORT QgsSettingsEntryBool : public QgsSettingsEntryBase
{
  public:
 
#ifndef SIP_RUN
 
    QgsSettingsEntryBool( const QString &key,
                          QgsSettings::Section section,
                          bool defaultValue = false,
                          const QString &description = QString() );
 
#endif
 
    QgsSettingsEntryBool( const QString &key,
                          const QString &pluginName,
                          bool defaultValue = false,
                          const QString &description = QString() );
 
    bool setValue( bool value, const QString &dynamicKeyPart = QString() ) const;
 
    bool setValue( bool value, const QStringList &dynamicKeyPartList ) const;
 
    bool value( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, bool defaultValueOverride = false ) const;
 
    bool value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, bool defaultValueOverride = false ) const;
 
    bool defaultValue() const;
 
    virtual SettingsType settingsType() const override;
};
 
 
class CORE_EXPORT QgsSettingsEntryInteger : public QgsSettingsEntryBase
{
  public:
 
 
#ifndef SIP_RUN
 
    QgsSettingsEntryInteger( const QString &key,
                             QgsSettings::Section section,
                             qlonglong defaultValue = 0,
                             const QString &description = QString(),
                             qlonglong minValue = std::numeric_limits<qlonglong>::min(),
                             qlonglong maxValue = std::numeric_limits<qlonglong>::max() );
 
#endif
 
    QgsSettingsEntryInteger( const QString &key,
                             const QString &pluginName,
                             qlonglong defaultValue = 0,
                             const QString &description = QString() );
 
    bool setValue( qlonglong value, const QString &dynamicKeyPart = QString() ) const;
 
    bool setValue( qlonglong value, const QStringList &dynamicKeyPartList ) const;
 
    qlonglong value( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, qlonglong defaultValueOverride = 0 ) const;
 
    qlonglong value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, qlonglong defaultValueOverride = 0 ) const;
 
    qlonglong defaultValue() const;
 
    virtual SettingsType settingsType() const override;
 
    void setMinValue( qlonglong minValue );
 
    qlonglong minValue();
 
    void setMaxValue( qlonglong maxValue );
 
    qlonglong maxValue();
 
  private:
 
    qlonglong mMinValue;
    qlonglong mMaxValue;
 
};
 
 
class CORE_EXPORT QgsSettingsEntryDouble : public QgsSettingsEntryBase
{
  public:
 
#ifndef SIP_RUN
 
    QgsSettingsEntryDouble( const QString &key,
                            QgsSettings::Section section,
                            double defaultValue = 0.0,
                            const QString &description = QString(),
                            double minValue = std::numeric_limits<double>::lowest(),
                            double maxValue = std::numeric_limits<double>::max(),
                            int displayDecimals = 1 );
 
#endif
 
    QgsSettingsEntryDouble( const QString &key,
                            const QString &pluginName,
                            double defaultValue,
                            const QString &description = QString() );
 
    bool setValue( double value, const QString &dynamicKeyPart = QString() ) const;
 
    bool setValue( double value, const QStringList &dynamicKeyPartList ) const;
 
    double value( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, double defaultValueOverride = 0.0 ) const;
 
    double value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, double defaultValueOverride = 0.0 ) const;
 
    double defaultValue() const;
 
    virtual SettingsType settingsType() const override;
 
    void setMinValue( double minValue );
 
    double minValue() const;
 
    void setMaxValue( double maxValue );
 
    double maxValue() const;
 
    void setDisplayHintDecimals( int displayHintDecimals );
 
    int displayHintDecimals() const;
 
  private:
 
    double mMinValue;
    double mMaxValue;
 
    int mDisplayHintDecimals;
 
};
 
 
template <typename T>
class CORE_EXPORT QgsSettingsEntryEnumFlag : public QgsSettingsEntryBase
{
  public:
 
    QgsSettingsEntryEnumFlag( const QString &key, QgsSettings::Section section, const T &defaultValue, const QString &description = QString() )
      : QgsSettingsEntryBase( key, section, QMetaEnum::fromType<T>().isFlag() ? QVariant( QMetaEnum::fromType<T>().valueToKeys( static_cast <int >( defaultValue ) ) ) : QVariant( QMetaEnum::fromType<T>().valueToKey( static_cast< int >( defaultValue ) ) ), description )
    {
      mMetaEnum = QMetaEnum::fromType<T>();
      Q_ASSERT( mMetaEnum.isValid() );
      if ( !mMetaEnum.isValid() )
        QgsDebugMsg( QStringLiteral( "Invalid metaenum. Enum/Flag probably misses Q_ENUM/Q_FLAG declaration. Settings key: '%1'" ).arg( QgsSettingsEntryBase::key() ) );
    }
 
    T value( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, const T &defaultValueOverride = T() ) const
    {
      QStringList dynamicKeyPartList;
      if ( !dynamicKeyPart.isEmpty() )
        dynamicKeyPartList.append( dynamicKeyPart );
 
      return value( dynamicKeyPartList, useDefaultValueOverride, defaultValueOverride );
    }
 
    T value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, const T &defaultValueOverride = T() ) const
    {
      T defaultVal = defaultValue();
      if ( useDefaultValueOverride )
        defaultVal = defaultValueOverride;
 
      if ( !mMetaEnum.isFlag() )
        return QgsSettings().enumValue( key( dynamicKeyPartList ),
                                        defaultVal,
                                        section() );
      else
        return QgsSettings().flagValue( key( dynamicKeyPartList ),
                                        defaultVal,
                                        section() );
    }
 
    T defaultValue() const
    {
      if ( !mMetaEnum.isValid() )
      {
        QgsDebugMsg( QStringLiteral( "Invalid metaenum. Enum/Flag probably misses Q_ENUM/Q_FLAG declaration. Settings key: '%1'" ).arg( key() ) );
        return T();
      }
 
      bool ok = false;
      T defaultValue;
      if ( !mMetaEnum.isFlag() )
        defaultValue = static_cast<T>( mMetaEnum.keyToValue( defaultValueAsVariant().toByteArray(), &ok ) );
      else
        defaultValue = static_cast<T>( mMetaEnum.keysToValue( defaultValueAsVariant().toByteArray(), &ok ) );
 
      if ( !ok )
      {
        QgsDebugMsg( QStringLiteral( "Invalid enum/flag key/s '%1' for settings key '%2'" ).arg( defaultValueAsVariant().toString(), key() ) );
        return T();
      }
 
      return defaultValue;
    }
 
    bool setValue( const T &value, const QString &dynamicKeyPart = QString() ) const
    {
      QStringList dynamicKeyPartList;
      if ( !dynamicKeyPart.isEmpty() )
        dynamicKeyPartList.append( dynamicKeyPart );
 
      return setValue( value, dynamicKeyPartList );
    }
 
    bool setValue( const T &value, const QStringList &dynamicKeyPartList ) const
    {
      if ( !mMetaEnum.isValid() )
      {
        QgsDebugMsg( QStringLiteral( "Invalid metaenum. Enum/Flag probably misses Q_ENUM/Q_FLAG declaration. Settings key: '%1'" ).arg( key( dynamicKeyPartList ) ) );
        return false;
      }
 
      if ( !mMetaEnum.isFlag() )
      {
        const char *enumKey = mMetaEnum.valueToKey( static_cast< int >( value ) );
        if ( enumKey == nullptr )
        {
          QgsDebugMsg( QStringLiteral( "Invalid enum value '%1'." ).arg( static_cast< int >( value ) ) );
          return false;
        }
 
        return QgsSettingsEntryBase::setVariantValue( enumKey, dynamicKeyPartList );
      }
      else
      {
        const QByteArray flagKeys = mMetaEnum.valueToKeys( static_cast< int >( value ) );
        if ( flagKeys.isEmpty() )
        {
          QgsDebugMsg( QStringLiteral( "Invalid flag value '%1'." ).arg( static_cast< int >( value ) ) );
          return false;
        }
        return QgsSettingsEntryBase::setVariantValue( flagKeys, dynamicKeyPartList );
      }
    }
 
    virtual QgsSettingsEntryBase::SettingsType settingsType() const override
    {
      return QgsSettingsEntryBase::SettingsType::EnumFlag;
    }
 
  private:
 
    QMetaEnum mMetaEnum;
 
};
 
 
class CORE_EXPORT QgsSettingsEntryColor : public QgsSettingsEntryBase
{
  public:
 
#ifndef SIP_RUN
 
    QgsSettingsEntryColor( const QString &key,
                           QgsSettings::Section section,
                           const QColor &defaultValue = QColor(),
                           const QString &description = QString() );
 
#endif
 
    QgsSettingsEntryColor( const QString &key,
                           const QString &pluginName,
                           const QColor &defaultValue = QColor(),
                           const QString &description = QString() );
 
    bool setValue( const QColor &value, const QString &dynamicKeyPart = QString() ) const;
 
    bool setValue( const QColor &value, const QStringList &dynamicKeyPartList ) const;
 
    QColor value( const QString &dynamicKeyPart = QString(), bool useDefaultValueOverride = false, const QString &defaultValueOverride = QString() ) const;
 
    QColor value( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride = false, const QString &defaultValueOverride = QString() ) const;
 
    QColor defaultValue() const;
 
    virtual SettingsType settingsType() const override;
 
};
 
#endif // QGSSETTINGSENTRY_H