QgsFeatureFilter Class Reference

A feature filter provider allowing to set filter expressions on a per-layer basis. More...

#include <qgsfeaturefilter.h>

Inheritance diagram for QgsFeatureFilter:

Public Member Functions
	QgsFeatureFilter ()=default
	Constructor. More...
QgsFeatureFilterProvider *	clone () const override
	Returns a clone of the object. More...
void	filterFeatures (const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures) const override
	Filter the features of the layer. More...
QStringList	layerAttributes (const QgsVectorLayer *layer, const QStringList &attributes) const override
	Returns the list of visible attribute names from a list of attributes names for the given layer. More...
void	setFilter (const QgsVectorLayer *layer, const QgsExpression &expression)
	Set a filter for the given layer. More...
Public Member Functions inherited from QgsFeatureFilterProvider
	QgsFeatureFilterProvider ()=default
	Constructor. More...
virtual	~QgsFeatureFilterProvider ()=default
virtual QgsFeatureFilterProvider *	clone () 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...
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. More...

Detailed Description

A feature filter provider allowing to set filter expressions on a per-layer basis.

Since

QGIS 3.0

Definition at line 34 of file qgsfeaturefilter.h.

Constructor & Destructor Documentation

QgsFeatureFilter()

QgsFeatureFilter::QgsFeatureFilter ( )

default

Constructor.

Member Function Documentation

clone()

QgsFeatureFilterProvider * QgsFeatureFilter::clone ( ) const

overridevirtual

Returns a clone of the object.

Returns

A clone

Implements QgsFeatureFilterProvider.

Definition at line 38 of file qgsfeaturefilter.cpp.

filterFeatures()

void QgsFeatureFilter::filterFeatures ( const QgsVectorLayer *  layer, QgsFeatureRequest &  filterFeatures  ) const

overridevirtual

Filter the features of the layer.

Parameters

layer	the layer to control
filterFeatures	the request to fill

Implements QgsFeatureFilterProvider.

Definition at line 23 of file qgsfeaturefilter.cpp.

layerAttributes()

QStringList QgsFeatureFilter::layerAttributes ( const QgsVectorLayer *  layer, const QStringList &  attributes  ) const

overridevirtual

Returns the list of visible attribute names from a list of attributes names for the given layer.

Since

QGIS 3.18

Implements QgsFeatureFilterProvider.

Definition at line 32 of file qgsfeaturefilter.cpp.

setFilter()

void QgsFeatureFilter::setFilter	(	const QgsVectorLayer *	layer,
		const QgsExpression &	expression
	)

Set a filter for the given layer.

Parameters

layer	the layer to filter
expression	the filter expression

Definition at line 45 of file qgsfeaturefilter.cpp.

---

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

• /build/qgis-3.32.0+99sid/src/server/qgsfeaturefilter.h
• /build/qgis-3.32.0+99sid/src/server/qgsfeaturefilter.cpp