-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsoptionalexpression.h
87 lines (69 loc) · 2.52 KB
/
qgsoptionalexpression.h
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
/***************************************************************************
qgsoptionalexpression.h - QgsOptionalExpression
---------------------
begin : 8.9.2016
copyright : (C) 2016 by Matthias Kuhn
email : matthias@opengis.ch
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSOPTIONALEXPRESSION_H
#define QGSOPTIONALEXPRESSION_H
#include "qgsoptional.h"
#include "qgsexpression.h"
#include "qgis_core.h"
/**
* \ingroup core
*
* An expression with an additional enabled flag.
*
* This can be used for configuration options where an expression can be enabled
* or disabled but when disabled it shouldn't lose it's information for the case
* it gets re-enabled later on and a user shouldn't be force to redo the configuration.
*
* \since QGIS 2.18
*/
class CORE_EXPORT QgsOptionalExpression : public QgsOptional<QgsExpression>
{
public:
/**
* Construct a default optional expression.
* It will be disabled and with an empty expression.
*/
QgsOptionalExpression() = default;
/**
* Construct an optional expression with the provided expression.
* It will be enabled.
*/
QgsOptionalExpression( const QgsExpression &expression );
/**
* Construct an optional expression with the provided expression and enabled state.
*/
QgsOptionalExpression( const QgsExpression &expression, bool enabled );
/**
* Save the optional expression to the provided QDomElement.
*
* The caller is responsible to pass an empty QDomElement and to append it to
* a parent element.
*
* \since QGIS 2.18
*/
void writeXml( QDomElement &element );
/**
* Read the optional expression from the provided QDomElement.
*
* \since QGIS 2.18
*/
void readXml( const QDomElement &element );
};
#if defined(_MSC_VER)
#ifndef SIP_RUN
template class CORE_EXPORT QgsOptional<QgsExpression>;
#endif
#endif
#endif // QGSOPTIONALEXPRESSION_H