QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgsalgorithmextractlabels.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmextractlabels.h - QgsExtractLabelsAlgorithm
3  ---------------------
4  begin : 30.12.2021
5  copyright : (C) 2021 by Mathieu Pellerin
6  email : nirvn dot asia 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 QGSALGORITHMEXTRACTLABELS_H
17 #define QGSALGORITHMEXTRACTLABELS_H
18 
19 #define SIP_NO_FILE
20 
21 #include "qgis_sip.h"
22 #include "qgsprocessingalgorithm.h"
24 
26 
27 class QgsExtractLabelsAlgorithm : public QgsProcessingAlgorithm
28 {
29  public:
30  QgsExtractLabelsAlgorithm() = default;
31 
32  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
33  QString name() const override;
34  QString displayName() const override;
35  QStringList tags() const override;
36  Flags flags() const override;
37  QString group() const override;
38  QString groupId() const override;
39  QString shortHelpString() const override;
40  QString shortDescription() const override;
41  QgsExtractLabelsAlgorithm *createInstance() const override SIP_FACTORY;
42 
43  protected:
44 
45  QVariantMap processAlgorithm( const QVariantMap &parameters,
46  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
47 
48  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
49 
50  private:
51 
52  QList<QgsMapLayer *> mMapLayers;
53  QMap<QString, QString> mMapLayerNames;
54  QMap<QString, QString> mMapThemeStyleOverrides;
55  QgsLabelingEngineSettings mLabelSettings;
57 
58 };
59 
61 
62 #endif // QGSALGORITHMEXTRACTLABELS_H
QgsProcessingAlgorithm::shortDescription
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
Definition: qgsprocessingalgorithm.cpp:60
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition: qgsprocessingfeedback.h:37
qgslabelingenginesettings.h
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:234
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
QgsProcessingAlgorithm::prepareAlgorithm
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Definition: qgsprocessingalgorithm.cpp:451
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingAlgorithm::processAlgorithm
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
QgsLabelingEngineSettings
Stores global configuration for labeling engine.
Definition: qgslabelingenginesettings.h:31
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition: qgsprocessingcontext.h:46
qgsprocessingalgorithm.h
qgis_sip.h
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition: qgsprocessingalgorithm.cpp:65
QgsCoordinateReferenceSystem
This class represents a coordinate reference system (CRS).
Definition: qgscoordinatereferencesystem.h:211
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition: qgsprocessingalgorithm.h:52
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:225
QgsProcessingAlgorithm::flags
virtual Flags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Definition: qgsprocessingalgorithm.cpp:90
QgsProcessingAlgorithm::tags
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
Definition: qgsprocessingalgorithm.h:181
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.