Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Sipify QgsProcessingAlgorithm
- Loading branch information
1 parent
a0bd464
commit e40389a
Showing
2 changed files
with
82 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,99 @@ | ||
/************************************************************************ | ||
* This file has been generated automatically from * | ||
* * | ||
* src/core/processing/qgsprocessingalgorithm.h * | ||
* * | ||
* Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
************************************************************************/ | ||
|
||
|
||
|
||
|
||
class QgsProcessingAlgorithm | ||
{ | ||
%TypeHeaderCode | ||
#include <qgsprocessingalgorithm.h> | ||
%Docstring | ||
Abstract base class for processing algorithms. | ||
.. versionadded:: 3.0 | ||
%End | ||
|
||
%TypeHeaderCode | ||
#include "qgsprocessingalgorithm.h" | ||
%End | ||
public: | ||
|
||
enum Flag | ||
enum Flag | ||
{ | ||
FlagHideFromToolbox, | ||
FlagHideFromModeler, | ||
FlagSupportsBatch, | ||
FlagDeprecated, | ||
FlagDeprecated | ||
}; | ||
typedef QFlags<QgsProcessingAlgorithm::Flag> Flags; | ||
|
||
QgsProcessingAlgorithm(); | ||
%Docstring | ||
Constructor for QgsProcessingAlgorithm. | ||
%End | ||
|
||
virtual ~QgsProcessingAlgorithm(); | ||
|
||
virtual QString name() const = 0; | ||
%Docstring | ||
Returns the algorithm name, used for identifying the algorithm. This string | ||
should be fixed for the algorithm, and must not be localised. The name should | ||
be unique within each provider. Names should contain lowercase alphanumeric characters | ||
only and no spaces or other formatting characters. | ||
\see displayName() | ||
\see group() | ||
\see tags() | ||
%End | ||
|
||
virtual QString displayName() const = 0; | ||
%Docstring | ||
Returns the translated algorithm name, which should be used for any user-visible display | ||
of the algorithm name. | ||
\see name() | ||
%End | ||
|
||
virtual QStringList tags() const; | ||
%Docstring | ||
Returns a list of tags which relate to the algorithm, and are used to assist users in searching | ||
for suitable algorithms. These tags should be localised. | ||
%End | ||
|
||
virtual QIcon icon() const; | ||
%Docstring | ||
Returns an icon for the algorithm. | ||
\see svgIconPath() | ||
%End | ||
|
||
virtual QString svgIconPath() const; | ||
%Docstring | ||
Returns a path to an SVG version of the algorithm's icon. | ||
\see icon() | ||
%End | ||
|
||
virtual QString group() const; | ||
%Docstring | ||
Returns the name of the group this algorithm belongs to. This string | ||
should be localised. | ||
\see tags() | ||
%End | ||
|
||
virtual Flags flags() const; | ||
%Docstring | ||
Returns the flags indicating how and when the algorithm operates and should be exposed to users. | ||
%End | ||
|
||
}; | ||
QFlags<QgsProcessingAlgorithm::Flag> operator|(QgsProcessingAlgorithm::Flag f1, QFlags<QgsProcessingAlgorithm::Flag> f2); | ||
|
||
|
||
|
||
/************************************************************************ | ||
* This file has been generated automatically from * | ||
* * | ||
* src/core/processing/qgsprocessingalgorithm.h * | ||
* * | ||
* Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
************************************************************************/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters