qgsobjectvisitor.h

Go to the documentation of this file.

/***************************************************************************
                         qgsobjectvisitor.h
                         ---------------
    begin                : October 2025
    copyright            : (C) 2025 by Mathieu Pellerin
    email                : mathieu 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 QGSOBJECTVISITOR_H
#define QGSOBJECTVISITOR_H
 
#include "qgis.h"
#include "qgis_core.h"

class CORE_EXPORT QgsEmbeddedScriptEntity
{
  public:
    QgsEmbeddedScriptEntity( Qgis::EmbeddedScriptType type, const QString &name, const QString &script )
      : mType( type )
      , mName( name )
      , mScript( script )
    {}

    Qgis::EmbeddedScriptType type() const { return mType; }

    QString name() const { return mName; }

    QString script() const { return mScript; }
 
  private:
    Qgis::EmbeddedScriptType mType;
    QString mName;
    QString mScript;
};
 

class CORE_EXPORT QgsObjectVisitorContext
{
  public:
    QgsObjectVisitorContext() = default;
};
 

class CORE_EXPORT QgsObjectEntityVisitorInterface
{
  public:
    virtual ~QgsObjectEntityVisitorInterface() = default;

    virtual bool visitEmbeddedScript( const QgsEmbeddedScriptEntity &entity, const QgsObjectVisitorContext &context )
    {
      Q_UNUSED( entity )
      Q_UNUSED( context )
      return true;
    }
};
 

class CORE_EXPORT QgsEmbeddedScriptVisitor : public QgsObjectEntityVisitorInterface
{
  public:
    bool visitEmbeddedScript( const QgsEmbeddedScriptEntity &entity, const QgsObjectVisitorContext & ) override
    {
      mEmbeddedScripts << entity;
      return true;
    }

    const QList<QgsEmbeddedScriptEntity> &embeddedScripts() const { return mEmbeddedScripts; }
 
  private:
    QList<QgsEmbeddedScriptEntity> mEmbeddedScripts;
};
 
#endif // QGSOBJECTVISITOR_H