qgsconditionalstyle.h

Go to the documentation of this file.

/***************************************************************************
    qgsconditionalstyle.h
    ---------------------
    begin                : August 2015
    copyright            : (C) 2015 by Nathan Woodrow
    email                : woodrow dot nathan 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 QGSCONDITIONALSTYLE_H
#define QGSCONDITIONALSTYLE_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgsfield.h"
 
#include <QColor>
#include <QDomDocument>
#include <QDomNode>
#include <QFont>
#include <QHash>
#include <QObject>
#include <QPixmap>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsConditionalStyle;
class QgsReadWriteContext;
class QgsExpressionContext;
class QgsSymbol;
 
typedef QList<QgsConditionalStyle> QgsConditionalStyles;

class CORE_EXPORT QgsConditionalLayerStyles : public QObject
{
    Q_OBJECT
 
  public:
    QgsConditionalLayerStyles( QObject *parent = nullptr );

    QgsConditionalStyles rowStyles() const;

    void setRowStyles( const QgsConditionalStyles &styles );

    QgsConditionalStyle constraintFailureStyles( QgsFieldConstraints::ConstraintStrength strength );

    void setFieldStyles( const QString &fieldName, const QList<QgsConditionalStyle> &styles );

    QList<QgsConditionalStyle> fieldStyles( const QString &fieldName ) const;

    bool readXml( const QDomNode &node, const QgsReadWriteContext &context );

    bool writeXml( QDomNode &node, QDomDocument &doc, const QgsReadWriteContext &context ) const;

    bool rulesNeedGeometry() const;
 
  signals:

    void changed();
 
  private:
    QHash<QString, QgsConditionalStyles> mFieldStyles;
    QgsConditionalStyles mRowStyles;
};

class CORE_EXPORT QgsConditionalStyle
{
  public:
    QgsConditionalStyle();
    QgsConditionalStyle( const QgsConditionalStyle &other );
    SIP_SKIP QgsConditionalStyle( QgsConditionalStyle &&other );
    QgsConditionalStyle( const QString &rule );
    ~QgsConditionalStyle();
 
    QgsConditionalStyle &operator=( const QgsConditionalStyle &other );
    QgsConditionalStyle &operator=( QgsConditionalStyle &&other );

    bool matches( const QVariant &value, QgsExpressionContext &context ) const;

    QPixmap renderPreview( const QSize &size = QSize() ) const;

    void setName( const QString &value )
    {
      mName = value;
      mValid = true;
    }

    void setRule( const QString &value )
    {
      mRule = value;
      mValid = true;
    }

    void setBackgroundColor( const QColor &value )
    {
      mBackColor = value;
      mValid = true;
    }

    void setTextColor( const QColor &value )
    {
      mTextColor = value;
      mValid = true;
    }

    void setFont( const QFont &value )
    {
      mFont = value;
      mValid = true;
    }

    void setSymbol( QgsSymbol *value );

    QString displayText() const;

    QString name() const { return mName; }

    QPixmap icon() const { return mIcon; }

    QgsSymbol *symbol() const { return mSymbol.get(); }

    QColor textColor() const { return mTextColor; }

    bool validTextColor() const;

    QColor backgroundColor() const { return mBackColor; }

    bool validBackgroundColor() const;

    QFont font() const { return mFont; }

    QString rule() const { return mRule; }

    bool isValid() const { return mValid; }

    static QList<QgsConditionalStyle> matchingConditionalStyles( const QList<QgsConditionalStyle> &styles, const QVariant &value, QgsExpressionContext &context );

    static QgsConditionalStyle matchingConditionalStyle( const QList<QgsConditionalStyle> &styles, const QVariant &value, QgsExpressionContext &context );

    static QgsConditionalStyle compressStyles( const QList<QgsConditionalStyle> &styles );

    bool readXml( const QDomNode &node, const QgsReadWriteContext &context );

    bool writeXml( QDomNode &node, QDomDocument &doc, const QgsReadWriteContext &context ) const;
 
    bool operator==( const QgsConditionalStyle &other ) const;
    bool operator!=( const QgsConditionalStyle &other ) const;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str;
    if ( !sipCpp->name().isEmpty() )
      str = u"<QgsConditionalStyle: '%1' (%2)>"_s.arg( sipCpp->name(), sipCpp->rule() );
    else
      str = u"<QgsConditionalStyle: %2>"_s.arg( sipCpp->rule() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
 
    bool mValid
    = false;
    QString mName;
    QString mRule;
    std::unique_ptr<QgsSymbol> mSymbol;
    QFont mFont;
    QColor mBackColor;
    QColor mTextColor;
    QPixmap mIcon;
};
 
#endif // QGSCONDITIONALSTYLE_H