qgspropertycollection.h

Go to the documentation of this file.

/***************************************************************************
     qgspropertycollection.h
     -----------------------
    Date                 : January 2017
    Copyright            : (C) 2017 by Nyall Dawson
    Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSPROPERTYCOLLECTION_H
#define QGSPROPERTYCOLLECTION_H

#include "qgis_core.h"
#include "qgis.h"
#include <QString>
#include <QVariant>
#include <QColor>
#include "qgsexpressioncontext.h"
#include "qgsproperty.h"

class QDomElement;
class QDomDocument;

typedef QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition;

class CORE_EXPORT QgsAbstractPropertyCollection
{

#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsPropertyCollection *>( sipCpp ) )
      sipType = sipType_QgsPropertyCollection;
    else if ( dynamic_cast<QgsPropertyCollectionStack *>( sipCpp ) )
      sipType = sipType_QgsPropertyCollectionStack;
    else
      sipType = sipType_QgsAbstractPropertyCollection;
    SIP_END
#endif

  public:

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

    virtual ~QgsAbstractPropertyCollection() = default;

    QString name() const { return mName; }

    void setName( const QString &name ) { mName = name; }

    virtual QSet<int> propertyKeys() const = 0;

    virtual void clear() = 0;

    virtual bool hasProperty( int key ) const = 0;

    virtual QgsProperty property( int key ) const = 0;

    virtual QVariant value( int key, const QgsExpressionContext &context, const QVariant &defaultValue = QVariant() ) const = 0;

    QString valueAsString( int key, const QgsExpressionContext &context, const QString &defaultString = QString(), bool *ok SIP_OUT = nullptr ) const;

    QColor valueAsColor( int key, const QgsExpressionContext &context, const QColor &defaultColor = QColor(), bool *ok SIP_OUT = nullptr ) const;

    double valueAsDouble( int key, const QgsExpressionContext &context, double defaultValue = 0.0, bool *ok SIP_OUT = nullptr ) const;

    int valueAsInt( int key, const QgsExpressionContext &context, int defaultValue = 0, bool *ok SIP_OUT = nullptr ) const;

    bool valueAsBool( int key, const QgsExpressionContext &context, bool defaultValue = false, bool *ok SIP_OUT = nullptr ) const;

    virtual bool prepare( const QgsExpressionContext &context = QgsExpressionContext() ) const = 0;

    virtual QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext() ) const = 0;

    virtual bool isActive( int key ) const = 0;

    virtual bool hasActiveProperties() const = 0;

    virtual bool hasDynamicProperties() const = 0;

    virtual bool writeXml( QDomElement &collectionElem, const QgsPropertiesDefinition &definitions ) const;

    virtual bool readXml( const QDomElement &collectionElem, const QgsPropertiesDefinition &definitions );

    virtual QVariant toVariant( const QgsPropertiesDefinition &definitions ) const = 0;

    virtual bool loadVariant( const QVariant &configuration, const QgsPropertiesDefinition &definitions ) = 0;

  private:

    QString mName;
};

class CORE_EXPORT QgsPropertyCollection : public QgsAbstractPropertyCollection
{
  public:

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

    QgsPropertyCollection( const QgsPropertyCollection &other );

    QgsPropertyCollection &operator=( const QgsPropertyCollection &other );

    int count() const;

    QSet<int> propertyKeys() const override;
    void clear() override;
    bool hasProperty( int key ) const override;
    QgsProperty property( int key ) const override SIP_SKIP;

    virtual QgsProperty &property( int key );

    QVariant value( int key, const QgsExpressionContext &context, const QVariant &defaultValue = QVariant() ) const override;
    bool prepare( const QgsExpressionContext &context = QgsExpressionContext() ) const override;
    QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext() ) const override;
    bool isActive( int key ) const override;
    bool hasActiveProperties() const override;
    bool hasDynamicProperties() const override;

    QVariant toVariant( const QgsPropertiesDefinition &definitions ) const override;
    bool loadVariant( const QVariant &configuration, const QgsPropertiesDefinition &definitions ) override;

    void setProperty( int key, const QgsProperty &property );

    void setProperty( int key, const QVariant &value );

  private:

    QHash<int, QgsProperty> mProperties;

    mutable bool mDirty = false;
    mutable bool mHasActiveProperties = false;
    mutable bool mHasDynamicProperties = false;
    mutable int mCount = 0;

    void rescan() const;
};


class CORE_EXPORT QgsPropertyCollectionStack : public QgsAbstractPropertyCollection
{
  public:

    QgsPropertyCollectionStack() = default;

    ~QgsPropertyCollectionStack() override;

    QgsPropertyCollectionStack( const QgsPropertyCollectionStack &other );

    QgsPropertyCollectionStack &operator=( const QgsPropertyCollectionStack &other );

    int count() const;

    void clear() override;

    void appendCollection( QgsPropertyCollection *collection SIP_TRANSFER );

    QgsPropertyCollection *at( int index );

    const QgsPropertyCollection *at( int index ) const SIP_SKIP;

    QgsPropertyCollection *collection( const QString &name );

    bool hasActiveProperties() const override;

    bool hasDynamicProperties() const override;

    bool isActive( int key ) const override;

    QgsProperty property( int key ) const override;

    QVariant value( int key, const QgsExpressionContext &context, const QVariant &defaultValue = QVariant() ) const override;

    QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext() ) const override;
    bool prepare( const QgsExpressionContext &context = QgsExpressionContext() ) const override;

    QSet<int> propertyKeys() const override;
    bool hasProperty( int key ) const override;

    QVariant toVariant( const QgsPropertiesDefinition &definitions ) const override;

    bool loadVariant( const QVariant &collection, const QgsPropertiesDefinition &definitions ) override;

  private:

    QList< QgsPropertyCollection * > mStack;

};

#endif // QGSPROPERTYCOLLECTION_H