File: qgssettingsentryimpl.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (775 lines) | stat: -rw-r--r-- 29,628 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/settings/qgssettingsentryimpl.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




typedef QgsSettingsEntryBaseTemplate<QVariant> QgsSettingsEntryBaseTemplateQVariantBase;

class QgsSettingsEntryVariant : QgsSettingsEntryBaseTemplateQVariantBase
{
%Docstring(signature="appended")
A variant settings entry.

.. versionadded:: 3.20
%End

%TypeHeaderCode
#include "qgssettingsentryimpl.h"
#include "qgssettingsentry.h"
typedef QgsSettingsEntryBaseTemplate<QVariant> QgsSettingsEntryBaseTemplateQVariantBase;
%End
  public:


    QgsSettingsEntryVariant( const QString &name,
                             QgsSettingsTreeNode *parent,
                             const QVariant &defaultValue = QVariant(),
                             const QString &description = QString(),
                             Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryVariant.

:param name: specifies the name of the setting.
:param parent: specifies the parent in the tree of settings.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.

.. versionadded:: 3.30
%End

  private:
    QgsSettingsEntryVariant( const QString &key,
                             const QString &section,
                             const QVariant &defaultValue = QVariant(),
                             const QString &description = QString(),
                             Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryVariant.

:param key: specifies the final part of the settings key.
:param section: specifies the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.

.. versionadded:: 3.30
%End
  public:

    QgsSettingsEntryVariant( const QString &key,
                             const QString &pluginName,
                             const QVariant &defaultValue = QVariant(),
                             const QString &description = QString(),
                             Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryVariant. This constructor is intended to
be used from plugins.

:param key: specifies the key of the settings.
:param pluginName: is inserted in the key after the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
%MethodCode
    sipCpp = new sipQgsSettingsEntryVariant( QgsSettingsEntryVariant( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
%End



    SIP_PYOBJECT valueAs( SIP_PYOBJECT type ) const;
%Docstring
Returns settings value.

:param type: is the Python type of the value to be returned
%End
%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


    virtual Qgis::SettingsType settingsType() const;

    virtual QVariant convertFromVariant( const QVariant &value ) const;
};


typedef QgsSettingsEntryBaseTemplate<QString> QgsSettingsEntryBaseTemplateQStringBase;

class QgsSettingsEntryString : QgsSettingsEntryBaseTemplateQStringBase
{
%Docstring(signature="appended")
A string settings entry.

.. versionadded:: 3.20
%End

%TypeHeaderCode
#include "qgssettingsentryimpl.h"
#include "qgssettingsentry.h"
typedef QgsSettingsEntryBaseTemplate<QString> QgsSettingsEntryBaseTemplateQStringBase;
%End
  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 ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryString.

:param name: specifies the name of the setting.
:param parent: specifies the parent in the tree of settings.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param minLength: specifies the minimal length of the string value. 0
                  means no limit.
:param maxLength: specifies the maximal length of the string value. -1
                  means no limit.
%End

  private:
    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 ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryString.

:param key: specifies the final part of the settings key.
:param section: specifies the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param minLength: specifies the minimal length of the string value. 0
                  means no limit.
:param maxLength: specifies the maximal length of the string value. -1
                  means no limit.
%End
  public:

    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 ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryString. This constructor is intended to
be used from plugins.

:param key: specifies the key of the settings.
:param pluginName: is inserted in the key after the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
%MethodCode
    sipCpp = new sipQgsSettingsEntryString( QgsSettingsEntryString( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
%End

    virtual Qgis::SettingsType settingsType() const;

    int minLength() const;
%Docstring
Returns the string minimum length.
%End

    int maxLength() const;
%Docstring
Returns the string maximum length. By -1 there is no limitation.
%End

    virtual QString convertFromVariant( const QVariant &value ) const;


  private:
    virtual bool checkValuePrivate( const QString &value ) const;

};



typedef QgsSettingsEntryBaseTemplate<QStringList> QgsSettingsEntryBaseTemplateQStringListBase;

class QgsSettingsEntryStringList : QgsSettingsEntryBaseTemplateQStringListBase
{
%Docstring(signature="appended")
A string list settings entry.

.. versionadded:: 3.20
%End

%TypeHeaderCode
#include "qgssettingsentryimpl.h"
#include "qgssettingsentry.h"
typedef QgsSettingsEntryBaseTemplate<QStringList> QgsSettingsEntryBaseTemplateQStringListBase;
%End
  public:

    QgsSettingsEntryStringList( const QString &name,
                                QgsSettingsTreeNode *parent,
                                const QStringList &defaultValue = QStringList(),
                                const QString &description = QString(),
                                Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryStringList.

:param name: specifies the name of the setting.
:param parent: specifies the parent in the tree of settings.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End

  private:
    QgsSettingsEntryStringList( const QString &key,
                                const QString &section,
                                const QStringList &defaultValue = QStringList(),
                                const QString &description = QString(),
                                Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryStringList.

:param key: specifies the final part of the settings key.
:param section: specifies the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
  public:


    QgsSettingsEntryStringList( const QString &key,
                                const QString &pluginName,
                                const QStringList &defaultValue = QStringList(),
                                const QString &description = QString(),
                                Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryStringList. This constructor is intended
to be used from plugins.

:param key: specifies the key of the settings.
:param pluginName: is inserted in the key after the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
%MethodCode
    sipCpp = new sipQgsSettingsEntryStringList( QgsSettingsEntryStringList( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
%End

    virtual Qgis::SettingsType settingsType() const;

    virtual QStringList convertFromVariant( const QVariant &value ) const;

};



typedef QgsSettingsEntryBaseTemplate<bool> QgsSettingsEntryBaseTemplateboolBase;

class QgsSettingsEntryBool : QgsSettingsEntryBaseTemplateboolBase
{
%Docstring(signature="appended")
A boolean settings entry.

.. versionadded:: 3.20
%End

%TypeHeaderCode
#include "qgssettingsentryimpl.h"
#include "qgssettingsentry.h"
typedef QgsSettingsEntryBaseTemplate<bool> QgsSettingsEntryBaseTemplateboolBase;
%End
  public:

    QgsSettingsEntryBool( const QString &name,
                          QgsSettingsTreeNode *parent,
                          bool defaultValue = false,
                          const QString &description = QString(),
                          Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryBool.

:param name: specifies the name of the setting.
:param parent: specifies the parent in the tree of settings.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End

  private:
    QgsSettingsEntryBool( const QString &key,
                          const QString &section,
                          bool defaultValue = false,
                          const QString &description = QString(),
                          Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryBool.

:param key: specifies the final part of the settings key.
:param section: specifies the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
  public:

    QgsSettingsEntryBool( const QString &key,
                          const QString &pluginName,
                          bool defaultValue = false,
                          const QString &description = QString(),
                          Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryBool. This constructor is intended to be
used from plugins.

:param key: specifies the key of the settings.
:param pluginName: is inserted in the key after the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
%MethodCode
    sipCpp = new sipQgsSettingsEntryBool( QgsSettingsEntryBool( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4 ) );
%End


    virtual Qgis::SettingsType settingsType() const;

    virtual bool convertFromVariant( const QVariant &value ) const;

};



typedef QgsSettingsEntryBaseTemplate<int> QgsSettingsEntryBaseTemplateintBase;

class QgsSettingsEntryInteger : QgsSettingsEntryBaseTemplateintBase
{
%Docstring(signature="appended")
An integer settings entry.

.. versionadded:: 3.20
%End

%TypeHeaderCode
#include "qgssettingsentryimpl.h"
#include "qgssettingsentry.h"
typedef QgsSettingsEntryBaseTemplate<int> QgsSettingsEntryBaseTemplateintBase;
%End
  public:

    QgsSettingsEntryInteger( const QString &name,
                             QgsSettingsTreeNode *parent,
                             int defaultValue = 0,
                             const QString &description = QString(),
                             Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                             int minValue = INT_MIN,
                             int maxValue = INT_MAX ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryInteger.

:param name: specifies the name of the setting.
:param parent: specifies the parent in the tree of settings.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param minValue: specifies the minimal value.
:param maxValue: specifies the maximal value.
%End

  private:
    QgsSettingsEntryInteger( const QString &key,
                             const QString &section,
                             int defaultValue = 0,
                             const QString &description = QString(),
                             Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                             int minValue = INT_MIN,
                             int maxValue = INT_MAX ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryInteger.

:param key: specifies the final part of the settings key.
:param section: specifies the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param minValue: specifies the minimal value.
:param maxValue: specifies the maximal value.
%End
  public:

    QgsSettingsEntryInteger( const QString &key,
                             const QString &pluginName,
                             int defaultValue = 0,
                             const QString &description = QString(),
                             Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                             int minValue = INT_MIN,
                             int maxValue = INT_MAX ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryInteger. This constructor is intended to
be used from plugins.

:param key: specifies the key of the settings.
:param pluginName: is used to define the key of the setting
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param minValue: specifies the minimal value.
:param maxValue: specifies the maximal value.
%End
%MethodCode
    sipCpp = new sipQgsSettingsEntryInteger( QgsSettingsEntryInteger( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4, a5, a6 ) );
%End

    virtual Qgis::SettingsType settingsType() const;

    int minValue() const;
%Docstring
Returns the minimum value.
%End

    int maxValue() const;
%Docstring
Returns the maximum value.
%End

    virtual int convertFromVariant( const QVariant &value ) const;


  private:
    virtual bool checkValuePrivate( const int &value ) const;

};



typedef QgsSettingsEntryBaseTemplate<double> QgsSettingsEntryBaseTemplatedoubleBase;

class QgsSettingsEntryDouble : QgsSettingsEntryBaseTemplatedoubleBase
{
%Docstring(signature="appended")
A double settings entry.

.. versionadded:: 3.20
%End

%TypeHeaderCode
#include "qgssettingsentryimpl.h"
#include "qgssettingsentry.h"
typedef QgsSettingsEntryBaseTemplate<double> QgsSettingsEntryBaseTemplatedoubleBase;
%End
  public:

    QgsSettingsEntryDouble( const QString &name,
                            QgsSettingsTreeNode *parent,
                            double defaultValue = 0.0,
                            const QString &description = QString(),
                            Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                            double minValue = -DBL_MAX,
                            double maxValue = DBL_MAX,
                            int displayDecimals = 1 ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryDouble.

:param name: specifies the name of the setting.
:param parent: specifies the parent in the tree of settings.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param minValue: specifies the minimal value.
:param maxValue: specifies the maximal value.
:param displayDecimals: specifies a hint for the gui about how much
                        decimals to show for example for a
                        QDoubleSpinBox.
%End

  private:
    QgsSettingsEntryDouble( const QString &key,
                            const QString &section,
                            double defaultValue = 0.0,
                            const QString &description = QString(),
                            Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                            double minValue = -DBL_MAX,
                            double maxValue = DBL_MAX,
                            int displayDecimals = 1 ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryDouble.

:param key: specifies the final part of the settings key.
:param section: specifies the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param minValue: specifies the minimal value.
:param maxValue: specifies the maximal value.
:param displayDecimals: specifies a hint for the gui about how much
                        decimals to show for example for a
                        QDoubleSpinBox.
%End
  public:

    QgsSettingsEntryDouble( const QString &key,
                            const QString &pluginName,
                            double defaultValue,
                            const QString &description = QString(),
                            Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                            double minValue = -DBL_MAX,
                            double maxValue = DBL_MAX,
                            int displayDecimals = 1 ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryDouble. This constructor is intended to
be used from plugins.

:param key: specifies the key of the settings.
:param pluginName: is used to define the key of the setting
:param defaultValue: specifies the default value for the settings entry.
:param options: specifies the options for the settings entry.
:param description: specifies a description for the settings entry.
:param minValue: specifies the minimal value.
:param maxValue: specifies the maximal value.
:param displayDecimals: specifies a hint for the gui about how much
                        decimals to show
%End
%MethodCode
    sipCpp = new sipQgsSettingsEntryDouble( QgsSettingsEntryDouble( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), a2, *a3, *a4, a5, a6, a7 ) );
%End


    virtual Qgis::SettingsType settingsType() const;

    double minValue() const;
%Docstring
Returns the minimum value.
%End

    double maxValue() const;
%Docstring
Returns the maximum value.
%End

    void setDisplayHintDecimals( int displayHintDecimals );
%Docstring
Set the display hint decimals.

displayHintDecimals The number of decimals that should be shown in the
Gui.
%End

    int displayHintDecimals() const;
%Docstring
Returns how much decimals should be shown in the Gui.
%End

    virtual double convertFromVariant( const QVariant &value ) const;


  private:
    virtual bool checkValuePrivate( const double &value ) const;

};




typedef QgsSettingsEntryBaseTemplate<QColor> QgsSettingsEntryBaseTemplateQColorBase;

class QgsSettingsEntryColor : QgsSettingsEntryBaseTemplateQColorBase
{
%Docstring(signature="appended")
A color settings entry.

.. versionadded:: 3.20
%End

%TypeHeaderCode
#include "qgssettingsentryimpl.h"
#include "qgssettingsentry.h"
typedef QgsSettingsEntryBaseTemplate<QColor> QgsSettingsEntryBaseTemplateQColorBase;
%End
  public:

    QgsSettingsEntryColor( const QString &name,
                           QgsSettingsTreeNode *parent,
                           const QColor &defaultValue = QColor(),
                           const QString &description = QString(),
                           Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                           bool allowAlpha = true ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryColor.

:param name: specifies the name of the setting.
:param parent: specifies the parent in the tree of settings.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param allowAlpha: specifies if the color can have transparency.
%End

  private:
    QgsSettingsEntryColor( const QString &key,
                           const QString &section,
                           const QColor &defaultValue = QColor(),
                           const QString &description = QString(),
                           Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                           bool allowAlpha = true ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryColor.

:param key: specifies the final part of the settings key.
:param section: specifies the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
:param allowAlpha: specifies if the color can have transparency.
%End
  public:

    QgsSettingsEntryColor( const QString &key,
                           const QString &pluginName,
                           const QColor &defaultValue = QColor(),
                           const QString &description = QString(),
                           Qgis::SettingsOptions options = Qgis::SettingsOptions(),
                           bool allowAlpha = true ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryColor. This constructor is intended to
be used from plugins.

:param key: specifies the key of the settings.
:param pluginName: is inserted in the key after the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
%MethodCode
    sipCpp = new sipQgsSettingsEntryColor( QgsSettingsEntryColor( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4, a5 ) );
%End

    virtual Qgis::SettingsType settingsType() const;

    bool allowAlpha() const;
%Docstring
Returns ``True`` if transparency is allowed for the color

.. versionadded:: 3.30
%End



    virtual QColor convertFromVariant( const QVariant &value ) const;


  private:
    virtual bool checkValuePrivate( const QColor &value ) const;

};


typedef QgsSettingsEntryBaseTemplate<QVariantMap> QgsSettingsEntryBaseTemplateQVariantMapBase;

class QgsSettingsEntryVariantMap : QgsSettingsEntryBaseTemplateQVariantMapBase
{
%Docstring(signature="appended")
A string list settings entry.

.. versionadded:: 3.30
%End

%TypeHeaderCode
#include "qgssettingsentryimpl.h"
#include "qgssettingsentry.h"
typedef QgsSettingsEntryBaseTemplate<QVariantMap> QgsSettingsEntryBaseTemplateQVariantMapBase;
%End
  public:


    QgsSettingsEntryVariantMap( const QString &name,
                                QgsSettingsTreeNode *parent,
                                const QVariantMap &defaultValue = QVariantMap(),
                                const QString &description = QString(),
                                Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryVariantMap.

:param name: specifies the name of the setting.
:param parent: specifies the parent in the tree of settings.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End

  private:
    QgsSettingsEntryVariantMap( const QString &key,
                                const QString &section,
                                const QVariantMap &defaultValue = QVariantMap(),
                                const QString &description = QString(),
                                Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for QgsSettingsEntryVariantMap.

:param key: specifies the final part of the settings key.
:param section: specifies the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
  public:

    QgsSettingsEntryVariantMap( const QString &key,
                                const QString &pluginName,
                                const QVariantMap &defaultValue = QVariantMap(),
                                const QString &description = QString(),
                                Qgis::SettingsOptions options = Qgis::SettingsOptions() ) throw( QgsSettingsException ) /Transfer/;
%Docstring
Constructor for :py:class:`QgsSettingsEntryStringMap`. This constructor
is intended to be used from plugins.

:param key: specifies the key of the settings.
:param pluginName: is inserted in the key after the section.
:param defaultValue: specifies the default value for the settings entry.
:param description: specifies a description for the settings entry.
:param options: specifies the options for the settings entry.
%End
%MethodCode
    sipCpp = new sipQgsSettingsEntryVariantMap( QgsSettingsEntryVariantMap( *a0, QgsSettingsTree::createPluginTreeNode( *a1 ), *a2, *a3, *a4 ) );
%End

    virtual Qgis::SettingsType settingsType() const;

    virtual QVariantMap convertFromVariant( const QVariant &value ) const;

};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/settings/qgssettingsentryimpl.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/