qgsstoredexpressionmanager.h

Go to the documentation of this file.

/***************************************************************************
                          qgsstoredexpressionmanager.h
                             -------------------
    begin                : August 2019
    copyright            : (C) 2019 David Signer
    email                : david at opengis dot ch
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSSTOREDEXPRESSIONMANAGER_H
#define QGSSTOREDEXPRESSIONMANAGER_H

#include "qgis_core.h"
#include <QString>
#include <QObject>
#include <QUuid>


#ifdef SIP_RUN
% ModuleHeaderCode
#include <qgsstoredexpressionmanager.h>
% End
#endif

class QDomNode;
class QDomDocument;

struct CORE_EXPORT QgsStoredExpression
{

  enum Category
  {
    FilterExpression        = 1 << 0, 
    DefaultValueExpression  = 1 << 1,  
    All                     = FilterExpression | DefaultValueExpression
  };

#ifndef SIP_RUN

  QgsStoredExpression() = default;

  QgsStoredExpression( QString name, QString expression, Category tag = Category::FilterExpression )
    : id( QUuid::createUuid().toString() ),
      name( name ),
      expression( expression ),
      tag( tag )
  {}
#endif

  QString id;
  QString name;
  QString expression;
  Category tag;
};

class CORE_EXPORT QgsStoredExpressionManager : public QObject
{
    Q_OBJECT

  public:

    QgsStoredExpressionManager() = default;

    QString addStoredExpression( const QString &name, const QString &expression, const QgsStoredExpression::Category &tag =  QgsStoredExpression::Category::FilterExpression );

    void removeStoredExpression( const QString &id );

    void updateStoredExpression( const QString &id, const QString &name, const QString &expression, const  QgsStoredExpression::Category &tag );

    void addStoredExpressions( const QList< QgsStoredExpression > &storedExpressions );

    QList< QgsStoredExpression > storedExpressions( const  QgsStoredExpression::Category &tag = QgsStoredExpression::Category::All );


    QgsStoredExpression storedExpression( const QString &id ) const;

    QgsStoredExpression findStoredExpressionByExpression( const QString &expression, const  QgsStoredExpression::Category &tag = QgsStoredExpression::Category::All ) const;

    void clearStoredExpressions();

    bool writeXml( QDomNode &layerNode ) const;

    bool readXml( const QDomNode &layerNode );

  signals:

  public slots:

  private:
    QList< QgsStoredExpression > mStoredExpressions;
};

#endif // QGSSTOREDEXPRESSIONMANAGER_H