qgssettingsentryimpl.h

Go to the documentation of this file.

/***************************************************************************
  qgssettingsentryimpl.h
  --------------------------------------
  Date                 : February 2022
  Copyright            : (C) 2022 by Denis Rouzaud
  Email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSSETTINGSENTRYIMPL_H
#define QGSSETTINGSENTRYIMPL_H
 
#include "qgssettingsentry.h"

class CORE_EXPORT QgsSettingsEntryVariant : public QgsSettingsEntryBaseTemplate<QVariant>
{
  public:
    QgsSettingsEntryVariant(
      const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue = QVariant(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
    {}

    QgsSettingsEntryVariant(
      const QString &key, const QString &section, const QVariant &defaultValue = QVariant(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
    {}
 
#ifdef SIP_RUN
    // clang-format off

    QgsSettingsEntryVariant( const QString &key,
                             const QString &pluginName,
                             const QVariant &defaultValue = QVariant(),
                             const QString &description = QString(),
                             Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
    % MethodCode
    sipCpp = new sipQgsSettingsEntryVariant( QgsSettingsEntryVariant( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
    % End
// clang-format on
#endif
 
#ifdef SIP_RUN
        // clang-format off

 
    SIP_PYOBJECT valueAs( SIP_PYOBJECT type ) const;
    % MethodCode
    typedef PyObject *( *pyqt_from_qvariant_by_type )( QVariant &value, PyObject *type );
    QVariant value;
 
    value = sipCpp->value();
 
    pyqt_from_qvariant_by_type f = ( pyqt_from_qvariant_by_type ) sipImportSymbol( SIP_PYQT_FROM_QVARIANT_BY_TYPE );
    sipRes = f( value, a0 );
 
    sipIsErr = !sipRes;
    % End
// clang-format on
#endif
 
 
        Qgis::SettingsType settingsType() const override;
 
    QVariant convertFromVariant( const QVariant &value ) const override SIP_FORCE { return value; }
};

class CORE_EXPORT QgsSettingsEntryString : public QgsSettingsEntryBaseTemplate<QString>
{
  public:
    QgsSettingsEntryString(
      const QString &name,
      QgsSettingsTreeNode *parent,
      const QString &defaultValue = QString(),
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      int minLength = 0,
      int maxLength = -1
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER : QgsSettingsEntryBaseTemplate<QString>( name, parent, defaultValue, description, options ),
                                                       mMinLength( minLength ),
                                                       mMaxLength( maxLength )
    {}

    QgsSettingsEntryString(
      const QString &key,
      const QString &section,
      const QString &defaultValue = QString(),
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      int minLength = 0,
      int maxLength = -1
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE : QgsSettingsEntryBaseTemplate<QString>( key, section, defaultValue, description, options ),
                                                                        mMinLength( minLength ),
                                                                        mMaxLength( maxLength )
    {}
 
#ifdef SIP_RUN
    // clang-format off

    QgsSettingsEntryString( const QString &key,
                            const QString &pluginName,
                            const QString &defaultValue = QString(),
                            const QString &description = QString(),
                            Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                            int minLength = 0,
                            int maxLength = -1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
    % MethodCode
    sipCpp = new sipQgsSettingsEntryString( QgsSettingsEntryString( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
    % End
// clang-format on
#endif
 
        Qgis::SettingsType settingsType() const override;

    int minLength() const;

    int maxLength() const;
 
    QString convertFromVariant( const QVariant &value ) const override SIP_FORCE;
 
  private:
    bool checkValuePrivate( const QString &value ) const override SIP_FORCE;
 
    int mMinLength;
    int mMaxLength;
};
 

class CORE_EXPORT QgsSettingsEntryStringList : public QgsSettingsEntryBaseTemplate<QStringList>
{
  public:
    QgsSettingsEntryStringList(
      const QString &name, QgsSettingsTreeNode *parent, const QStringList &defaultValue = QStringList(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
    {}

    QgsSettingsEntryStringList(
      const QString &key, const QString &section, const QStringList &defaultValue = QStringList(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
    {}
 
 
#ifdef SIP_RUN
    // clang-format off

    QgsSettingsEntryStringList( const QString &key,
                                const QString &pluginName,
                                const QStringList &defaultValue = QStringList(),
                                const QString &description = QString(),
                                Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
    % MethodCode
    sipCpp = new sipQgsSettingsEntryStringList( QgsSettingsEntryStringList( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
    % End
// clang-format on
#endif
 
        Qgis::SettingsType settingsType() const override;
 
    QStringList convertFromVariant( const QVariant &value ) const override SIP_FORCE;
};
 

class CORE_EXPORT QgsSettingsEntryBool : public QgsSettingsEntryBaseTemplate<bool>
{
  public:
    QgsSettingsEntryBool(
      const QString &name, QgsSettingsTreeNode *parent, bool defaultValue = false, const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
    {}

    QgsSettingsEntryBool(
      const QString &key, const QString &section, bool defaultValue = false, const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
    {}
 
#ifdef SIP_RUN
    // clang-format off

    QgsSettingsEntryBool( const QString &key,
                          const QString &pluginName,
                          bool defaultValue = false,
                          const QString &description = QString(),
                          Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
    % MethodCode
    sipCpp = new sipQgsSettingsEntryBool( QgsSettingsEntryBool( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4 ) );
    % End
// clang-format on
#endif
 
 
        Qgis::SettingsType settingsType() const override;
 
    bool convertFromVariant( const QVariant &value ) const override SIP_FORCE;
};
 

class CORE_EXPORT QgsSettingsEntryInteger : public QgsSettingsEntryBaseTemplate<int>
{
  public:
    QgsSettingsEntryInteger(
      const QString &name,
      QgsSettingsTreeNode *parent,
      int defaultValue = 0,
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      int minValue = std::numeric_limits<int>::min(),
      int maxValue = std::numeric_limits<int>::max()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options ),
                                                       mMinValue( minValue ),
                                                       mMaxValue( maxValue )
    {}

    QgsSettingsEntryInteger(
      const QString &key,
      const QString &section,
      int defaultValue = 0,
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      int minValue = std::numeric_limits<int>::min(),
      int maxValue = std::numeric_limits<int>::max()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options ),
                                                                        mMinValue( minValue ),
                                                                        mMaxValue( maxValue )
    {}
 
#ifdef SIP_RUN
    // clang-format off

    QgsSettingsEntryInteger( const QString &key,
                             const QString &pluginName,
                             int defaultValue = 0,
                             const QString &description = QString(),
                             Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                             int minValue = std::numeric_limits<int>::min(),
                             int maxValue = std::numeric_limits<int>::max() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
    % MethodCode
    sipCpp = new sipQgsSettingsEntryInteger( QgsSettingsEntryInteger( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4, a5, a6 ) );
    % End
// clang-format on
#endif
 
        Qgis::SettingsType settingsType() const override;

    int minValue() const;

    int maxValue() const;
 
    int convertFromVariant( const QVariant &value ) const override SIP_FORCE;
 
  private:
    bool checkValuePrivate( const int &value ) const override SIP_FORCE;
    int mMinValue;
    int mMaxValue;
};
 
#ifndef SIP_RUN
// not available in Python for now (no direct support of 64 bits integers in Python)

class CORE_EXPORT QgsSettingsEntryInteger64 : public QgsSettingsEntryBaseTemplate<qlonglong>
{
  public:
    QgsSettingsEntryInteger64(
      const QString &name,
      QgsSettingsTreeNode *parent,
      qlonglong defaultValue = 0,
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      qlonglong minValue = std::numeric_limits<qlonglong>::min(),
      qlonglong maxValue = std::numeric_limits<qlonglong>::max()
    ) SIP_THROW( QgsSettingsException )
      : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
      , mMinValue( minValue )
      , mMaxValue( maxValue )
    {}

    QgsSettingsEntryInteger64(
      const QString &key,
      const QString &section,
      qlonglong defaultValue = 0,
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      qlonglong minValue = std::numeric_limits<qlonglong>::min(),
      qlonglong maxValue = std::numeric_limits<qlonglong>::max()
    )
      : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
      , mMinValue( minValue )
      , mMaxValue( maxValue )
    {}
 
    Qgis::SettingsType settingsType() const override;

    qlonglong minValue() const;

    qlonglong maxValue() const;
 
    qlonglong convertFromVariant( const QVariant &value ) const override;
 
  private:
    bool checkValuePrivate( const qlonglong &value ) const override;
    qlonglong mMinValue;
    qlonglong mMaxValue;
};
#endif

class CORE_EXPORT QgsSettingsEntryDouble : public QgsSettingsEntryBaseTemplate<double>
{
  public:
    QgsSettingsEntryDouble(
      const QString &name,
      QgsSettingsTreeNode *parent,
      double defaultValue = 0.0,
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      double minValue = std::numeric_limits<double>::lowest(),
      double maxValue = std::numeric_limits<double>::max(),
      int displayDecimals = 1
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options ),
                                                       mMinValue( minValue ),
                                                       mMaxValue( maxValue ),
                                                       mDisplayHintDecimals( displayDecimals )
    {}

    QgsSettingsEntryDouble(
      const QString &key,
      const QString &section,
      double defaultValue = 0.0,
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      double minValue = std::numeric_limits<double>::lowest(),
      double maxValue = std::numeric_limits<double>::max(),
      int displayDecimals = 1
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options ),
                                                                        mMinValue( minValue ),
                                                                        mMaxValue( maxValue ),
                                                                        mDisplayHintDecimals( displayDecimals )
    {}
 
#ifdef SIP_RUN
    // clang-format off

    QgsSettingsEntryDouble( const QString &key,
                            const QString &pluginName,
                            double defaultValue,
                            const QString &description = QString(),
                            Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                            double minValue = std::numeric_limits<double>::lowest(),
                            double maxValue = std::numeric_limits<double>::max(),
                            int displayDecimals = 1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
    % MethodCode
    sipCpp = new sipQgsSettingsEntryDouble( QgsSettingsEntryDouble( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4, a5, a6, a7 ) );
    % End
// clang-format on
#endif
 
 
        Qgis::SettingsType settingsType() const override;

    double minValue() const;

    double maxValue() const;

    void setDisplayHintDecimals( int displayHintDecimals );

    int displayHintDecimals() const;
 
    double convertFromVariant( const QVariant &value ) const override SIP_FORCE;
 
  private:
    bool checkValuePrivate( const double &value ) const override SIP_FORCE;
    double mMinValue;
    double mMaxValue;
 
    int mDisplayHintDecimals;
};
 

class CORE_EXPORT QgsSettingsEntryColor : public QgsSettingsEntryBaseTemplate<QColor>
{
  public:
    QgsSettingsEntryColor(
      const QString &name,
      QgsSettingsTreeNode *parent,
      const QColor &defaultValue = QColor(),
      const QString &description = QString(),
      Qgis::SettingsOptions options = Qgis::SettingsOptions(),
      bool allowAlpha = true
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options ),
                                                       mAllowAlpha( allowAlpha )
    {}

    QgsSettingsEntryColor(
      const QString &key, const QString &section, const QColor &defaultValue = QColor(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions(), bool allowAlpha = true
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options ),
                                                                        mAllowAlpha( allowAlpha )
    {}
 
#ifdef SIP_RUN
    // clang-format off

    QgsSettingsEntryColor( const QString &key,
                           const QString &pluginName,
                           const QColor &defaultValue = QColor(),
                           const QString &description = QString(),
                           Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                           bool allowAlpha = true ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
    % MethodCode
    sipCpp = new sipQgsSettingsEntryColor( QgsSettingsEntryColor( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4, a5 ) );
    % End
// clang-format on
#endif
 
        Qgis::SettingsType settingsType() const override;

    bool allowAlpha() const { return mAllowAlpha; }

    bool copyValueFromKeys( const QString &redKey, const QString &greenKey, const QString &blueKey, const QString &alphaKey = QString(), bool removeSettingAtKey = false ) const SIP_SKIP;

    void copyValueToKeys( const QString &redKey, const QString &greenKey, const QString &blueKey, const QString &alphaKey = QString() ) const SIP_SKIP;
 
    QColor convertFromVariant( const QVariant &value ) const override SIP_FORCE;
 
  private:
    bool checkValuePrivate( const QColor &value ) const override SIP_FORCE;
    bool mAllowAlpha = true;
};

class CORE_EXPORT QgsSettingsEntryVariantMap : public QgsSettingsEntryBaseTemplate<QVariantMap>
{
  public:
    QgsSettingsEntryVariantMap(
      const QString &name, QgsSettingsTreeNode *parent, const QVariantMap &defaultValue = QVariantMap(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
    {}

    QgsSettingsEntryVariantMap(
      const QString &key, const QString &section, const QVariantMap &defaultValue = QVariantMap(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
    {}
 
#ifdef SIP_RUN
    // clang-format off

    QgsSettingsEntryVariantMap( const QString &key,
                                const QString &pluginName,
                                const QVariantMap &defaultValue = QVariantMap(),
                                const QString &description = QString(),
                                Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
    % MethodCode
    sipCpp = new sipQgsSettingsEntryVariantMap( QgsSettingsEntryVariantMap( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
    % End
// clang-format on
#endif
 
        Qgis::SettingsType settingsType() const override;
 
    QVariantMap convertFromVariant( const QVariant &value ) const override SIP_FORCE;
};
 
 
#endif // QGSSETTINGSENTRYIMPL_H