QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
qgssettingsentryimpl.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssettingsentryimpl.h
3 --------------------------------------
4 Date : February 2022
5 Copyright : (C) 2022 by Denis Rouzaud
6 Email : [email protected]
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSSETTINGSENTRYIMPL_H
17#define QGSSETTINGSENTRYIMPL_H
18
19#include "qgssettingsentry.h"
20
21
29class CORE_EXPORT QgsSettingsEntryVariant : public QgsSettingsEntryByReference<QVariant>
30{
31 public:
32
33
44 QgsSettingsEntryVariant( const QString &name,
45 QgsSettingsTreeNode *parent,
46 const QVariant &defaultValue = QVariant(),
47 const QString &description = QString(),
48 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
49 : QgsSettingsEntryByReference( name, parent, defaultValue, description, options )
50 {}
51
62 QgsSettingsEntryVariant( const QString &key,
63 const QString &section,
64 const QVariant &defaultValue = QVariant(),
65 const QString &description = QString(),
66 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
67 : QgsSettingsEntryByReference( key, section, defaultValue, description, options )
68 {}
69
70#ifdef SIP_RUN
71
82 QgsSettingsEntryVariant( const QString &key,
83 const QString &pluginName,
84 const QVariant &defaultValue = QVariant(),
85 const QString &description = QString(),
86 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
87 % MethodCode
88 sipCpp = new sipQgsSettingsEntryVariant( QgsSettingsEntryVariant( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
89 % End
90#endif
91
92#ifdef SIP_RUN
93
100 SIP_PYOBJECT valueAs( SIP_PYOBJECT type ) const;
101 % MethodCode
102 typedef PyObject *( *pyqt5_from_qvariant_by_type )( QVariant &value, PyObject *type );
103 QVariant value;
104
105 value = sipCpp->value();
106
107 pyqt5_from_qvariant_by_type f = ( pyqt5_from_qvariant_by_type ) sipImportSymbol( "pyqt5_from_qvariant_by_type" );
108 sipRes = f( value, a0 );
109
110 sipIsErr = !sipRes;
111 % End
112#endif
113
114
115 virtual Qgis::SettingsType settingsType() const override;
116
117 private:
118 QVariant convertFromVariant( const QVariant &value ) const override SIP_FORCE {return value;}
119};
120
128class CORE_EXPORT QgsSettingsEntryString : public QgsSettingsEntryByReference<QString>
129{
130 public:
131
143 QgsSettingsEntryString( const QString &name,
144 QgsSettingsTreeNode *parent,
145 const QString &defaultValue = QString(),
146 const QString &description = QString(),
147 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
148 int minLength = 0,
149 int maxLength = -1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
150 : QgsSettingsEntryByReference<QString>( name, parent, defaultValue, description, options )
151 , mMinLength( minLength )
152 , mMaxLength( maxLength )
153 {}
154
166 QgsSettingsEntryString( const QString &key,
167 const QString &section,
168 const QString &defaultValue = QString(),
169 const QString &description = QString(),
170 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
171 int minLength = 0,
172 int maxLength = -1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
173 : QgsSettingsEntryByReference<QString>( key, section, defaultValue, description, options )
174 , mMinLength( minLength )
175 , mMaxLength( maxLength )
176 {}
177
178#ifdef SIP_RUN
179
190 QgsSettingsEntryString( const QString &key,
191 const QString &pluginName,
192 const QString &defaultValue = QString(),
193 const QString &description = QString(),
194 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
195 int minLength = 0,
196 int maxLength = -1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
197 % MethodCode
198 sipCpp = new sipQgsSettingsEntryString( QgsSettingsEntryString( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
199 % End
200#endif
201
202 virtual Qgis::SettingsType settingsType() const override;
203
207 int minLength() const;
208
212 int maxLength() const;
213
214 private:
215 bool checkValue( const QString &value ) const override SIP_FORCE;
216 QString convertFromVariant( const QVariant &value ) const override SIP_FORCE;
217
218 int mMinLength;
219 int mMaxLength;
220
221};
222
223
231class CORE_EXPORT QgsSettingsEntryStringList : public QgsSettingsEntryByReference<QStringList>
232{
233 public:
234
244 QgsSettingsEntryStringList( const QString &name,
245 QgsSettingsTreeNode *parent,
246 const QStringList &defaultValue = QStringList(),
247 const QString &description = QString(),
248 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
249 : QgsSettingsEntryByReference( name, parent, defaultValue, description, options )
250 {}
251
261 QgsSettingsEntryStringList( const QString &key,
262 const QString &section,
263 const QStringList &defaultValue = QStringList(),
264 const QString &description = QString(),
265 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
266 : QgsSettingsEntryByReference( key, section, defaultValue, description, options )
267 {}
268
269
270#ifdef SIP_RUN
271
282 QgsSettingsEntryStringList( const QString &key,
283 const QString &pluginName,
284 const QStringList &defaultValue = QStringList(),
285 const QString &description = QString(),
286 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
287 % MethodCode
288 sipCpp = new sipQgsSettingsEntryStringList( QgsSettingsEntryStringList( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
289 % End
290#endif
291
292 virtual Qgis::SettingsType settingsType() const override;
293
294 private:
295 QStringList convertFromVariant( const QVariant &value ) const override SIP_FORCE;
296
297};
298
299
307class CORE_EXPORT QgsSettingsEntryBool : public QgsSettingsEntryByValue<bool>
308{
309 public:
310
320 QgsSettingsEntryBool( const QString &name,
321 QgsSettingsTreeNode *parent,
322 bool defaultValue = false,
323 const QString &description = QString(),
324 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
325 : QgsSettingsEntryByValue( name, parent, defaultValue, description, options )
326 {}
327
337 QgsSettingsEntryBool( const QString &key,
338 const QString &section,
339 bool defaultValue = false,
340 const QString &description = QString(),
341 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
342 : QgsSettingsEntryByValue( key, section, defaultValue, description, options )
343 {}
344
345#ifdef SIP_RUN
346
357 QgsSettingsEntryBool( const QString &key,
358 const QString &pluginName,
359 bool defaultValue = false,
360 const QString &description = QString(),
361 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
362 % MethodCode
363 sipCpp = new sipQgsSettingsEntryBool( QgsSettingsEntryBool( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4 ) );
364 % End
365#endif
366
367
368 virtual Qgis::SettingsType settingsType() const override;
369
370 private:
371 bool convertFromVariant( const QVariant &value ) const override SIP_FORCE;
372};
373
374
382class CORE_EXPORT QgsSettingsEntryInteger : public QgsSettingsEntryByValue<int>
383{
384 public:
385
397 QgsSettingsEntryInteger( const QString &name,
398 QgsSettingsTreeNode *parent,
399 int defaultValue = 0,
400 const QString &description = QString(),
401 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
402 int minValue = std::numeric_limits<int>::min(),
403 int maxValue = std::numeric_limits<int>::max() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
404 : QgsSettingsEntryByValue( name, parent, defaultValue, description, options )
405 , mMinValue( minValue )
406 , mMaxValue( maxValue )
407 { }
408
420 QgsSettingsEntryInteger( const QString &key,
421 const QString &section,
422 int defaultValue = 0,
423 const QString &description = QString(),
424 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
425 int minValue = std::numeric_limits<int>::min(),
426 int maxValue = std::numeric_limits<int>::max() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
427 : QgsSettingsEntryByValue( key, section, defaultValue, description, options )
428 , mMinValue( minValue )
429 , mMaxValue( maxValue )
430 { }
431
432#ifdef SIP_RUN
433
446 QgsSettingsEntryInteger( const QString &key,
447 const QString &pluginName,
448 int defaultValue = 0,
449 const QString &description = QString(),
450 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
451 int minValue = std::numeric_limits<int>::min(),
452 int maxValue = std::numeric_limits<int>::max() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
453 % MethodCode
454 sipCpp = new sipQgsSettingsEntryInteger( QgsSettingsEntryInteger( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4, a5, a6 ) );
455 % End
456#endif
457
458 virtual Qgis::SettingsType settingsType() const override;
459
463 int minValue() const;
464
468 int maxValue() const;
469
470 private:
471 bool checkValue( int value ) const override SIP_FORCE;
472 int convertFromVariant( const QVariant &value ) const override SIP_FORCE;
473 int mMinValue;
474 int mMaxValue;
475};
476
477#ifndef SIP_RUN
478// not available in Python for now (no direct support of 64 bits integers in Python)
479
487class CORE_EXPORT QgsSettingsEntryInteger64 : public QgsSettingsEntryByValue<qlonglong>
488{
489 public:
490
502 QgsSettingsEntryInteger64( const QString &name,
503 QgsSettingsTreeNode *parent,
504 qlonglong defaultValue = 0,
505 const QString &description = QString(),
506 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
507 qlonglong minValue = std::numeric_limits<qlonglong>::min(),
508 qlonglong maxValue = std::numeric_limits<qlonglong>::max() ) SIP_THROW( QgsSettingsException )
509 : QgsSettingsEntryByValue( name, parent, defaultValue, description, options )
510 , mMinValue( minValue )
511 , mMaxValue( maxValue )
512 { }
513
525 QgsSettingsEntryInteger64( const QString &key,
526 const QString &section,
527 qlonglong defaultValue = 0,
528 const QString &description = QString(),
529 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
530 qlonglong minValue = std::numeric_limits<qlonglong>::min(),
531 qlonglong maxValue = std::numeric_limits<qlonglong>::max() )
532 : QgsSettingsEntryByValue( key, section, defaultValue, description, options )
533 , mMinValue( minValue )
534 , mMaxValue( maxValue )
535 { }
536
537 virtual Qgis::SettingsType settingsType() const override;
538
542 qlonglong minValue() const;
543
547 qlonglong maxValue() const;
548
549 private:
550 bool checkValue( qlonglong value ) const override;
551 qlonglong convertFromVariant( const QVariant &value ) const override;
552 qlonglong mMinValue;
553 qlonglong mMaxValue;
554};
555#endif
556
564class CORE_EXPORT QgsSettingsEntryDouble : public QgsSettingsEntryByValue<double>
565{
566 public:
567
581 QgsSettingsEntryDouble( const QString &name,
582 QgsSettingsTreeNode *parent,
583 double defaultValue = 0.0,
584 const QString &description = QString(),
585 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
586 double minValue = std::numeric_limits<double>::lowest(),
587 double maxValue = std::numeric_limits<double>::max(),
588 int displayDecimals = 1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
589 : QgsSettingsEntryByValue( name, parent, defaultValue, description, options )
590 , mMinValue( minValue )
591 , mMaxValue( maxValue )
592 , mDisplayHintDecimals( displayDecimals )
593 {}
594
608 QgsSettingsEntryDouble( const QString &key,
609 const QString &section,
610 double defaultValue = 0.0,
611 const QString &description = QString(),
612 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
613 double minValue = std::numeric_limits<double>::lowest(),
614 double maxValue = std::numeric_limits<double>::max(),
615 int displayDecimals = 1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
616 : QgsSettingsEntryByValue( key, section, defaultValue, description, options )
617 , mMinValue( minValue )
618 , mMaxValue( maxValue )
619 , mDisplayHintDecimals( displayDecimals )
620 {}
621
622#ifdef SIP_RUN
623
637 QgsSettingsEntryDouble( const QString &key,
638 const QString &pluginName,
639 double defaultValue,
640 const QString &description = QString(),
641 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
642 double minValue = std::numeric_limits<double>::lowest(),
643 double maxValue = std::numeric_limits<double>::max(),
644 int displayDecimals = 1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
645 % MethodCode
646 sipCpp = new sipQgsSettingsEntryDouble( QgsSettingsEntryDouble( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4, a5, a6, a7 ) );
647 % End
648#endif
649
650
651 virtual Qgis::SettingsType settingsType() const override;
652
656 double minValue() const;
657
661 double maxValue() const;
662
668 void setDisplayHintDecimals( int displayHintDecimals );
669
673 int displayHintDecimals() const;
674
675 private:
676 bool checkValue( double value ) const override SIP_FORCE;
677 double convertFromVariant( const QVariant &value ) const override SIP_FORCE;
678 double mMinValue;
679 double mMaxValue;
680
681 int mDisplayHintDecimals;
682
683};
684
685
686
694class CORE_EXPORT QgsSettingsEntryColor : public QgsSettingsEntryByReference<QColor>
695{
696 public:
697
708 QgsSettingsEntryColor( const QString &name,
709 QgsSettingsTreeNode *parent,
710 const QColor &defaultValue = QColor(),
711 const QString &description = QString(),
712 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
713 bool allowAlpha = true ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
714 : QgsSettingsEntryByReference( name, parent, defaultValue, description, options )
715 , mAllowAlpha( allowAlpha )
716 {}
717
728 QgsSettingsEntryColor( const QString &key,
729 const QString &section,
730 const QColor &defaultValue = QColor(),
731 const QString &description = QString(),
732 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
733 bool allowAlpha = true ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
734 : QgsSettingsEntryByReference( key, section, defaultValue, description, options )
735 , mAllowAlpha( allowAlpha )
736 {}
737
738#ifdef SIP_RUN
739
750 QgsSettingsEntryColor( const QString &key,
751 const QString &pluginName,
752 const QColor &defaultValue = QColor(),
753 const QString &description = QString(),
754 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
755 bool allowAlpha = true ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
756 % MethodCode
757 sipCpp = new sipQgsSettingsEntryColor( QgsSettingsEntryColor( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4, a5 ) );
758 % End
759#endif
760
761 virtual Qgis::SettingsType settingsType() const override;
762
767 bool allowAlpha() const {return mAllowAlpha;}
768
774 bool copyValueFromKeys( const QString &redKey, const QString &greenKey, const QString &blueKey, const QString &alphaKey = QString(), bool removeSettingAtKey = false ) const SIP_SKIP;
775
780 void copyValueToKeys( const QString &redKey, const QString &greenKey, const QString &blueKey, const QString &alphaKey = QString() ) const SIP_SKIP;
781
782
783 private:
784 QColor convertFromVariant( const QVariant &value ) const override SIP_FORCE;
785 bool checkValue( const QColor &value ) const override SIP_FORCE;
786 bool mAllowAlpha = true;
787};
788
796class CORE_EXPORT QgsSettingsEntryVariantMap : public QgsSettingsEntryByReference<QVariantMap>
797{
798 public:
799
800
810 QgsSettingsEntryVariantMap( const QString &name,
811 QgsSettingsTreeNode *parent,
812 const QVariantMap &defaultValue = QVariantMap(),
813 const QString &description = QString(),
814 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
815 : QgsSettingsEntryByReference( name, parent, defaultValue, description, options )
816 {
817 }
818
828 QgsSettingsEntryVariantMap( const QString &key,
829 const QString &section,
830 const QVariantMap &defaultValue = QVariantMap(),
831 const QString &description = QString(),
832 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
833 : QgsSettingsEntryByReference( key, section, defaultValue, description, options )
834 {
835 }
836
837#ifdef SIP_RUN
838
849 QgsSettingsEntryVariantMap( const QString &key,
850 const QString &pluginName,
851 const QVariantMap &defaultValue = QVariantMap(),
852 const QString &description = QString(),
853 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
854 % MethodCode
855 sipCpp = new sipQgsSettingsEntryVariantMap( QgsSettingsEntryVariantMap( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
856 % End
857#endif
858
859 virtual Qgis::SettingsType settingsType() const override;
860
861 private:
862 QVariantMap convertFromVariant( const QVariant &value ) const override SIP_FORCE;
863
864};
865
866#endif // QGSSETTINGSENTRYIMPL_H
Qgis::SettingsType
SettingsType
Types of settings entries.
Definition: qgis.h:345
QgsSettingsEntryBool
A boolean settings entry.
Definition: qgssettingsentryimpl.h:308
QgsSettingsEntryBool::QgsSettingsEntryBool
QgsSettingsEntryBool(const QString &key, const QString &section, bool defaultValue=false, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException) SIP_MAKE_PRIVATE
Constructor for QgsSettingsEntryBool.
Definition: qgssettingsentryimpl.h:337
QgsSettingsEntryBool::QgsSettingsEntryBool
QgsSettingsEntryBool(const QString &name, QgsSettingsTreeNode *parent, bool defaultValue=false, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException)
Constructor for QgsSettingsEntryBool.
Definition: qgssettingsentryimpl.h:320
QgsSettingsEntryByReference
Base abstract class for settings entry which are passed by reference.
Definition: qgssettingsentry.h:361
QgsSettingsEntryByReference::settingsType
virtual Qgis::SettingsType settingsType() const override=0
Returns the settings entry type.
QgsSettingsEntryByReference::convertFromVariant
virtual T convertFromVariant(const QVariant &value) const =0
Converts the variant value to the value type of the setting.
QgsSettingsEntryByReference::checkValue
virtual bool checkValue(const T &value) const
Check if the value is valid.
Definition: qgssettingsentry.h:512
QgsSettingsEntryByReference::value
T value(const QString &dynamicKeyPart=QString()) const
Returns settings value.
Definition: qgssettingsentry.h:409
QgsSettingsEntryByValue
Base abstract class for settings entry which are passed by value.
Definition: qgssettingsentry.h:532
QgsSettingsEntryColor
A color settings entry.
Definition: qgssettingsentryimpl.h:695
QgsSettingsEntryColor::allowAlpha
bool allowAlpha() const
Returns true if transparency is allowed for the color.
Definition: qgssettingsentryimpl.h:767
QgsSettingsEntryColor::QgsSettingsEntryColor
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_MAKE_PRIVATE
Constructor for QgsSettingsEntryColor.
Definition: qgssettingsentryimpl.h:728
QgsSettingsEntryColor::QgsSettingsEntryColor
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)
Constructor for QgsSettingsEntryColor.
Definition: qgssettingsentryimpl.h:708
QgsSettingsEntryDouble
A double settings entry.
Definition: qgssettingsentryimpl.h:565
QgsSettingsEntryDouble::QgsSettingsEntryDouble
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_MAKE_PRIVATE
Constructor for QgsSettingsEntryDouble.
Definition: qgssettingsentryimpl.h:608
QgsSettingsEntryDouble::QgsSettingsEntryDouble
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)
Constructor for QgsSettingsEntryDouble.
Definition: qgssettingsentryimpl.h:581
QgsSettingsEntryInteger64
A 64 bits integer (long long) settings entry.
Definition: qgssettingsentryimpl.h:488
QgsSettingsEntryInteger64::QgsSettingsEntryInteger64
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())
Constructor for QgsSettingsEntryInteger64.
Definition: qgssettingsentryimpl.h:525
QgsSettingsEntryInteger64::QgsSettingsEntryInteger64
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)
Constructor for QgsSettingsEntryInteger64.
Definition: qgssettingsentryimpl.h:502
QgsSettingsEntryInteger
An integer settings entry.
Definition: qgssettingsentryimpl.h:383
QgsSettingsEntryInteger::QgsSettingsEntryInteger
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)
Constructor for QgsSettingsEntryInteger.
Definition: qgssettingsentryimpl.h:397
QgsSettingsEntryInteger::QgsSettingsEntryInteger
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_MAKE_PRIVATE
Constructor for QgsSettingsEntryInteger.
Definition: qgssettingsentryimpl.h:420
QgsSettingsEntryStringList
A string list settings entry.
Definition: qgssettingsentryimpl.h:232
QgsSettingsEntryStringList::QgsSettingsEntryStringList
QgsSettingsEntryStringList(const QString &key, const QString &section, const QStringList &defaultValue=QStringList(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException) SIP_MAKE_PRIVATE
Constructor for QgsSettingsEntryStringList.
Definition: qgssettingsentryimpl.h:261
QgsSettingsEntryStringList::QgsSettingsEntryStringList
QgsSettingsEntryStringList(const QString &name, QgsSettingsTreeNode *parent, const QStringList &defaultValue=QStringList(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException)
Constructor for QgsSettingsEntryStringList.
Definition: qgssettingsentryimpl.h:244
QgsSettingsEntryString
A string settings entry.
Definition: qgssettingsentryimpl.h:129
QgsSettingsEntryString::QgsSettingsEntryString
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_MAKE_PRIVATE
Constructor for QgsSettingsEntryString.
Definition: qgssettingsentryimpl.h:166
QgsSettingsEntryString::QgsSettingsEntryString
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)
Constructor for QgsSettingsEntryString.
Definition: qgssettingsentryimpl.h:143
QgsSettingsEntryVariantMap
A string list settings entry.
Definition: qgssettingsentryimpl.h:797
QgsSettingsEntryVariantMap::QgsSettingsEntryVariantMap
QgsSettingsEntryVariantMap(const QString &key, const QString &section, const QVariantMap &defaultValue=QVariantMap(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException) SIP_MAKE_PRIVATE
Constructor for QgsSettingsEntryVariantMap.
Definition: qgssettingsentryimpl.h:828
QgsSettingsEntryVariantMap::QgsSettingsEntryVariantMap
QgsSettingsEntryVariantMap(const QString &name, QgsSettingsTreeNode *parent, const QVariantMap &defaultValue=QVariantMap(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException)
Constructor for QgsSettingsEntryVariantMap.
Definition: qgssettingsentryimpl.h:810
QgsSettingsEntryVariant
A variant settings entry.
Definition: qgssettingsentryimpl.h:30
QgsSettingsEntryVariant::QgsSettingsEntryVariant
QgsSettingsEntryVariant(const QString &key, const QString &section, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException) SIP_MAKE_PRIVATE
Constructor for QgsSettingsEntryVariant.
Definition: qgssettingsentryimpl.h:62
QgsSettingsEntryVariant::QgsSettingsEntryVariant
QgsSettingsEntryVariant(const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException)
Constructor for QgsSettingsEntryVariant.
Definition: qgssettingsentryimpl.h:44
QgsSettingsException
Custom exception class for settings related exceptions.
Definition: qgsexception.h:134
QgsSettingsTreeNode
QgsSettingsTreeNode is a tree node for the settings tree to help organizing and introspecting the tre...
Definition: qgssettingstreenode.h:45
QgsSettingsTree
QgsSettingsTree holds the tree structure for the settings in QGIS core.
Definition: qgssettingstree.h:31
SIP_FORCE
#define SIP_FORCE
Definition: qgis_sip.h:131
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
SIP_MAKE_PRIVATE
#define SIP_MAKE_PRIVATE
Definition: qgis_sip.h:136
SIP_TRANSFER
#define SIP_TRANSFER
Definition: qgis_sip.h:36
SIP_THROW
#define SIP_THROW(name,...)
Definition: qgis_sip.h:198
Generated on Sun Mar 5 2023 20:41:05 for QGIS API Documentation by doxygen 1.9.4