qgsstyleentityvisitor.h

Go to the documentation of this file.

/***************************************************************************
                         qgsstyleentityvisitor.h
                         ---------------
    begin                : July 2019
    copyright            : (C) 2019 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 QGSSTYLEENTITYVISITOR_H
#define QGSSTYLEENTITYVISITOR_H

#include "qgis_core.h"
#include "qgsstyle.h"

class CORE_EXPORT QgsStyleEntityVisitorInterface
{

  public:

    enum class NodeType : int
    {
      Project, 
      Layer, 
      SymbolRule, 
      Layouts, 
      PrintLayout, 
      LayoutItem, 
      Report, 
      ReportHeader, 
      ReportFooter, 
      ReportSection, 
      Annotations, 
      Annotation, 
    };

    struct StyleLeaf
    {

      StyleLeaf( const QgsStyleEntityInterface *entity, const QString &identifier = QString(), const QString &description = QString() )
        : identifier( identifier )
        , description( description )
        , entity( entity )
      {}

      QString identifier;

      QString description;

      const QgsStyleEntityInterface *entity = nullptr;
    };

    struct Node
    {

      Node( QgsStyleEntityVisitorInterface::NodeType type, const QString &identifier, const QString &description )
        : type( type )
        , identifier( identifier )
        , description( description )
      {}

      QgsStyleEntityVisitorInterface::NodeType type = QgsStyleEntityVisitorInterface::NodeType::Project;

      QString identifier;

      QString description;

    };

    virtual ~QgsStyleEntityVisitorInterface() = default;

    virtual bool visit( const QgsStyleEntityVisitorInterface::StyleLeaf &entity )
    {
      Q_UNUSED( entity )
      return true;
    }

    virtual bool visitEnter( const QgsStyleEntityVisitorInterface::Node &node )
    {
      Q_UNUSED( node )
      return true;
    }

    virtual bool visitExit( const QgsStyleEntityVisitorInterface::Node &node )
    {
      Q_UNUSED( node )
      return true;
    }

};

#endif // QGSSTYLEENTITYVISITOR_H