16#ifndef QGSPROCESSINGHELPEDITORWIDGET_H
17#define QGSPROCESSINGHELPEDITORWIDGET_H
21#include "ui_qgsprocessinghelpeditorwidgetbase.h"
40class GUI_EXPORT QgsProcessingHelpEditorWidget :
public QWidget,
public Ui::QgsProcessingHelpEditorWidgetBase
49 ~QgsProcessingHelpEditorWidget()
override;
59 QVariantMap helpContent();
63 void updateHtmlView();
65 void changeItem( QTreeWidgetItem *current, QTreeWidgetItem *previous );
69 QString formattedHelp()
const;
71 void storeCurrentValue();
73 QVariantMap mHelpContent;
77 std::unique_ptr< QgsProcessingAlgorithm > mAlgorithm;
79 static const QString ALGORITHM_DESCRIPTION;
80 static const QString ALGORITHM_CREATOR;
81 static const QString ALGORITHM_HELP_CREATOR;
82 static const QString ALGORITHM_VERSION;
83 static const QString ALGORITHM_SHORT_DESCRIPTION;
84 static const QString ALGORITHM_HELP_URL;
85 static const QString ALGORITHM_EXAMPLES;
95class GUI_EXPORT QgsProcessingHelpEditorDialog :
public QDialog
104 QgsProcessingHelpEditorDialog( QWidget *parent
SIP_TRANSFERTHIS =
nullptr, Qt::WindowFlags flags = Qt::WindowFlags() );
114 QVariantMap helpContent();
118 QgsProcessingHelpEditorWidget *mWidget =
nullptr;
Abstract base class for processing algorithms.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call