qgsprocessingguiutils.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprocessingguiutils.h
                             ------------------------
    Date                 : June 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 QGSPROCESSINGGUIUTILS_H
#define QGSPROCESSINGGUIUTILS_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsprocessingcontext.h"
 
class QgsLayerTreeLayer;
class QgsLayerTreeView;

class GUI_EXPORT QgsProcessingGuiUtils
{
  public:
    class GUI_EXPORT ResultLayerDetails
    {
      public:
        ResultLayerDetails( QgsMapLayer *layer SIP_TRANSFER )
          : layer( layer )
        {}

        QgsMapLayer *layer = nullptr;

        QgsLayerTreeGroup *targetLayerTreeGroup = nullptr;

        int sortKey = 0;

        QgsProject *destinationProject = nullptr;
    };

    static void configureResultLayerTreeLayer( QgsLayerTreeLayer *layerTreeLayer );

    static QgsLayerTreeGroup *layerTreeResultsGroup( const QgsProcessingContext::LayerDetails &layerDetails, const QgsProcessingContext &context );

    static void addResultLayers( const QVector< QgsProcessingGuiUtils::ResultLayerDetails > &layers, const QgsProcessingContext &context, QgsLayerTreeView *view = nullptr );
};
 
 
#endif // QGSPROCESSINGGUIUTILS_H