QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | List of all members
QgsFeatureFilterProviderGroup Class Reference

A filter filter provider grouping several filter providers. More...

#include <qgsfeaturefilterprovidergroup.h>

Inheritance diagram for QgsFeatureFilterProviderGroup:
Inheritance graph
[legend]

Public Member Functions

 QgsFeatureFilterProviderGroup ()=default
 Constructor. More...
 
QgsFeatureFilterProviderGroupaddProvider (const QgsFeatureFilterProvider *provider)
 Add another filter provider to the group. More...
 
QgsFeatureFilterProviderclone () 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...
 
- Public Member Functions inherited from QgsFeatureFilterProvider
 QgsFeatureFilterProvider ()=default
 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...
 
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 filter filter provider grouping several filter providers.

Definition at line 31 of file qgsfeaturefilterprovidergroup.h.

Constructor & Destructor Documentation

◆ QgsFeatureFilterProviderGroup()

QgsFeatureFilterProviderGroup::QgsFeatureFilterProviderGroup ( )
default

Constructor.

Member Function Documentation

◆ addProvider()

QgsFeatureFilterProviderGroup & QgsFeatureFilterProviderGroup::addProvider ( const QgsFeatureFilterProvider provider)

Add another filter provider to the group.

Parameters
providerThe provider to add
Returns
itself

Definition at line 52 of file qgsfeaturefilterprovidergroup.cpp.

◆ clone()

QgsFeatureFilterProvider * QgsFeatureFilterProviderGroup::clone ( ) const
overridevirtual

Returns a clone of the object.

Returns
A clone

Implements QgsFeatureFilterProvider.

Definition at line 45 of file qgsfeaturefilterprovidergroup.cpp.

◆ filterFeatures()

void QgsFeatureFilterProviderGroup::filterFeatures ( const QgsVectorLayer layer,
QgsFeatureRequest filterFeatures 
) const
overridevirtual

Filter the features of the layer.

Parameters
layerthe layer to control
filterFeaturesthe request to fill

Implements QgsFeatureFilterProvider.

Definition at line 21 of file qgsfeaturefilterprovidergroup.cpp.

◆ layerAttributes()

QStringList QgsFeatureFilterProviderGroup::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 34 of file qgsfeaturefilterprovidergroup.cpp.


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