QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
QgsGroupedFeatureFilterProvider Class Reference

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

#include <qgsgroupedfeaturefilterprovider.h>

Inheritance diagram for QgsGroupedFeatureFilterProvider:

Public Member Functions

 QgsGroupedFeatureFilterProvider ()=default
 Constructor.
QgsGroupedFeatureFilterProvideraddProvider (const QgsFeatureFilterProvider *provider)
 Add another filter provider to the group.
QgsGroupedFeatureFilterProviderclone () const override
 Create a clone of the feature filter provider.
Q_DECL_DEPRECATED 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.
void filterFeatures (const QString &layerId, QgsFeatureRequest &filterFeatures) const override
 Add additional filters to the feature request to further restrict the features returned by the request.
Q_DECL_DEPRECATED 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

Detailed Description

A filter filter provider grouping several filter providers.

Since
QGIS 4.0

Definition at line 32 of file qgsgroupedfeaturefilterprovider.h.

Constructor & Destructor Documentation

◆ QgsGroupedFeatureFilterProvider()

QgsGroupedFeatureFilterProvider::QgsGroupedFeatureFilterProvider ( )
default

Constructor.

Member Function Documentation

◆ addProvider()

QgsGroupedFeatureFilterProvider & QgsGroupedFeatureFilterProvider::addProvider ( const QgsFeatureFilterProvider * provider)

Add another filter provider to the group.

Parameters
providerThe provider to add
Returns
itself

Definition at line 90 of file qgsgroupedfeaturefilterprovider.cpp.

◆ clone()

QgsGroupedFeatureFilterProvider * QgsGroupedFeatureFilterProvider::clone ( ) const
overridevirtual

Create a clone of the feature filter provider.

Returns
a new clone

Implements QgsFeatureFilterProvider.

Definition at line 83 of file qgsgroupedfeaturefilterprovider.cpp.

◆ filterFeatures() [1/2]

void QgsGroupedFeatureFilterProvider::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 37 of file qgsgroupedfeaturefilterprovider.cpp.

◆ filterFeatures() [2/2]

void QgsGroupedFeatureFilterProvider::filterFeatures ( const QString & layerId,
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
layerIdthe layer ID to filter
featureRequestthe feature request to update
Since
QGIS 4.0

Reimplemented from QgsFeatureFilterProvider.

Definition at line 59 of file qgsgroupedfeaturefilterprovider.cpp.

◆ isFilterThreadSafe()

bool QgsGroupedFeatureFilterProvider::isFilterThreadSafe ( ) const
overridevirtual

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 23 of file qgsgroupedfeaturefilterprovider.cpp.

◆ layerAttributes()

QStringList QgsGroupedFeatureFilterProvider::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 72 of file qgsgroupedfeaturefilterprovider.cpp.


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