|
| QgsPropertyCollection (const QgsPropertyCollection &other) |
| Copy constructor. More...
|
|
| QgsPropertyCollection (const QString &name=QString()) |
| Constructor for QgsPropertyCollection. More...
|
|
void | clear () override |
| Removes all properties from the collection. More...
|
|
int | count () const |
| Returns the number of properties contained within the collection. More...
|
|
bool | hasActiveProperties () const override |
| Returns true if the collection has any active properties, or false if all properties within the collection are deactivated. More...
|
|
bool | hasDynamicProperties () const override |
| Returns true if the collection has any active, non-static properties, or false if either all non-static properties within the collection are deactivated or if the collection only contains static properties. More...
|
|
bool | hasProperty (int key) const override |
| Returns true if the collection contains a property with the specified key. More...
|
|
bool | isActive (int key) const override |
| Returns true if the collection contains an active property with the specified key. More...
|
|
bool | loadVariant (const QVariant &configuration, const QgsPropertiesDefinition &definitions) override |
| Loads this property collection from a QVariantMap, wrapped in a QVariant. More...
|
|
bool | operator!= (const QgsPropertyCollection &other) const |
|
QgsPropertyCollection & | operator= (const QgsPropertyCollection &other) |
|
bool | operator== (const QgsPropertyCollection &other) const |
|
bool | prepare (const QgsExpressionContext &context=QgsExpressionContext()) const override |
| Prepares the collection against a specified expression context. More...
|
|
virtual QgsProperty & | property (int key) |
| Returns a reference to a matching property from the collection, if one exists. More...
|
|
QgsProperty | property (int key) const override |
| Returns a matching property from the collection, if one exists. More...
|
|
QSet< int > | propertyKeys () const override |
| Returns a list of property keys contained within the collection. More...
|
|
QSet< QString > | referencedFields (const QgsExpressionContext &context=QgsExpressionContext(), bool ignoreContext=false) const override |
| Returns the set of any fields referenced by the active properties from the collection. More...
|
|
void | setProperty (int key, const QgsProperty &property) |
| Adds a property to the collection and takes ownership of it. More...
|
|
void | setProperty (int key, const QVariant &value) |
| Convenience method, creates a QgsStaticProperty and stores it within the collection. More...
|
|
QVariant | toVariant (const QgsPropertiesDefinition &definitions) const override |
| Saves this property collection to a QVariantMap, wrapped in a QVariant. More...
|
|
QVariant | value (int key, const QgsExpressionContext &context, const QVariant &defaultValue=QVariant()) const override |
| Returns the calculated value of the property with the specified key from within the collection. More...
|
|
| QgsAbstractPropertyCollection (const QString &name=QString()) |
| Constructor for QgsAbstractPropertyCollection. More...
|
|
virtual | ~QgsAbstractPropertyCollection ()=default |
|
virtual void | clear ()=0 |
| Removes all properties from the collection. More...
|
|
virtual bool | hasActiveProperties () const =0 |
| Returns true if the collection has any active properties, or false if all properties within the collection are deactivated. More...
|
|
virtual bool | hasDynamicProperties () const =0 |
| Returns true if the collection has any active, non-static properties, or false if either all non-static properties within the collection are deactivated or if the collection only contains static properties. More...
|
|
virtual bool | hasProperty (int key) const =0 |
| Returns true if the collection contains a property with the specified key. More...
|
|
virtual bool | isActive (int key) const =0 |
| Returns true if the collection contains an active property with the specified key. More...
|
|
virtual bool | loadVariant (const QVariant &configuration, const QgsPropertiesDefinition &definitions)=0 |
| Loads this property collection from a QVariantMap, wrapped in a QVariant. More...
|
|
QString | name () const |
| Returns the descriptive name of the property collection. More...
|
|
virtual bool | prepare (const QgsExpressionContext &context=QgsExpressionContext()) const =0 |
| Prepares the collection against a specified expression context. More...
|
|
virtual QgsProperty | property (int key) const =0 |
| Returns a matching property from the collection, if one exists. More...
|
|
virtual QSet< int > | propertyKeys () const =0 |
| Returns a list of property keys contained within the collection. More...
|
|
virtual bool | readXml (const QDomElement &collectionElem, const QgsPropertiesDefinition &definitions) |
| Reads property collection state from an XML element. More...
|
|
virtual QSet< QString > | referencedFields (const QgsExpressionContext &context=QgsExpressionContext(), bool ignoreContext=false) const =0 |
| Returns the set of any fields referenced by the active properties from the collection. More...
|
|
void | setName (const QString &name) |
| Sets the descriptive name for the property collection. More...
|
|
virtual QVariant | toVariant (const QgsPropertiesDefinition &definitions) const =0 |
| Saves this property collection to a QVariantMap, wrapped in a QVariant. More...
|
|
virtual QVariant | value (int key, const QgsExpressionContext &context, const QVariant &defaultValue=QVariant()) const =0 |
| Returns the calculated value of the property with the specified key from within the collection. More...
|
|
bool | valueAsBool (int key, const QgsExpressionContext &context, bool defaultValue=false, bool *ok=nullptr) const |
| Calculates the current value of the property with the specified key and interprets it as an boolean. More...
|
|
QColor | valueAsColor (int key, const QgsExpressionContext &context, const QColor &defaultColor=QColor(), bool *ok=nullptr) const |
| Calculates the current value of the property with the specified key and interprets it as a color. More...
|
|
QDateTime | valueAsDateTime (int key, const QgsExpressionContext &context, const QDateTime &defaultDateTime=QDateTime(), bool *ok=nullptr) const |
| Calculates the current value of the property with the specified key and interprets it as a datetime. More...
|
|
double | valueAsDouble (int key, const QgsExpressionContext &context, double defaultValue=0.0, bool *ok=nullptr) const |
| Calculates the current value of the property with the specified key and interprets it as a double. More...
|
|
int | valueAsInt (int key, const QgsExpressionContext &context, int defaultValue=0, bool *ok=nullptr) const |
| Calculates the current value of the property with the specified key and interprets it as an integer. More...
|
|
QString | valueAsString (int key, const QgsExpressionContext &context, const QString &defaultString=QString(), bool *ok=nullptr) const |
| Calculates the current value of the property with the specified key and interprets it as a string. More...
|
|
virtual bool | writeXml (QDomElement &collectionElem, const QgsPropertiesDefinition &definitions) const |
| Writes the current state of the property collection into an XML element. More...
|
|