QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgsnativealgorithms.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsnativealgorithms.h
3  ---------------------
4  begin : April 2017
5  copyright : (C) 2017 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 QGSNATIVEALGORITHMS_H
19 #define QGSNATIVEALGORITHMS_H
20 
21 #include "qgis_analysis.h"
22 #include "qgis_sip.h"
23 #include "qgsprocessingprovider.h"
24 
31 class ANALYSIS_EXPORT QgsNativeAlgorithms: public QgsProcessingProvider
32 {
33  Q_OBJECT
34 
35  public:
36 
40  QgsNativeAlgorithms( QObject *parent = nullptr );
41 
42  QIcon icon() const override;
43  QString svgIconPath() const override;
44  QString id() const override;
45  QString helpId() const override;
46  QString name() const override;
47  bool supportsNonFileBasedOutput() const override;
48 
49  protected:
50 
51  void loadAlgorithms() override;
52 
53 };
54 
55 #endif // QGSNATIVEALGORITHMS_H
56 
57 
QgsProcessingProvider::id
virtual QString id() const =0
Returns the unique provider id, used for identifying the provider.
QgsProcessingProvider
Abstract base class for processing providers.
Definition: qgsprocessingprovider.h:35
QgsProcessingProvider::icon
virtual QIcon icon() const
Returns an icon for the provider.
Definition: qgsprocessingprovider.cpp:34
QgsProcessingProvider::name
virtual QString name() const =0
Returns the provider name, which is used to describe the provider within the GUI.
QgsNativeAlgorithms
Native c++ processing algorithm provider.
Definition: qgsnativealgorithms.h:31
qgis_sip.h
QgsProcessingProvider::svgIconPath
virtual QString svgIconPath() const
Returns a path to an SVG version of the provider's icon.
Definition: qgsprocessingprovider.cpp:39
QgsProcessingProvider::loadAlgorithms
virtual void loadAlgorithms()=0
Loads all algorithms belonging to this provider.
QgsProcessingProvider::helpId
virtual QString helpId() const
Returns the provider help id string, used for creating QgsHelp urls for algorithms belong to this pro...
Definition: qgsprocessingprovider.cpp:49
qgsprocessingprovider.h
QgsProcessingProvider::supportsNonFileBasedOutput
virtual bool supportsNonFileBasedOutput() const
Returns true if the provider supports non-file based outputs (such as memory layers or direct databas...
Definition: qgsprocessingprovider.cpp:274