|
1 |
| -/** \ingroup core |
2 |
| - * \class QgsFeatureFilterProvider |
3 |
| - * Abstract interface for use by classes that filter the features of a layer. |
4 |
| - * A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest in place to apply |
5 |
| - * additional filters to the request. |
6 |
| - * \note added in QGIS 2.14 |
7 |
| - **/ |
| 1 | +/************************************************************************ |
| 2 | + * This file has been generated automatically from * |
| 3 | + * * |
| 4 | + * src/core/qgsfeaturefilterprovider.h * |
| 5 | + * * |
| 6 | + * Do not edit manually ! Edit header and run scripts/sipify.pl again * |
| 7 | + ************************************************************************/ |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | + |
8 | 16 | class QgsFeatureFilterProvider
|
9 | 17 | {
|
10 |
| -%TypeHeaderCode |
11 |
| -#include <qgsfeaturefilterprovider.h> |
| 18 | +%Docstring |
| 19 | + Abstract interface for use by classes that filter the features of a layer. |
| 20 | + A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest in place to apply |
| 21 | + additional filters to the request. |
| 22 | +.. versionadded:: 2.14 |
| 23 | +* |
12 | 24 | %End
|
13 | 25 |
|
| 26 | +%TypeHeaderCode |
| 27 | +#include "qgsfeaturefilterprovider.h" |
| 28 | +%End |
14 | 29 | public:
|
15 | 30 |
|
16 |
| - /** Add additional filters to the feature request to further restrict the features returned by the request. |
17 |
| - * Derived classes must implement this method. |
18 |
| - * @param layer the layer to filter |
19 |
| - * @param featureRequest the feature request to update |
20 |
| - */ |
| 31 | + |
21 | 32 | virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0;
|
| 33 | +%Docstring |
| 34 | + Add additional filters to the feature request to further restrict the features returned by the request. |
| 35 | + Derived classes must implement this method. |
| 36 | + \param layer the layer to filter |
| 37 | + \param featureRequest the feature request to update |
| 38 | +%End |
22 | 39 |
|
23 |
| - /** Create a clone of the feature filter provider |
24 |
| - * @return a new clone |
25 |
| - */ |
26 | 40 | virtual QgsFeatureFilterProvider *clone() const = 0 /Factory/;
|
| 41 | +%Docstring |
| 42 | + Create a clone of the feature filter provider |
| 43 | + :return: a new clone |
| 44 | + :rtype: QgsFeatureFilterProvider |
| 45 | +%End |
27 | 46 | };
|
| 47 | + |
| 48 | +/************************************************************************ |
| 49 | + * This file has been generated automatically from * |
| 50 | + * * |
| 51 | + * src/core/qgsfeaturefilterprovider.h * |
| 52 | + * * |
| 53 | + * Do not edit manually ! Edit header and run scripts/sipify.pl again * |
| 54 | + ************************************************************************/ |
0 commit comments