QGIS API Documentation 3.29.0-Master (da8bb1db43)
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#include "qgsfeaturerequest.h"
27
28class QString;
29class QgsVectorLayer;
30
31
43class CORE_EXPORT QgsFeatureFilterProvider
44{
45 public:
46
47#ifndef SIP_RUN
48
51
52 virtual ~QgsFeatureFilterProvider() = default;
53
54#endif
55
62 virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0;
63
68 virtual QStringList layerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const = 0;
69
75};
76
77#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 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.
virtual QgsFeatureFilterProvider * clone() const =0
Create a clone of the feature filter provider.
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