Skip to content
Permalink
Browse files
Add a common interface for QgsPropertyCollection/QgsPropertyCollectio…
…nStack
  • Loading branch information
nyalldawson committed Jan 23, 2017
1 parent eade998 commit 53ba1a1f107fd369ba595ff4d2edfb748792156d
@@ -119,6 +119,7 @@
%Include qgssnappingconfig.sip
%Include qgsprojectversion.sip
%Include qgsproperty.sip
%Include qgspropertycollection.sip
%Include qgsprovidermetadata.sip
%Include qgsproviderregistry.sip
%Include qgspythonrunner.sip

Large diffs are not rendered by default.

@@ -0,0 +1,339 @@
/**
* \ingroup core
* \class QgsAbstractPropertyCollection
* \brief Abstract base class for QgsPropertyCollection like objects.
* \note Added in version 3.0
*/

class QgsAbstractPropertyCollection
{
%TypeHeaderCode
#include <qgspropertycollection.h>
%End
public:

QgsAbstractPropertyCollection( const QString& name = QString() );

/**
* Returns the name of the property collection.
* @see setName()
*/
QString name() const;

/**
* Sets the name for the property collection.
* @see name()
*/
void setName( const QString& name );

/**
* Returns a list of property keys contained within the collection.
*/
virtual QSet<int> propertyKeys() const = 0;

/**
* Removes all properties from the collection.
*/
virtual void clear() = 0;

/**
* Returns true if the collection contains a property with the specified key.
* @param key integer key for property. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @see property()
*/
virtual bool hasProperty( int key ) const = 0;

/**
* Returns a matching property from the collection, if one exists.
* @param key integer key for property to return. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @returns matching property, or null if no matching, active property found.
* @see hasProperty()
*/
virtual QgsAbstractProperty* property( int key ) = 0;

/**
* Returns a matching property from the collection, if one exists.
* @param key integer key for property to return. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @returns matching property, or null if no matching, active property found.
* @see hasProperty()
*/
//virtual const QgsAbstractProperty* property( int key ) const;

/**
* Returns the calculated value of the property with the specified key from within the collection.
* @param key integer key for property to return. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @param context expression context to evaluate property against
* @param defaultValue default value to return if no matching, active property found or if the property value
* cannot be calculated
* @returns calculated property value, or default value if property could not be evaluated
* @see valueAsColor()
* @see valueAsDouble()
* @see valueAsInt()
*/
virtual QVariant value( int key, const QgsExpressionContext& context, const QVariant& defaultValue = QVariant() ) const = 0;


/**
* Calculates the current value of the property with the specified key and interprets it as a color.
* @param key integer key for property to return. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @param context QgsExpressionContext to evaluate the property for.
* @param defaultColor default color to return if the property cannot be calculated as a color
* @returns value parsed to color
* @see value()
* @see valueAsDouble()
* @see valueAsInteger()
*/
QColor valueAsColor( int key, const QgsExpressionContext& context, const QColor& defaultColor = QColor() ) const;

/**
* Calculates the current value of the property with the specified key and interprets it as a double.
* @param key integer key for property to return. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @param context QgsExpressionContext to evaluate the property for.
* @param defaultValue default double to return if the property cannot be calculated as a double
* @returns value parsed to double
* @see value()
* @see valueAsInteger()
* @see valueAsColor()
*/
double valueAsDouble( int key, const QgsExpressionContext& context, double defaultValue = 0.0 ) const;

/**
* Calculates the current value of the property with the specified key and interprets it as an integer.
* @param key integer key for property to return. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @param context QgsExpressionContext to evaluate the property for.
* @param defaultValue default integer to return if the property cannot be calculated as a integer
* @returns value parsed to integer
* @see value()
* @see valueAsDouble()
* @see valueAsColor()
*/
int valueAsInt( int key, const QgsExpressionContext& context, int defaultValue = 0 ) const;

/**
* Returns the set of any fields referenced by the active properties from the collection.
* @param context expression context the properties will be evaluated against.
*/
virtual QSet< QString > referencedFields( const QgsExpressionContext& context = QgsExpressionContext() ) const = 0;

/**
* Returns true if the collection contains an active property with the specified key.
* @param key integer key for property to test. The intended use case is that a context specific enum is cast to
* int and used for the key value.
*/
virtual bool isActive( int key ) const = 0;

/**
* Returns true if the collection has any active properties, or false if all properties
* within the collection are deactived.
* @see hasActiveDynamicProperties()
*/
virtual bool hasActiveProperties() 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 deactived or if the collection only contains static properties.
* @see hasActiveProperties()
*/
virtual bool hasActiveDynamicProperties() const = 0;

/**
* Writes the current state of the property collection into an XML element
* @param collectionElem destination element for the property collection's state
* @param doc DOM document
* @param propertyNameMap map of key integers to string to use for property name in XML elements. This map is used
* to avoid writing the raw integer key values to XML, for readability and future-proofness.
* @see readXML()
*/
virtual bool writeXml( QDomElement& collectionElem, QDomDocument& doc, const QMap< int, QString >& propertyNameMap ) const = 0;

/**
* Reads property collection state from an XML element.
* @param collectionElem source DOM element for property collection's state
* @param doc DOM document
* @param propertyNameMap map of key integers to string to use for property name in XML elements. This map must match
* the propertyNameMap specified when writeXML() was called.
* @see writeXML()
*/
virtual bool readXml( const QDomElement& collectionElem, const QDomDocument& doc, const QMap<int, QString> &propertyNameMap ) = 0;

};


