|
| 1 | +/*************************************************************************** |
| 2 | + qgsprocessingalgorithmconfig.h |
| 3 | + -------------------------- |
| 4 | + begin : April 2018 |
| 5 | + copyright : (C) 2018 by Matthias Kuhn |
| 6 | + email : matthias@opengis.ch |
| 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 | + |
1 | 19 | #ifndef QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H |
2 | 20 | #define QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H |
3 | 21 |
|
|
7 | 25 |
|
8 | 26 | #include "qgis_core.h" |
9 | 27 |
|
| 28 | +/** |
| 29 | + * A configuration widget for processing algorithms allows to provide additional |
| 30 | + * configuration options directly on algorithm level, in addition to parameters. |
| 31 | + * |
| 32 | + * \since QGIS 3.2 |
| 33 | + * \ingroup core |
| 34 | + */ |
10 | 35 | class CORE_EXPORT QgsProcessingAlgorithmConfigurationWidget : public QWidget |
11 | 36 | { |
12 | 37 | Q_OBJECT |
13 | 38 |
|
14 | 39 | public: |
| 40 | + /** |
| 41 | + * Creates a new QgsProcessingAlgorithmConfigurationWidget |
| 42 | + */ |
15 | 43 | QgsProcessingAlgorithmConfigurationWidget( QWidget *parent = nullptr ); |
16 | 44 | virtual ~QgsProcessingAlgorithmConfigurationWidget() = default; |
| 45 | + |
| 46 | + /** |
| 47 | + * Read the current configuration from this widget. |
| 48 | + */ |
17 | 49 | virtual QVariantMap configuration() const = 0; |
| 50 | + |
| 51 | + /** |
| 52 | + * Set the configuration which this widget should represent. |
| 53 | + */ |
18 | 54 | virtual void setConfiguration( const QVariantMap &configuration ) = 0; |
19 | 55 | }; |
20 | 56 |
|
|
0 commit comments