QGIS API Documentation  3.21.0-Master (56b4176581)
qgsalgorithmintersection.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmintersection.h
3  ---------------------
4  Date : April 2018
5  Copyright : (C) 2018 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSALGORITHMINTERSECTION_H
17 #define QGSALGORITHMINTERSECTION_H
18 
19 #define SIP_NO_FILE
20 
21 #include "qgsprocessingalgorithm.h"
22 #include "qgsapplication.h"
23 
25 
26 class QgsIntersectionAlgorithm : public QgsProcessingAlgorithm
27 {
28  public:
29  QgsIntersectionAlgorithm() = default;
30  QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmIntersect.svg" ) ); }
31  QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmIntersect.svg" ) ); }
32  QString name() const override;
33  QString displayName() const override;
34  QString group() const override;
35  QString groupId() const override;
36  QString shortHelpString() const override;
37 
38  protected:
39  QgsProcessingAlgorithm *createInstance() const override;
40  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
41  QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
42 
43 };
44 
46 
47 #endif // QGSALGORITHMINTERSECTION_H
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
Abstract base class for processing algorithms.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.