/** \ingroup core
* \class QgsPropertyCollection
* \brief A grouped map of multiple QgsAbstractProperty objects, each referenced by a integer key value.
*
* Properties within a collection are referenced by an integer key. This is done to avoid the cost of
* string creation and comparisons which would be required by a string key. The intended use case is that
* a context specific enum is cast to int and used for the key value.
* \note Added in version 2.16
*/

class QgsPropertyCollection : QgsAbstractPropertyCollection
{
%TypeHeaderCode
#include <qgspropertycollection.h>
%End

public:

/** Constructor for QgsPropertyCollection
* @param name collection name
*/
QgsPropertyCollection( const QString& name = QString() );

~QgsPropertyCollection();

//! Copy constructor
QgsPropertyCollection( const QgsPropertyCollection& other );

//QgsPropertyCollection& operator=( const QgsPropertyCollection& other );

/** Returns the number of properties contained within the collection.
*/
int count() const;

QSet<int> propertyKeys() const;
void clear();
bool hasProperty( int key ) const;
QgsAbstractProperty* property( int key );
QVariant value( int key, const QgsExpressionContext& context, const QVariant& defaultValue = QVariant() ) const;
QSet< QString > referencedFields( const QgsExpressionContext& context = QgsExpressionContext() ) const;
bool isActive( int key ) const;
bool hasActiveProperties() const;
bool hasActiveDynamicProperties() const;
bool writeXml( QDomElement& collectionElem, QDomDocument& doc, const QMap< int, QString >& propertyNameMap ) const;
bool readXml( const QDomElement& collectionElem, const QDomDocument& doc, const QMap<int, QString> &propertyNameMap );

/** Adds a property to the collection and takes ownership of it.
* @param key integer key for property. Any existing property with the same key will be deleted
* and replaced by this property. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @param property property to add. Ownership is transferred to the collection. Setting a property
* to null will remove the property from the collection.
*/
void setProperty( int key, QgsAbstractProperty* property /Transfer/ );

/** Convience method, creates a QgsStaticProperty and stores it within the collection.
* @param key integer key for property. Any existing property with the same key will be deleted
* and replaced by this property. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @param value static value for property
*/
void setProperty( int key, const QVariant& value );

};


/** \ingroup core
* \class QgsPropertyCollectionStack
* \brief An ordered stack of QgsPropertyCollection containers, where collections added later to the stack will take
* priority over earlier collections.
* \note Added in version 2.16
*/

