23#include <QRegularExpression>
26using namespace Qt::StringLiterals;
31 , mStandardType( type )
35 switch ( mStandardType )
39 mHelpText = QObject::tr(
"bool [<b>1</b>=True|<b>0</b>=False]" );
44 mHelpText = QObject::tr(
"int [≤ 0 ≥]" );
49 mHelpText = QObject::tr(
"int [≥ 0]" );
54 mHelpText = QObject::tr(
"int [≥ 1]" );
59 mHelpText = QObject::tr(
"double [≤ 0.0 ≥]" );
64 mHelpText = QObject::tr(
"double [≥ 0.0]" );
69 mHelpText = QObject::tr(
"double [0.0-1.0]" );
74 mHelpText = QObject::tr(
"double [0.0-360.0]" );
79 mHelpText = QObject::tr(
"string of variable length" );
84 mHelpText = QObject::tr(
"int [0-100]" );
89 mHelpText = trString() + u
"[<b>MM</b>|<b>MapUnit</b>|<b>Pixel</b>|<b>Point</b>]"_s;
94 mHelpText = QObject::tr(
"string [<b>r,g,b,a</b>] as int 0-255 or #<b>AARRGGBB</b> as hex or <b>color</b> as color's name" );
99 mHelpText = QObject::tr(
"string [<b>r,g,b</b>] as int 0-255 or #<b>RRGGBB</b> as hex or <b>color</b> as color's name" );
104 mHelpText = trString() + u
"[<b>bevel</b>|<b>miter</b>|<b>round</b>]"_s;
109 mHelpText = trString() + QStringLiteral(
"[<b>Normal</b>|<b>Lighten</b>|<b>Screen</b>|<b>Dodge</b>|<br>"
110 "<b>Addition</b>|<b>Darken</b>|<b>Multiply</b>|<b>Burn</b>|<b>Overlay</b>|<br>"
111 "<b>SoftLight</b>|<b>HardLight</b>|<b>Difference</b>|<b>Subtract</b>]" );
116 mHelpText = QObject::tr(
"double coord [<b>X,Y</b>]" );
121 mHelpText = QObject::tr(
"double [≥ 0.0]" );
126 mHelpText = QObject::tr(
"string of doubles '<b>width,height</b>' or array of doubles <b>[width, height]</b>" );
131 mHelpText = trString() + u
"[<b>no</b>|<b>solid</b>|<b>dash</b>|<b>dot</b>|<b>dash dot</b>|<b>dash dot dot</b>]"_s;
136 mHelpText = QObject::tr(
"double [≥ 0.0]" );
141 mHelpText = trString() + QStringLiteral(
"[<b>solid</b>|<b>horizontal</b>|<b>vertical</b>|<b>cross</b>|<b>b_diagonal</b>|<b>f_diagonal"
142 "</b>|<b>diagonal_x</b>|<b>dense1</b>|<b>dense2</b>|<b>dense3</b>|<b>dense4</b>|<b>dense5"
143 "</b>|<b>dense6</b>|<b>dense7</b>|<b>no]" );
148 mHelpText = trString() + u
"[<b>square</b>|<b>flat</b>|<b>round</b>]"_s;
153 mHelpText = trString() + u
"[<b>left</b>|<b>center</b>|<b>right</b>]"_s;
158 mHelpText = trString() + u
"[<b>top</b>|<b>center</b>|<b>bottom</b>]"_s;
163 mHelpText = trString() + QStringLiteral(
"[<b>filepath</b>] as<br>"
164 "<b>''</b>=empty|absolute|search-paths-relative|<br>"
165 "project-relative|URL" );
170 mHelpText = QObject::tr(
"string of doubles '<b>x,y</b>' or array of doubles <b>[x, y]</b>" );
175 mHelpText = QObject::tr(
"DateTime or string representation of a DateTime" );
198QString QgsPropertyDefinition::trString()
201 return QObject::tr(
"string " );
210 QVariantMap variantMap;
211 QMap<QString, QgsProperty>::const_iterator it = propertyMap.constBegin();
212 for ( ; it != propertyMap.constEnd(); ++it )
213 variantMap.insert( it.key(), it.value().toVariant() );
219 QMap<QString, QgsProperty> propertyMap;
220 QVariantMap::const_iterator it = variantMap.constBegin();
221 for ( ; it != variantMap.constEnd(); ++it )
225 propertyMap.insert( it.key(), property );
232 d =
new QgsPropertyPrivate();
267 if ( &other ==
this )
276 return d->active == other.d->active
277 && d->type == other.d->type
281 && ( ( !d->transformer && !other.d->transformer ) || ( d->transformer && other.d->transformer && d->transformer->toExpression( QString() ) == other.d->transformer->toExpression( QString() ) ) );
286 return ( !( ( *
this ) == other ) );
341 d->staticValue =
value;
349 return d->staticValue;
356 d->fieldName =
field;
357 d->cachedFieldIdx = -1;
368QgsProperty::operator bool()
const
376 d->expressionString = expression;
378 d->expressionPrepared =
false;
379 d->expressionIsInvalid =
false;
381 if ( d->expressionString.isEmpty() )
397 return d->expressionString;
415 exp = d->expressionString;
422 return d->transformer ? d->transformer->toExpression( exp ) : exp;
447 if ( !d->expression.prepare( &context ) )
449 d->expressionReferencedCols.clear();
450 d->expressionPrepared =
false;
451 d->expressionIsInvalid =
true;
455 d->expressionPrepared =
true;
456 d->expressionIsInvalid =
false;
457 d->expressionReferencedCols = d->expression.referencedColumns();
472 return QSet<QString>();
478 return QSet<QString>();
482 QSet< QString > fields;
483 if ( !d->fieldName.isEmpty() )
484 fields.insert( d->fieldName );
492 return d->expression.referencedColumns();
495 if ( d->expressionIsInvalid )
496 return QSet< QString >();
499 if ( !d->expressionPrepared && !
prepare( context ) )
501 d->expressionIsInvalid =
true;
502 return QSet< QString >();
505 return d->expressionReferencedCols;
509 return QSet<QString>();
514 const thread_local QRegularExpression rx( u
"^project_color(_object|)\\('.*'\\)$"_s );
516 && rx.match( d->expressionString ).hasMatch();
519QVariant QgsProperty::propertyValue(
const QgsExpressionContext &context,
const QVariant &defaultValue,
bool *ok )
const
533 return d->staticValue;
538 const QgsFeature f = context.
feature();
543 if ( d->cachedFieldIdx >= 0 )
550 if ( d->cachedFieldIdx < 0 )
560 if ( d->expressionIsInvalid )
563 if ( !d->expressionPrepared && !
prepare( context ) )
566 QVariant result = d->expression.evaluate( &context );
594 QVariant val = propertyValue( context, defaultValue, &valOk );
595 if ( !d->transformer && !valOk )
598 if ( d->transformer )
602 val = d->transformer->transform( context, val );
614 const QVariant val =
value( context, defaultDateTime, &valOk );
620 return defaultDateTime;
624 if ( val.userType() == QMetaType::Type::QDateTime )
626 dateTime = val.value<QDateTime>();
630 dateTime = val.toDateTime();
633 if ( !dateTime.isValid() )
634 return defaultDateTime;
646 const QVariant val =
value( context, defaultString, &valOk );
652 return defaultString;
658 return val.toString();
668 const QVariant val =
value( context, defaultColor, &valOk );
674 if ( val.userType() == QMetaType::Type::QColor )
676 color = val.value<QColor>();
683 if ( !color.isValid() )
699 const QVariant val =
value( context, defaultValue, &valOk );
704 bool convertOk =
false;
705 const double dbl = val.toDouble( &convertOk );
722 const QVariant val =
value( context, defaultValue, &valOk );
727 bool convertOk =
false;
728 const int integer = val.toInt( &convertOk );
732 const double dbl = val.toDouble( &convertOk );
737 return std::round( dbl );
758 const QVariant val =
value( context, defaultValue, &valOk );
770 QVariantMap propertyMap;
772 propertyMap.insert( u
"active"_s, d->active );
773 propertyMap.insert( u
"type"_s,
static_cast< int >( d->type ) );
779 propertyMap.insert( u
"val"_s, d->staticValue.toString() );
783 propertyMap.insert( u
"field"_s, d->fieldName );
787 propertyMap.insert( u
"expression"_s, d->expressionString );
794 if ( d->transformer )
797 transformer.insert( u
"t"_s, d->transformer->transformerType() );
798 transformer.insert( u
"d"_s, d->transformer->toVariant() );
800 propertyMap.insert( u
"transformer"_s,
transformer );
808 const QVariantMap propertyMap =
property.toMap();
811 d->active = propertyMap.value( u
"active"_s ).toBool();
817 d->staticValue = propertyMap.value( u
"val"_s );
822 d->fieldName = propertyMap.value( u
"field"_s ).toString();
823 if ( d->fieldName.isEmpty() )
828 d->expressionString = propertyMap.value( u
"expression"_s ).toString();
829 if ( d->expressionString.isEmpty() )
833 d->expressionPrepared =
false;
834 d->expressionIsInvalid =
false;
835 d->expressionReferencedCols.clear();
844 delete d->transformer;
845 d->transformer =
nullptr;
848 const QVariant transform = propertyMap.value( u
"transformer"_s );
850 if ( transform.isValid() )
852 const QVariantMap transformerMap = transform.toMap();
859 if (
transformer->loadVariant( transformerMap.value( u
"d"_s ) ) )
876 return d->transformer;
884 if ( d->transformer )
887 QString baseExpression;
895 if ( !fieldName.isEmpty() )
PropertyType
Property types.
@ Invalid
Invalid (not set) property.
@ Field
Field based property.
@ Expression
Expression based property.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QgsFeature feature() const
Convenience function for retrieving the feature for the context, if set.
QgsFields fields() const
Convenience function for retrieving the fields for the context, if set.
bool hasCachedStaticValue() const
Returns true if the node can be replaced by a static cached value.
QVariant cachedStaticValue() const
Returns the node's static cached value.
Handles parsing and evaluation of expressions (formerly called "search strings").
bool prepare(const QgsExpressionContext *context)
Gets the expression ready for evaluation - find out column indexes.
QString expression() const
Returns the original, unmodified expression string.
static QString quotedValue(const QVariant &value)
Returns a string representation of a literal value, including appropriate quotations where required.
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes).
const QgsExpressionNode * rootNode() const
Returns the root node of the expression.
bool isValid() const
Returns the validity of this feature.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Container of fields for a vector layer.
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
QString helpText() const
Helper text for using the property, including a description of the valid values for the property.
QString comment() const
Returns the comment of the property.
DataType dataType() const
Returns the allowable field/value data type for the property.
QString description() const
Descriptive name of the property.
StandardPropertyTemplate
Predefined standard property templates.
@ HorizontalAnchor
Horizontal anchor point.
@ Double
Double value (including negative values).
@ VerticalAnchor
Vertical anchor point.
@ Double0To1
Double value between 0-1 (inclusive).
@ FillStyle
Fill style (eg solid, lines).
@ StrokeWidth
Line stroke width.
@ LineStyle
Line style (eg solid/dashed).
@ Integer
Integer value (including negative values).
@ String
Any string value.
@ DateTime
DateTime value.
@ RenderUnits
Render units (eg mm/pixels/map units).
@ PenJoinStyle
Pen join style.
@ SvgPath
Path to an SVG file.
@ IntegerPositiveGreaterZero
Non-zero positive integer values.
@ IntegerPositive
Positive integer values (including 0).
@ Opacity
Opacity (0-100).
@ CapStyle
Line cap style (eg round).
@ ColorNoAlpha
Color with no alpha channel.
@ Rotation
Rotation (value between 0-360 degrees).
@ Custom
Custom property types.
@ Size
1D size (eg marker radius, or square marker height/width)
@ ColorWithAlpha
Color with alpha channel.
@ DoublePositive
Positive double value (including 0).
@ Size2D
2D size (width/height different)
QString name() const
Returns the name of the property.
bool supportsAssistant() const
Returns true if the property is of a type which is compatible with property override assistants.
QgsPropertyDefinition()=default
Constructs an empty property.
QString origin() const
Returns the origin of the property.
DataType
Valid data types required by property.
@ DataTypeString
Property requires a string value.
@ DataTypeBoolean
Property requires a boolean value.
@ DataTypeNumeric
Property requires a numeric value.
QDateTime valueAsDateTime(const QgsExpressionContext &context, const QDateTime &defaultDateTime=QDateTime(), bool *ok=nullptr) const
Calculates the current value of the property and interprets it as a datetime.
QColor valueAsColor(const QgsExpressionContext &context, const QColor &defaultColor=QColor(), bool *ok=nullptr) const
Calculates the current value of the property and interprets it as a color.
bool isProjectColor() const
Returns true if the property is set to a linked project color.
QSet< QString > referencedFields(const QgsExpressionContext &context=QgsExpressionContext(), bool ignoreContext=false) const
Returns the set of any fields referenced by the property for a specified expression context.
QString asExpression() const
Returns an expression string representing the state of the property, or an empty string if the proper...
bool operator==(const QgsProperty &other) const
static QVariantMap propertyMapToVariantMap(const QMap< QString, QgsProperty > &propertyMap)
Convert a map of QgsProperty to a map of QVariant This is useful to save a map of properties.
QString expressionString() const
Returns the expression used for the property value.
bool convertToTransformer()
Attempts to convert an existing expression based property to a base expression with corresponding tra...
void setTransformer(QgsPropertyTransformer *transformer)
Sets an optional transformer to use for manipulating the calculated values for the property.
void setStaticValue(const QVariant &value)
Sets the static value for the property.
Qgis::PropertyType propertyType() const
Returns the property type.
QString valueAsString(const QgsExpressionContext &context, const QString &defaultString=QString(), bool *ok=nullptr) const
Calculates the current value of the property and interprets it as a string.
QString field() const
Returns the current field name the property references.
const QgsPropertyTransformer * transformer() const
Returns the existing transformer used for manipulating the calculated values for the property,...
QVariant value(const QgsExpressionContext &context, const QVariant &defaultValue=QVariant(), bool *ok=nullptr) const
Calculates the current value of the property, including any transforms which are set for the property...
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
QVariant toVariant() const
Saves this property to a QVariantMap, wrapped in a QVariant.
bool isActive() const
Returns whether the property is currently active.
double valueAsDouble(const QgsExpressionContext &context, double defaultValue=0.0, bool *ok=nullptr) const
Calculates the current value of the property and interprets it as a double.
static QMap< QString, QgsProperty > variantMapToPropertyMap(const QVariantMap &variantMap)
Convert a map of QVariant to a map of QgsProperty This is useful to restore a map of properties.
void setField(const QString &field)
Sets the field name the property references.
int valueAsInt(const QgsExpressionContext &context, int defaultValue=0, bool *ok=nullptr) const
Calculates the current value of the property and interprets it as an integer.
bool valueAsBool(const QgsExpressionContext &context, bool defaultValue=false, bool *ok=nullptr) const
Calculates the current value of the property and interprets it as an boolean.
bool prepare(const QgsExpressionContext &context=QgsExpressionContext()) const
Prepares the property against a specified expression context.
bool loadVariant(const QVariant &property)
Loads this property from a QVariantMap, wrapped in a QVariant.
QVariant staticValue() const
Returns the current static value for the property.
bool operator!=(const QgsProperty &other) const
bool isStaticValueInContext(const QgsExpressionContext &context, QVariant &staticValue) const
Returns true if the property is effectively a static value in the specified context.
void setExpressionString(const QString &expression)
Sets the expression to use for the property value.
QgsProperty & operator=(const QgsProperty &other)
static QgsProperty fromField(const QString &fieldName, bool isActive=true)
Returns a new FieldBasedProperty created from the specified field name.
QgsProperty()
Constructor for a QgsProperty.
static QgsProperty fromValue(const QVariant &value, bool isActive=true)
Returns a new StaticProperty created from the specified value.
void setActive(bool active)
Sets whether the property is currently active.
static QColor decodeColor(const QString &str)
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.