Class FeatureExpressionValuesGatherer

ClassList > FeatureExpressionValuesGatherer

#include <featureexpressionvaluesgatherer.h>

Inherits the following classes: QThread

Classes

Type	Name
struct	Entry

Public Functions

Type	Name
	FeatureExpressionValuesGatherer (QgsVectorLayer * layer, const QString & displayExpression=QString(), const QgsFeatureRequest & request=QgsFeatureRequest(), const QStringList & identifierFields=QStringList())
QVariant	data () const
QVector< Entry >	entries () const
QgsFeatureRequest	request () const
void	run () override
void	setData (const QVariant & data)
void	stop () Informs the gatherer to immediately stop collecting values.
bool	wasCanceled () const Returns TRUE if collection was canceled before completion.

Public Static Functions

Type	Name
Entry	nullEntry (QgsVectorLayer * layer)

Protected Attributes

Type	Name
QVector< Entry >	mEntries

Detailed Description

Gathers features with substring matching on an expression.

Note:

This is a is an exact copy of QGIS' QgsFeatureExpressionValuesGatherer

Public Functions Documentation

function FeatureExpressionValuesGatherer

inline explicit FeatureExpressionValuesGatherer::FeatureExpressionValuesGatherer (
    QgsVectorLayer * layer,
    const QString & displayExpression=QString(),
    const QgsFeatureRequest & request=QgsFeatureRequest(),
    const QStringList & identifierFields=QStringList()
)

Constructor

Parameters:

layer the vector layer
displayExpression if empty, the display expression is taken from the layer definition
request the request to perform
identifierFields an optional list of fields name to be save in a variant list for an easier reuse

function data

inline QVariant FeatureExpressionValuesGatherer::data () const

Internal data, use for whatever you want.

function entries

inline QVector< Entry > FeatureExpressionValuesGatherer::entries () const

function request

inline QgsFeatureRequest FeatureExpressionValuesGatherer::request () const

function run

inline void FeatureExpressionValuesGatherer::run () override

function setData

inline void FeatureExpressionValuesGatherer::setData (
    const QVariant & data
)

Internal data, use for whatever you want.

function stop

Informs the gatherer to immediately stop collecting values.

inline void FeatureExpressionValuesGatherer::stop ()

function wasCanceled

Returns TRUE if collection was canceled before completion.

inline bool FeatureExpressionValuesGatherer::wasCanceled () const

Public Static Functions Documentation

function nullEntry

static inline Entry FeatureExpressionValuesGatherer::nullEntry (
    QgsVectorLayer * layer
)

Protected Attributes Documentation

variable mEntries

QVector<Entry> FeatureExpressionValuesGatherer::mEntries;

The documentation for this class was generated from the following file src/core/featureexpressionvaluesgatherer.h