qgsproperty.h

Go to the documentation of this file.

/***************************************************************************
     qgsproperty.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 QGSPROPERTY_H
#define QGSPROPERTY_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsexpressioncontext.h"
 
#include <QColor>
#include <QDateTime>
#include <QDomDocument>
#include <QDomElement>
#include <QHash>
#include <QString>
#include <QStringList>
#include <QVariant>
 
using namespace Qt::StringLiterals;
 
class QgsPropertyTransformer;
class QgsPropertyPrivate;

class CORE_EXPORT QgsPropertyDefinition
{
  public:

    enum StandardPropertyTemplate
    {
      Boolean = 0, 
      Integer, 
      IntegerPositive, 
      IntegerPositiveGreaterZero, 
      Double, 
      DoublePositive, 
      Double0To1, 
      Rotation, 
      String, 
      Opacity, 
      RenderUnits, 
      ColorWithAlpha, 
      ColorNoAlpha, 
      PenJoinStyle, 
      BlendMode, 
      Point, 
      Size, 
      Size2D, 
      LineStyle, 
      StrokeWidth, 
      FillStyle, 
      CapStyle, 
      HorizontalAnchor, 
      VerticalAnchor, 
      SvgPath, 
      Offset, 
      DateTime, 
      Custom = 3000, 
    };

    enum DataType
    {

      DataTypeString = 0,

      DataTypeNumeric,

      DataTypeBoolean,
    };

    QgsPropertyDefinition() = default;

    QgsPropertyDefinition( const QString &name, const QString &description, StandardPropertyTemplate type, const QString &origin = QString(), const QString &comment = QString() );

    QgsPropertyDefinition( const QString &name, DataType dataType, const QString &description, const QString &helpText, const QString &origin = QString(), const QString &comment = QString() );

    QString name() const { return mName; }

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

    QString origin() const { return mOrigin; }

    void setOrigin( const QString &origin ) { mOrigin = origin; }

    QString description() const { return mDescription; }

    QString comment() const { return mComment; }

    void setComment( const QString &comment ) { mComment = comment; }

    QString helpText() const { return mHelpText; }

    void setDataType( DataType type ) { mTypes = type; }

    DataType dataType() const { return mTypes; }

    StandardPropertyTemplate standardTemplate() const { return mStandardType; }

    bool supportsAssistant() const;
 
  private:
 
    QString mName;
    QString mDescription;
    DataType mTypes = DataTypeString;
    QString mHelpText;
    StandardPropertyTemplate mStandardType = Custom;
    QString mOrigin;
    QString mComment;
 
    static QString trString();
};
 

 
class CORE_EXPORT QgsProperty
{
  public:

    static QVariantMap propertyMapToVariantMap( const QMap<QString, QgsProperty> &propertyMap );

    static QMap<QString, QgsProperty> variantMapToPropertyMap( const QVariantMap &variantMap );

    QgsProperty();
 
    ~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 );
    QgsProperty &operator=( const QgsProperty &other );

    explicit operator bool() const SIP_SKIP;
 
    bool operator==( const QgsProperty &other ) const;
    bool operator!=( const QgsProperty &other ) const;

    Qgis::PropertyType propertyType() const;

    bool isActive() const;

    bool isStaticValueInContext( const QgsExpressionContext &context, QVariant &staticValue SIP_OUT ) 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;

    QString asExpression() const;

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

    QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext(), bool ignoreContext = false ) const;

    bool isProjectColor() const;

    QVariant value( const QgsExpressionContext &context, const QVariant &defaultValue = QVariant(), bool *ok SIP_OUT = nullptr ) const;

    QDateTime valueAsDateTime( const QgsExpressionContext &context, const QDateTime &defaultDateTime = QDateTime(), bool *ok SIP_OUT = nullptr ) const;

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

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

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

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

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

    QVariant toVariant() const;

    bool loadVariant( const QVariant &property );

    void setTransformer( QgsPropertyTransformer *transformer SIP_TRANSFER );

    const QgsPropertyTransformer *transformer() const;

    bool convertToTransformer();

    operator QVariant() const
    {
      return QVariant::fromValue( *this );
    }
 
 
#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString typeString;
    QString definitionString;
    switch ( sipCpp->propertyType() )
    {
      case Qgis::PropertyType::Static:
        typeString = u"static"_s;
        definitionString = sipCpp->staticValue().toString();
        break;
 
      case Qgis::PropertyType::Field:
        typeString = u"field"_s;
        definitionString = sipCpp->field();
        break;
 
      case Qgis::PropertyType::Expression:
        typeString = u"expression"_s;
        definitionString = sipCpp->expressionString();
        break;
 
      case Qgis::PropertyType::Invalid:
        typeString = u"invalid"_s;
        break;
    }
 
    QString str = u"<QgsProperty: %1%2%3>"_s.arg( !sipCpp->isActive() && sipCpp->propertyType() != Qgis::PropertyType::Invalid ? u"INACTIVE "_s : QString(),
                  typeString,
                  definitionString.isEmpty() ? QString() : u" (%1)"_s.arg( definitionString ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif
 
  private:
 
    mutable QExplicitlySharedDataPointer<QgsPropertyPrivate> d;

    QVariant propertyValue( const QgsExpressionContext &context, const QVariant &defaultValue = QVariant(), bool *ok = nullptr ) const;
 
};
 
Q_DECLARE_METATYPE( QgsProperty )
 
#endif // QGSPROPERTY_H