QGIS API Documentation  2.99.0-Master (314842d)
Public Member Functions | List of all members
QgsFeatureFilterProvider Class Referenceabstract

Abstract interface for use by classes that filter the features of a layer. More...

#include <qgsfeaturefilterprovider.h>

Public Member Functions

 QgsFeatureFilterProvider ()
 Constructor. More...
 
virtual ~QgsFeatureFilterProvider ()=default
 
virtual QgsFeatureFilterProviderclone () const =0
 Create a clone of the feature filter provider. More...
 
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 request. More...
 

Detailed Description

Abstract interface for use by classes that filter the features of a layer.

A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest in place to apply additional filters to the request.

Note
added in QGIS 2.14

Definition at line 38 of file qgsfeaturefilterprovider.h.

Constructor & Destructor Documentation

◆ QgsFeatureFilterProvider()

QgsFeatureFilterProvider::QgsFeatureFilterProvider ( )
inline

Constructor.

Definition at line 43 of file qgsfeaturefilterprovider.h.

◆ ~QgsFeatureFilterProvider()

virtual QgsFeatureFilterProvider::~QgsFeatureFilterProvider ( )
virtualdefault

Member Function Documentation

◆ clone()

virtual QgsFeatureFilterProvider* QgsFeatureFilterProvider::clone ( ) const
pure virtual

Create a clone of the feature filter provider.

Returns
a new clone

◆ filterFeatures()

virtual void QgsFeatureFilterProvider::filterFeatures ( const QgsVectorLayer layer,
QgsFeatureRequest featureRequest 
) const
pure virtual

Add additional filters to the feature request to further restrict the features returned by the request.

Derived classes must implement this method.

Parameters
layerthe layer to filter
featureRequestthe feature request to update

The documentation for this class was generated from the following file: