QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
qgsfeaturefilterprovider.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsfeaturefilterprovider.h
3  --------------------------
4  begin : 22-05-2015
5  copyright : (C) 2008 by Stéphane Brunner
6  email : stephane dot brunner at camptocamp dot com
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 #ifndef QGSFEATUREFILTERPROVIDER_H
19 #define QGSFEATUREFILTERPROVIDER_H
20 
21 #include <QtGlobal>
22 #include <QStringList>
23 #include "qgis_sip.h"
24 
25 #include "qgis_core.h"
26 
27 class QString;
28 class QgsVectorLayer;
29 class QgsFeatureRequest;
30 
41 class CORE_EXPORT QgsFeatureFilterProvider
42 {
43  public:
44 
45 #ifndef SIP_RUN
46 
49 
50  virtual ~QgsFeatureFilterProvider() = default;
51 
52 #endif
53 
60  virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0;
61 
66  virtual QStringList layerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const = 0;
67 
73 };
74 
75 #endif
Abstract interface for use by classes that filter the features or attributes of a layer.
virtual void filterFeatures(const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest) const =0
Add additional filters to the feature request to further restrict the features returned by the reques...
virtual ~QgsFeatureFilterProvider()=default
virtual QgsFeatureFilterProvider * clone() const =0
Create a clone of the feature filter provider.
virtual QStringList layerAttributes(const QgsVectorLayer *layer, const QStringList &attributes) const =0
Returns the list of visible attribute names from a list of attributes names for the given layer.
QgsFeatureFilterProvider()=default
Constructor.
This class wraps a request for features to a vector layer (or directly its vector data provider).
Represents a vector layer which manages a vector based data sets.
#define SIP_FACTORY
Definition: qgis_sip.h:76