class QgsPropertyCollectionStack : QgsAbstractPropertyCollection
{
%TypeHeaderCode
#include <qgspropertycollection.h>
%End

public:

QgsPropertyCollectionStack();

~QgsPropertyCollectionStack();

//! Copy constructor
QgsPropertyCollectionStack( const QgsPropertyCollectionStack& other );

//QgsPropertyCollectionStack& operator=( const QgsPropertyCollectionStack& other );

/** Returns the number of collections contained within the stack.
*/
int count() const;

/** Removes all collections from the stack.
*/
void clear();

/** Appends a collection to the end of the stack, and transfers ownership of the collection to the stack. Properties
* from the newly added collection will take priority over any existing properties with the same name.
* @param collection collection to append. Ownership is transferred to the stack.
*/
void appendCollection( QgsPropertyCollection* collection /Transfer/ );

/** Returns the collection at the corresponding index from the stack.
* @param index position of collection, 0 based
* @returns collection if one exists at the specified index
*/
QgsPropertyCollection* at( int index );

/** Returns the collection at the corresponding index from the stack.
* @param index position of collection, 0 based
* @returns collection if one exists at the specified index
*/
//const QgsPropertyCollection* at( int index ) const;

/** Returns the first collection with a matching name from the stack.
* @param name name of collection to find
* @returns collection if one exists with the specified name
*/
QgsPropertyCollection* collection( const QString& name );

/** Returns true if the collection has any active properties, or false if all properties
* within the collection are deactived.
* @see hasActiveProperty()
* @see hasActiveDynamicProperties()
*/
bool hasActiveProperties() const;

/** Returns true if the collection has any active, non-static properties, or false if either all non-static properties
* within the collection are deactived or if the collection only contains static properties.
* @see hasActiveProperties()
*/
bool hasActiveDynamicProperties() const;

/** Returns true if the stack contains an active property with the specified key.
* @param key integer key for property to test. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @see hasActiveProperties()
*/
bool isActive( int key ) const;

/** Returns the highest priority property with a matching key from within the stack.
* @param key integer key for property to return. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @returns matching property, or null if no matching, active property found.
* @see hasActiveProperty()
*/
QgsAbstractProperty* property( int key );

/** Returns the calculated value of the highest priority property with the specified key from within the stack.
* @param key integer key for property to calculate. The intended use case is that a context specific enum is cast to
* int and used for the key value.
* @param context expression context to evaluate property against
* @param defaultValue default value to return if no matching, active property found or if the property value
* cannot be calculated
* @returns calculated property value, or default value if property could not be evaluated
*/
QVariant value( int key, const QgsExpressionContext& context, const QVariant& defaultValue = QVariant() ) const;

/** Returns the set of any fields referenced by the active properties from the stack.
* @param context expression context the properties will be evaluated against.
*/
QSet< QString > referencedFields( const QgsExpressionContext& context = QgsExpressionContext() ) const;

QSet<int> propertyKeys() const;
bool hasProperty( int key ) const;
bool writeXml( QDomElement& collectionElem, QDomDocument& doc, const QMap< int, QString >& propertyNameMap ) const;
bool readXml( const QDomElement& collectionElem, const QDomDocument& doc, const QMap<int, QString> &propertyNameMap );
};

@@ -193,6 +193,7 @@ SET(QGIS_CORE_SRCS
qgsprojectproperty.cpp
qgsprojectversion.cpp
qgsproperty.cpp
qgspropertycollection.cpp
qgsprovidermetadata.cpp
qgsproviderregistry.cpp
qgspythonrunner.cpp
@@ -718,6 +719,7 @@ SET(QGIS_CORE_HDRS
qgsprojectproperty.h
qgsprojectversion.h
qgsproperty.h
qgspropertycollection.h
qgsprovidermetadata.h
qgsproviderregistry.h
qgspythonrunner.h
@@ -88,7 +88,7 @@ void QgsDiagramLayerSettings::readXml( const QDomElement& elem, const QgsVectorL
QDomNodeList propertyElems = elem.elementsByTagName( "properties" );
if ( !propertyElems.isEmpty() )
{
( void )mProperties.readXML( propertyElems.at( 0 ).toElement(), elem.ownerDocument(), sPropertyNameMap );
( void )mProperties.readXml( propertyElems.at( 0 ).toElement(), elem.ownerDocument(), sPropertyNameMap );
}
else
{
@@ -131,7 +131,7 @@ void QgsDiagramLayerSettings::writeXml( QDomElement& layerElem, QDomDocument& do

QDomElement diagramLayerElem = doc.createElement( QStringLiteral( "DiagramLayerSettings" ) );
QDomElement propertiesElem = doc.createElement( "properties" );
( void )mProperties.writeXML( propertiesElem, doc, sPropertyNameMap );
( void )mProperties.writeXml( propertiesElem, doc, sPropertyNameMap );
diagramLayerElem.appendChild( propertiesElem );
diagramLayerElem.setAttribute( QStringLiteral( "placement" ), mPlacement );
diagramLayerElem.setAttribute( QStringLiteral( "linePlacementFlags" ), mPlacementFlags );
@@ -162,7 +162,7 @@ void QgsDiagramLayerSettings::init()
}
}

QSet<QString> QgsDiagramLayerSettings::referencedFields( const QgsExpressionContext &context, const QgsFields& fieldsParameter ) const
QSet<QString> QgsDiagramLayerSettings::referencedFields( const QgsExpressionContext &context ) const
{
QSet< QString > referenced;
if ( mRenderer )
@@ -28,6 +28,7 @@
#include "qgscoordinatetransform.h"
#include "qgssymbol.h"
#include "qgsproperty.h"
#include "qgspropertycollection.h"


class QgsDiagram;

0 comments on commit 53ba1a1

Please sign in to comment.