-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsproperty.sip
142 lines (99 loc) · 3.66 KB
/
qgsproperty.sip
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
class QgsPropertyDefinition
{
%TypeHeaderCode
#include <qgsproperty.h>
%End
public:
enum StandardPropertyTemplate
{
Boolean,
Integer,
IntegerPositive,
IntegerPositiveGreaterZero,
Double,
DoublePositive,
Double0To1,
Rotation,
String,
Transparency,
RenderUnits,
ColorWithAlpha,
ColorNoAlpha,
PenJoinStyle,
BlendMode,
Point,
Size,
Size2D,
LineStyle,
StrokeWidth,
FillStyle,
CapStyle,
HorizontalAnchor,
VerticalAnchor,
SvgPath,
Offset,
Custom,
};
enum DataType
{
DataTypeString,
DataTypeNumeric,
DataTypeBoolean,
};
QgsPropertyDefinition();
QgsPropertyDefinition( const QString& name, const QString& description, StandardPropertyTemplate type );
QgsPropertyDefinition( const QString& name, DataType dataTypes, const QString& description, const QString& helpText );
QString name() const;
QString description() const;
QString helpText() const;
DataType dataType() const;
StandardPropertyTemplate standardTemplate() const;
bool supportsAssistant() const;
};
class QgsProperty
{
%TypeHeaderCode
#include <qgsproperty.h>
%End
public:
//! Property types
enum Type
{
InvalidProperty, //! Invalid (not set) property
StaticProperty, //!< Static property (QgsStaticProperty)
FieldBasedProperty, //!< Field based property (QgsFieldBasedProperty)
ExpressionBasedProperty, //!< Expression based property (QgsExpressionBasedProperty)
};
QgsProperty();
virtual ~QgsProperty();
static QgsProperty fromExpression( const QString& expression, bool isActive = true );
static QgsProperty fromField( const QString& fieldName, bool isActive = true );
static QgsProperty fromValue( const QVariant& value, bool isActive = true );
QgsProperty( const QgsProperty& other );
operator bool() const;
bool operator==( const QgsProperty& other ) const;
bool operator!=( const QgsProperty& other ) const;
Type propertyType() const;
bool isActive() const;
void setActive( bool active );
void setStaticValue( const QVariant& value );
QVariant staticValue() const;
void setField( const QString& field );
QString field() const;
void setExpressionString( const QString& expression );
QString expressionString() const;
virtual QString asExpression() const;
virtual bool prepare( const QgsExpressionContext& context = QgsExpressionContext() ) const;
virtual QSet< QString > referencedFields( const QgsExpressionContext& context = QgsExpressionContext() ) const;
QVariant value( const QgsExpressionContext& context, const QVariant& defaultValue = QVariant(), bool* ok /Out/ = nullptr ) const;
QString valueAsString( const QgsExpressionContext& context, const QString& defaultString = QString(), bool* ok /Out/ = nullptr ) const;
QColor valueAsColor( const QgsExpressionContext& context, const QColor& defaultColor = QColor(), bool* ok /Out/ = nullptr ) const;
double valueAsDouble( const QgsExpressionContext& context, double defaultValue = 0.0, bool* ok /Out/ = nullptr ) const;
int valueAsInt( const QgsExpressionContext& context, int defaultValue = 0, bool* ok /Out/ = nullptr ) const;
bool valueAsBool( const QgsExpressionContext& context, bool defaultValue = false, bool* ok /Out/ = nullptr ) const;
QVariant toVariant() const;
bool loadVariant( const QVariant &property );
void setTransformer( QgsPropertyTransformer* transformer /Transfer/ );
const QgsPropertyTransformer* transformer() const;
bool convertToTransformer();
};