QGIS API Documentation 3.99.0-Master (f78f5286a64)
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.
 
QgsFeatureFilterProviderGroupaddProvider (const QgsFeatureFilterProvider *provider)
 Add another filter provider to the group.
 
QgsFeatureFilterProviderGroupclone () const override
 Create a clone of the feature filter provider.
 
void filterFeatures (const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures) const override
 Add additional filters to the feature request to further restrict the features returned by the request.
 
bool isFilterThreadSafe () const override
 Returns true if the filterFeature function is thread safe, which will lead to reliance on layer ID instead of the raw layer pointer.
 
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.
 
- Public Member Functions inherited from QgsFeatureFilterProvider
 QgsFeatureFilterProvider ()=default
 
virtual ~QgsFeatureFilterProvider ()=default
 
virtual void filterFeatures (const QString &layerId, QgsFeatureRequest &featureRequest) const
 Add additional filters to the feature request to further restrict the features returned by the request.
 

Detailed Description

A filter filter provider grouping several filter providers.

Deprecated:
QGIS 3.4. Use QgsGroupedFeatureFilterProvider

Definition at line 32 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 54 of file qgsfeaturefilterprovidergroup.cpp.

◆ clone()

QgsFeatureFilterProviderGroup * QgsFeatureFilterProviderGroup::clone ( ) const
overridevirtual

Create a clone of the feature filter provider.

Returns
a new clone

Implements QgsFeatureFilterProvider.

Definition at line 47 of file qgsfeaturefilterprovidergroup.cpp.

◆ filterFeatures()

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

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
Deprecated:
QGIS 4.0. Use the layer ID variant.

Reimplemented from QgsFeatureFilterProvider.

Definition at line 21 of file qgsfeaturefilterprovidergroup.cpp.

◆ isFilterThreadSafe()

bool QgsFeatureFilterProviderGroup::isFilterThreadSafe ( ) const
inlineoverridevirtual

Returns true if the filterFeature function is thread safe, which will lead to reliance on layer ID instead of the raw layer pointer.

Since
QGIS 4.0
Deprecated:
QGIS 4.0

Reimplemented from QgsFeatureFilterProvider.

Definition at line 38 of file qgsfeaturefilterprovidergroup.h.

◆ 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 36 of file qgsfeaturefilterprovidergroup.cpp.


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