Skip to content

Commit 3a5e96a

Browse files
committed
Doxygen and license headers
1 parent 147f6e7 commit 3a5e96a

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

src/core/processing/qgsprocessingalgorithmconfigurationwidget.cpp

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
/***************************************************************************
2+
qgsprocessingalgorithmconfig.cpp
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+
118
#include "qgsprocessingalgorithmconfigurationwidget.h"
219

320
QgsProcessingAlgorithmConfigurationWidget::QgsProcessingAlgorithmConfigurationWidget( QWidget *parent )

src/core/processing/qgsprocessingalgorithmconfigurationwidget.h

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
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+
119
#ifndef QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H
220
#define QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H
321

@@ -7,14 +25,32 @@
725

826
#include "qgis_core.h"
927

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+
*/
1035
class CORE_EXPORT QgsProcessingAlgorithmConfigurationWidget : public QWidget
1136
{
1237
Q_OBJECT
1338

1439
public:
40+
/**
41+
* Creates a new QgsProcessingAlgorithmConfigurationWidget
42+
*/
1543
QgsProcessingAlgorithmConfigurationWidget( QWidget *parent = nullptr );
1644
virtual ~QgsProcessingAlgorithmConfigurationWidget() = default;
45+
46+
/**
47+
* Read the current configuration from this widget.
48+
*/
1749
virtual QVariantMap configuration() const = 0;
50+
51+
/**
52+
* Set the configuration which this widget should represent.
53+
*/
1854
virtual void setConfiguration( const QVariantMap &configuration ) = 0;
1955
};
2056

0 commit comments

Comments
 (0)