The QgsAggregateMappingWidget class creates a mapping for defining sets of aggregates of fields from a QgsFields object. More...

#include <qgsprocessingaggregatewidgets.h>

Inheritance diagram for QgsAggregateMappingWidget:

[legend]

Public Slots
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.

bool	moveSelectedFieldsDown ()
	Moves down currently selected field.

bool	moveSelectedFieldsUp ()
	Moves up currently selected field.

bool	removeSelectedFields ()
	Removes the currently selected field from the model.

Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.

void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is `true` this method will emit the showPanel signal for connected slots to handle the open event.

Signals
void	changed ()
	Emitted when the aggregates defined in the widget are changed.

Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.

void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.

void	widgetChanged ()
	Emitted when the widget state changes.

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

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

QgsAggregateMappingModel *	model () const
	Returns the underlying mapping model.

void	registerExpressionContextGenerator (const QgsExpressionContextGenerator *generator)
	Register an expression context generator class that will be used to retrieve an expression context for the widget.

void	scrollTo (const QModelIndex &index) const
	Scroll the fields view to index.

QItemSelectionModel *	selectionModel ()
	Returns the selection model.

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

void	setSourceFields (const QgsFields &sourceFields)
	Set source fields of the underlying mapping model to sourceFields.

void	setSourceLayer (QgsVectorLayer *layer)
	Sets a source layer to use when generating expression previews in the widget.

QgsVectorLayer *	sourceLayer ()
	Returns the source layer for use when generating expression previews.

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel.

virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.

bool	autoDelete ()
	The the auto delete property on the widget.

void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

bool	dockMode ()
	Returns the dock mode state.

virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required.

virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.

QString	panelTitle ()
	The title of the panel.

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.

virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Additional Inherited Members
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

The QgsAggregateMappingWidget class creates a mapping for defining sets of aggregates of fields from a QgsFields object.

Since: QGIS 3.14

Definition at line 149 of file qgsprocessingaggregatewidgets.h.

Constructor & Destructor Documentation

◆ QgsAggregateMappingWidget()

QgsAggregateMappingWidget::QgsAggregateMappingWidget	(	QWidget *	parent = `nullptr`,
		const QgsFields &	sourceFields = `QgsFields()`
	)

explicit

Constructs a QgsAggregateMappingWidget from a set of sourceFields.

A parent object can also be specified.

Definition at line 353 of file qgsprocessingaggregatewidgets.cpp.

Member Function Documentation

◆ appendField

void QgsAggregateMappingWidget::appendField	(	const QgsField &	field,
		const QString &	source = `QString()`,
		const QString &	aggregate = `QString()`
	)

slot

Appends a new field to the model, with an optional source and aggregate.

Definition at line 423 of file qgsprocessingaggregatewidgets.cpp.

◆ changed

void QgsAggregateMappingWidget::changed ( )

signal

Emitted when the aggregates defined in the widget are changed.

◆ mapping()

QList< QgsAggregateMappingModel::Aggregate > QgsAggregateMappingWidget::mapping ( ) const

Returns a list of Aggregate objects representing the current status of the underlying mapping model.

Definition at line 383 of file qgsprocessingaggregatewidgets.cpp.

◆ model()

QgsAggregateMappingModel * QgsAggregateMappingWidget::model ( ) const

Returns the underlying mapping model.

Definition at line 378 of file qgsprocessingaggregatewidgets.cpp.

◆ moveSelectedFieldsDown

bool QgsAggregateMappingWidget::moveSelectedFieldsDown ( )

slot

Moves down currently selected field.

Definition at line 461 of file qgsprocessingaggregatewidgets.cpp.

◆ moveSelectedFieldsUp

bool QgsAggregateMappingWidget::moveSelectedFieldsUp ( )

slot

Moves up currently selected field.

Definition at line 445 of file qgsprocessingaggregatewidgets.cpp.

◆ registerExpressionContextGenerator()

void QgsAggregateMappingWidget::registerExpressionContextGenerator ( const QgsExpressionContextGenerator * generator )

Register an expression context generator class that will be used to retrieve an expression context for the widget.

Definition at line 418 of file qgsprocessingaggregatewidgets.cpp.

◆ removeSelectedFields

bool QgsAggregateMappingWidget::removeSelectedFields ( )

slot

Removes the currently selected field from the model.

Definition at line 428 of file qgsprocessingaggregatewidgets.cpp.

◆ scrollTo()

void QgsAggregateMappingWidget::scrollTo ( const QModelIndex & index ) const

Scroll the fields view to index.

Definition at line 413 of file qgsprocessingaggregatewidgets.cpp.

◆ selectionModel()

QItemSelectionModel * QgsAggregateMappingWidget::selectionModel ( )

Returns the selection model.

Definition at line 393 of file qgsprocessingaggregatewidgets.cpp.

◆ setMapping()

void QgsAggregateMappingWidget::setMapping ( const QList< QgsAggregateMappingModel::Aggregate > & mapping )

Sets the mapping to show in the model.

Definition at line 388 of file qgsprocessingaggregatewidgets.cpp.

◆ setSourceFields()

void QgsAggregateMappingWidget::setSourceFields ( const QgsFields & sourceFields )

Set source fields of the underlying mapping model to sourceFields.

Definition at line 398 of file qgsprocessingaggregatewidgets.cpp.

◆ setSourceLayer()

void QgsAggregateMappingWidget::setSourceLayer ( QgsVectorLayer * layer )

Sets a source layer to use when generating expression previews in the widget.

Since: QGIS 3.16

Definition at line 403 of file qgsprocessingaggregatewidgets.cpp.

◆ sourceLayer()

QgsVectorLayer * QgsAggregateMappingWidget::sourceLayer ( )

Returns the source layer for use when generating expression previews.

Returned value may be nullptr.

Since: QGIS 3.16

Definition at line 408 of file qgsprocessingaggregatewidgets.cpp.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/processing/qgsprocessingaggregatewidgets.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/processing/qgsprocessingaggregatewidgets.cpp

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsAggregateMappingWidget()

Member Function Documentation

◆ appendField

◆ changed

◆ mapping()

◆ model()

◆ moveSelectedFieldsDown

◆ moveSelectedFieldsUp

◆ registerExpressionContextGenerator()

◆ removeSelectedFields

◆ scrollTo()

◆ selectionModel()

◆ setMapping()

◆ setSourceFields()

◆ setSourceLayer()

◆ sourceLayer()