QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
qgsalgorithmannotations.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmannotations.h
3 ------------------------------
4 begin : September 2021
5 copyright : (C) 2021 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSALGORITHMANNOTATIONS_H
19#define QGSALGORITHMANNOTATIONS_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25
27
31class QgsTransferAnnotationsFromMainAlgorithm : public QgsProcessingAlgorithm
32{
33
34 public:
35
36 QgsTransferAnnotationsFromMainAlgorithm() = default;
37 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
38 QString name() const override;
39 QString displayName() const override;
40 QStringList tags() const override;
41 QString group() const override;
42 QString groupId() const override;
44 QString shortHelpString() const override;
45 QgsTransferAnnotationsFromMainAlgorithm *createInstance() const override SIP_FACTORY;
46
47 protected:
48
49 QVariantMap processAlgorithm( const QVariantMap &parameters,
50 QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
51};
52
54
55#endif // QGSALGORITHMANNOTATIONS_H
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3076
Abstract base class for processing algorithms.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
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.
#define SIP_FACTORY
Definition qgis_sip.h:76