QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Member Functions | List of all members
QgsDimensionFilter Class Reference

A server filter to apply a dimension filter to a request. More...

#include <qgsdimensionfilter.h>

Inheritance diagram for QgsDimensionFilter:
Inheritance graph
[legend]

Public Member Functions

 QgsDimensionFilter (const QHash< const QgsVectorLayer *, QStringList > dimensionFilter)
 Creates a new dimension filter object with a list of filters to be applied to vector layers. More...
 
QgsDimensionFilterclone () const override
 Create a clone of the feature filter provider. More...
 
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. 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 server filter to apply a dimension filter to a request.

Since
QGIS 3.22

Definition at line 32 of file qgsdimensionfilter.h.

Constructor & Destructor Documentation

◆ QgsDimensionFilter()

QgsDimensionFilter::QgsDimensionFilter ( const QHash< const QgsVectorLayer *, QStringList >  dimensionFilter)

Creates a new dimension filter object with a list of filters to be applied to vector layers.

Definition at line 20 of file qgsdimensionfilter.cpp.

Member Function Documentation

◆ clone()

QgsDimensionFilter * QgsDimensionFilter::clone ( ) const
overridevirtual

Create a clone of the feature filter provider.

Returns
a new clone

Implements QgsFeatureFilterProvider.

Definition at line 40 of file qgsdimensionfilter.cpp.

◆ filterFeatures()

void QgsDimensionFilter::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

Implements QgsFeatureFilterProvider.

Definition at line 26 of file qgsdimensionfilter.cpp.

◆ layerAttributes()

QStringList QgsDimensionFilter::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 qgsdimensionfilter.cpp.


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