The QgsAggregateMappingModel holds mapping information for defining sets of aggregates of fields from a QgsFields object. More...

#include <qgsprocessingaggregatewidgets.h>

Inheritance diagram for QgsAggregateMappingModel:

[legend]

Classes
struct	Aggregate
	The Aggregate struct holds information about an aggregate column. More...

Public Types
enum class	ColumnDataIndex : int { SourceExpression , Aggregate , Delimiter , DestinationName , DestinationType , DestinationLength , DestinationPrecision }
	The ColumnDataIndex enum represents the column index for the view. More...

Public Member Functions
	QgsAggregateMappingModel (const QgsFields &sourceFields=QgsFields(), QObject *parent=nullptr)
	Constructs a QgsAggregateMappingModel from a set of sourceFields.

void	appendField (const QgsField &field, const QString &source=QString(), const QString &aggregate=QString())
	Appends a new field to the model, with an optional source and aggregate.

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

QgsExpressionContextGenerator *	contextGenerator () const
	Returns the context generator with the source fields.

QVariant	data (const QModelIndex &index, int role) const override

Qt::ItemFlags	flags (const QModelIndex &index) const override

QVariant	headerData (int section, Qt::Orientation orientation, int role) const override

QList< QgsAggregateMappingModel::Aggregate >	mapping () const
	Returns a list of Aggregate objects representing the current status of the model.

bool	moveDown (const QModelIndex &index)
	Moves up the field at index.

bool	moveUp (const QModelIndex &index)
	Moves down the field at index.

	Q_ENUM (ColumnDataIndex)

bool	removeField (const QModelIndex &index)
	Removes the field at index from the model, returns `true` on success.

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

void	setBaseExpressionContextGenerator (const QgsExpressionContextGenerator *generator)
	Sets the base expression context generator, which will generate the expression contexts for expression based widgets used by the model.

bool	setData (const QModelIndex &index, const QVariant &value, int role) override

void	setMapping (const QList< QgsAggregateMappingModel::Aggregate > &mapping)
	Sets the mapping to show in the model.

void	setSourceFields (const QgsFields &sourceFields)
	Set source fields to sourceFields.

QgsFields	sourceFields () const
	Returns a list of source fields.

Detailed Description

The QgsAggregateMappingModel holds mapping information for defining sets of aggregates of fields from a QgsFields object.

Since: QGIS 3.14

Definition at line 41 of file qgsprocessingaggregatewidgets.h.

Member Enumeration Documentation

◆ ColumnDataIndex

enum class QgsAggregateMappingModel::ColumnDataIndex : int

strong

The ColumnDataIndex enum represents the column index for the view.

Enumerator
SourceExpression	Expression.
Aggregate	Aggregate name.
Delimiter	Delimiter.
DestinationName	Destination field name.
DestinationType	Destination field type string.
DestinationLength	Destination field length.
DestinationPrecision	Destination field precision.