qgsstoredquerymanager.h

Go to the documentation of this file.

/***************************************************************************
                             qgsstoredquerymanager.h
                             ----------------------------------
    Date                 : February 2025
    Copyright            : (C) 2025 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 QGSSTOREDQUERYMANAGER_H
#define QGSSTOREDQUERYMANAGER_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgssettingstree.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class GUI_EXPORT QgsStoredQueryManager : public QObject
{
    Q_OBJECT
 
  public:
#ifndef SIP_RUN
    static inline QgsSettingsTreeNamedListNode *sTreeStoredQueries = QgsSettingsTree::sTreeDatabase->createNamedListNode( u"stored-queries"_s );
    static const QgsSettingsEntryString *settingQueryName;
    static const QgsSettingsEntryString *settingQueryDefinition;
#endif

    QgsStoredQueryManager( QObject *parent = nullptr );

    void storeQuery( const QString &name, const QString &query, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile );

    void removeQuery( const QString &name, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile );

    QStringList allQueryNames( Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile ) const;

    QString query( const QString &name, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile ) const;

    class QueryDetails
    {
      public:
        QString name;

        QString definition;

        Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile;
    };

    QList< QgsStoredQueryManager::QueryDetails > allQueries() const;
 
  signals:

    void queryAdded( const QString &name, Qgis::QueryStorageBackend backend );

    void queryChanged( const QString &name, Qgis::QueryStorageBackend backend );

    void queryRemoved( const QString &name, Qgis::QueryStorageBackend backend );
 
  private:
    static QString getQueryHash( const QString &name );
};
 
 
#endif // QGSSTOREDQUERYMANAGER_H