QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
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 QgsSettingsEntryBaseTemplate<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 : QgsSettingsEntryBaseTemplate( 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 : QgsSettingsEntryBaseTemplate( 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 QVariant convertFromVariant( const QVariant &value ) const override SIP_FORCE {return value;}
118};
119
127class CORE_EXPORT QgsSettingsEntryString : public QgsSettingsEntryBaseTemplate<QString>
128{
129 public:
130
142 QgsSettingsEntryString( const QString &name,
143 QgsSettingsTreeNode *parent,
144 const QString &defaultValue = QString(),
145 const QString &description = QString(),
146 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
147 int minLength = 0,
148 int maxLength = -1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
149 : QgsSettingsEntryBaseTemplate<QString>( name, parent, defaultValue, description, options )
150 , mMinLength( minLength )
151 , mMaxLength( maxLength )
152 {}
153
165 QgsSettingsEntryString( const QString &key,
166 const QString &section,
167 const QString &defaultValue = QString(),
168 const QString &description = QString(),
169 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
170 int minLength = 0,
171 int maxLength = -1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
172 : QgsSettingsEntryBaseTemplate<QString>( key, section, defaultValue, description, options )
173 , mMinLength( minLength )
174 , mMaxLength( maxLength )
175 {}
176
177#ifdef SIP_RUN
178
189 QgsSettingsEntryString( const QString &key,
190 const QString &pluginName,
191 const QString &defaultValue = QString(),
192 const QString &description = QString(),
193 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
194 int minLength = 0,
195 int maxLength = -1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
196 % MethodCode
197 sipCpp = new sipQgsSettingsEntryString( QgsSettingsEntryString( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
198 % End
199#endif
200
201 virtual Qgis::SettingsType settingsType() const override;
202
206 int minLength() const;
207
211 int maxLength() const;
212
213 QString convertFromVariant( const QVariant &value ) const override SIP_FORCE;
214
215 private:
216 bool checkValuePrivate( const QString &value ) const override SIP_FORCE;
217
218 int mMinLength;
219 int mMaxLength;
220
221};
222
223
231class CORE_EXPORT QgsSettingsEntryStringList : public QgsSettingsEntryBaseTemplate<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 : QgsSettingsEntryBaseTemplate( 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 : QgsSettingsEntryBaseTemplate( 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 QStringList convertFromVariant( const QVariant &value ) const override SIP_FORCE;
295};
296
297
305class CORE_EXPORT QgsSettingsEntryBool : public QgsSettingsEntryBaseTemplate<bool>
306{
307 public:
308
318 QgsSettingsEntryBool( const QString &name,
319 QgsSettingsTreeNode *parent,
320 bool defaultValue = false,
321 const QString &description = QString(),
322 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
323 : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
324 {}
325
335 QgsSettingsEntryBool( const QString &key,
336 const QString &section,
337 bool defaultValue = false,
338 const QString &description = QString(),
339 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
340 : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
341 {}
342
343#ifdef SIP_RUN
344
355 QgsSettingsEntryBool( const QString &key,
356 const QString &pluginName,
357 bool defaultValue = false,
358 const QString &description = QString(),
359 Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
360 % MethodCode
361 sipCpp = new sipQgsSettingsEntryBool( QgsSettingsEntryBool( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4 ) );
362 % End
363#endif
364
365
366 virtual Qgis::SettingsType settingsType() const override;
367
368 bool convertFromVariant( const QVariant &value ) const override SIP_FORCE;
369};
370
371
379class CORE_EXPORT QgsSettingsEntryInteger : public QgsSettingsEntryBaseTemplate<int>
380{
381 public:
382
394 QgsSettingsEntryInteger( const QString &name,
395 QgsSettingsTreeNode *parent,
396 int defaultValue = 0,
397 const QString &description = QString(),
398 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
399 int minValue = std::numeric_limits<int>::min(),
400 int maxValue = std::numeric_limits<int>::max() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
401 : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
402 , mMinValue( minValue )
403 , mMaxValue( maxValue )
404 { }
405
417 QgsSettingsEntryInteger( const QString &key,
418 const QString &section,
419 int defaultValue = 0,
420 const QString &description = QString(),
421 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
422 int minValue = std::numeric_limits<int>::min(),
423 int maxValue = std::numeric_limits<int>::max() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
424 : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
425 , mMinValue( minValue )
426 , mMaxValue( maxValue )
427 { }
428
429#ifdef SIP_RUN
430
443 QgsSettingsEntryInteger( const QString &key,
444 const QString &pluginName,
445 int defaultValue = 0,
446 const QString &description = QString(),
447 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
448 int minValue = std::numeric_limits<int>::min(),
449 int maxValue = std::numeric_limits<int>::max() ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
450 % MethodCode
451 sipCpp = new sipQgsSettingsEntryInteger( QgsSettingsEntryInteger( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4, a5, a6 ) );
452 % End
453#endif
454
455 virtual Qgis::SettingsType settingsType() const override;
456
460 int minValue() const;
461
465 int maxValue() const;
466
467 int convertFromVariant( const QVariant &value ) const override SIP_FORCE;
468
469 private:
470 bool checkValuePrivate( const int &value ) const override SIP_FORCE;
471 int mMinValue;
472 int mMaxValue;
473};
474
475#ifndef SIP_RUN
476// not available in Python for now (no direct support of 64 bits integers in Python)
477
485class CORE_EXPORT QgsSettingsEntryInteger64 : public QgsSettingsEntryBaseTemplate<qlonglong>
486{
487 public:
488
500 QgsSettingsEntryInteger64( const QString &name,
501 QgsSettingsTreeNode *parent,
502 qlonglong defaultValue = 0,
503 const QString &description = QString(),
504 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
505 qlonglong minValue = std::numeric_limits<qlonglong>::min(),
506 qlonglong maxValue = std::numeric_limits<qlonglong>::max() ) SIP_THROW( QgsSettingsException )
507 : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
508 , mMinValue( minValue )
509 , mMaxValue( maxValue )
510 { }
511
523 QgsSettingsEntryInteger64( const QString &key,
524 const QString &section,
525 qlonglong defaultValue = 0,
526 const QString &description = QString(),
527 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
528 qlonglong minValue = std::numeric_limits<qlonglong>::min(),
529 qlonglong maxValue = std::numeric_limits<qlonglong>::max() )
530 : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
531 , mMinValue( minValue )
532 , mMaxValue( maxValue )
533 { }
534
535 virtual Qgis::SettingsType settingsType() const override;
536
540 qlonglong minValue() const;
541
545 qlonglong maxValue() const;
546
547 qlonglong convertFromVariant( const QVariant &value ) const override;
548
549 private:
550 bool checkValuePrivate( const qlonglong &value ) const override;
551 qlonglong mMinValue;
552 qlonglong mMaxValue;
553};
554#endif
555
563class CORE_EXPORT QgsSettingsEntryDouble : public QgsSettingsEntryBaseTemplate<double>
564{
565 public:
566
580 QgsSettingsEntryDouble( const QString &name,
581 QgsSettingsTreeNode *parent,
582 double defaultValue = 0.0,
583 const QString &description = QString(),
584 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
585 double minValue = std::numeric_limits<double>::lowest(),
586 double maxValue = std::numeric_limits<double>::max(),
587 int displayDecimals = 1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER
588 : QgsSettingsEntryBaseTemplate( name, parent, defaultValue, description, options )
589 , mMinValue( minValue )
590 , mMaxValue( maxValue )
591 , mDisplayHintDecimals( displayDecimals )
592 {}
593
607 QgsSettingsEntryDouble( const QString &key,
608 const QString &section,
609 double defaultValue = 0.0,
610 const QString &description = QString(),
611 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
612 double minValue = std::numeric_limits<double>::lowest(),
613 double maxValue = std::numeric_limits<double>::max(),
614 int displayDecimals = 1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER SIP_MAKE_PRIVATE
615 : QgsSettingsEntryBaseTemplate( key, section, defaultValue, description, options )
616 , mMinValue( minValue )
617 , mMaxValue( maxValue )
618 , mDisplayHintDecimals( displayDecimals )
619 {}
620
621#ifdef SIP_RUN
622
636 QgsSettingsEntryDouble( const QString &key,
637 const QString &pluginName,
638 double defaultValue,
639 const QString &description = QString(),
640 Qgis::SettingsOptions options = Qgis::SettingsOptions(),
641 double minValue = std::numeric_limits<double>::lowest(),
642 double maxValue = std::numeric_limits<double>::max(),
643 int displayDecimals = 1 ) SIP_THROW( QgsSettingsException ) SIP_TRANSFER;
644 % MethodCode
645 sipCpp = new sipQgsSettingsEntryDouble( QgsSettingsEntryDouble( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4, a5, a6, a7 ) );
646 % End
647#endif
648
649
650 virtual Qgis::SettingsType settingsType() const override;
651
655 double minValue() const;
656
660 double maxValue() const;
661
667 void setDisplayHintDecimals( int displayHintDecimals );
668
672 int displayHintDecimals() const;
673
674 double convertFromVariant( const QVariant &value ) const override SIP_FORCE;
675
676 private:
677 bool checkValuePrivate( const double &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 QgsSettingsEntryBaseTemplate<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 : QgsSettingsEntryBaseTemplate( 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 : QgsSettingsEntryBaseTemplate( 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 QColor convertFromVariant( const QVariant &value ) const override SIP_FORCE;
783
784 private:
785 bool checkValuePrivate( const QColor &value ) const override SIP_FORCE;
786 bool mAllowAlpha = true;
787};
788
796class CORE_EXPORT QgsSettingsEntryVariantMap : public QgsSettingsEntryBaseTemplate<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 : QgsSettingsEntryBaseTemplate( 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 : QgsSettingsEntryBaseTemplate( 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 QVariantMap convertFromVariant( const QVariant &value ) const override SIP_FORCE;
862};
863
864
865#endif // QGSSETTINGSENTRYIMPL_H
Qgis::SettingsType
SettingsType
Types of settings entries.
Definition: qgis.h:365
QgsSettingsEntryBaseTemplate
Base abstract class for settings entries with typed get and set methods.
Definition: qgssettingsentry.h:365
QgsSettingsEntryBaseTemplate::convertFromVariant
virtual T convertFromVariant(const QVariant &value) const =0
Converts the variant value to the value type of the setting.
QgsSettingsEntryBaseTemplate::settingsType
virtual Qgis::SettingsType settingsType() const override=0
Returns the settings entry type.
QgsSettingsEntryBaseTemplate::value
T value(const QString &dynamicKeyPart=QString()) const
Returns settings value.
Definition: qgssettingsentry.h:413
QgsSettingsEntryBaseTemplate::checkValuePrivate
virtual bool checkValuePrivate(const T &value) const
Check if the value is valid.
Definition: qgssettingsentry.h:497
QgsSettingsEntryBool
A boolean settings entry.
Definition: qgssettingsentryimpl.h:306
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:335
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:318
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:564
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:607
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:580
QgsSettingsEntryInteger64
A 64 bits integer (long long) settings entry.
Definition: qgssettingsentryimpl.h:486
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:523
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:500
QgsSettingsEntryInteger
An integer settings entry.
Definition: qgssettingsentryimpl.h:380
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:394
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:417
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:128
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:165
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:142
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
QgsSettingsEntryVariant::convertFromVariant
QVariant convertFromVariant(const QVariant &value) const override SIP_FORCE
Converts the variant value to the value type of the setting.
Definition: qgssettingsentryimpl.h:117
QgsSettingsException
Custom exception class for settings related exceptions.
Definition: qgsexception.h:135
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 Jun 25 2023 11:54:04 for QGIS API Documentation by doxygen 1.9.4