QGIS API Documentation  3.17.0-Master (a84647cf30)
Classes | Public Slots | Signals | Public Member Functions | List of all members
QgsAggregateMappingWidget Class Reference

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:
Inheritance graph
[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. More...
 
bool moveSelectedFieldsDown ()
 Moves down currently selected field. More...
 
bool moveSelectedFieldsUp ()
 Moves up currently selected field. More...
 
bool removeSelectedFields ()
 Removes the currently selected field from the model. More...
 
- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
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. More...
 

Signals

void changed ()
 Emitted when the aggregates defined in the widget are changed. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Public Member Functions

 QgsAggregateMappingWidget (QWidget *parent=nullptr, const QgsFields &sourceFields=QgsFields())
 Constructs a QgsAggregateMappingWidget from a set of sourceFields. More...
 
QList< QgsAggregateMappingModel::Aggregatemapping () const
 Returns a list of Aggregate objects representing the current status of the underlying mapping model. More...
 
QgsAggregateMappingModelmodel () const
 Returns the underlying mapping model. More...
 
void registerExpressionContextGenerator (const QgsExpressionContextGenerator *generator)
 Register an expression context generator class that will be used to retrieve an expression context for the widget. More...
 
void scrollTo (const QModelIndex &index) const
 Scroll the fields view to index. More...
 
QItemSelectionModel * selectionModel ()
 Returns the selection model. More...
 
void setMapping (const QList< QgsAggregateMappingModel::Aggregate > &mapping)
 Sets the mapping to show in the model. More...
 
void setSourceFields (const QgsFields &sourceFields)
 Set source fields of the underlying mapping model to sourceFields. More...
 
void setSourceLayer (QgsVectorLayer *layer)
 Sets a source layer to use when generating expression previews in the widget. More...
 
QgsVectorLayersourceLayer ()
 Returns the source layer for use when generating expression previews. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
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. More...
 
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. More...
 
bool dockMode ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

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 350 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 420 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 380 of file qgsprocessingaggregatewidgets.cpp.

◆ model()

QgsAggregateMappingModel * QgsAggregateMappingWidget::model ( ) const

Returns the underlying mapping model.

Definition at line 375 of file qgsprocessingaggregatewidgets.cpp.

◆ moveSelectedFieldsDown

bool QgsAggregateMappingWidget::moveSelectedFieldsDown ( )
slot

Moves down currently selected field.

Definition at line 458 of file qgsprocessingaggregatewidgets.cpp.

◆ moveSelectedFieldsUp

bool QgsAggregateMappingWidget::moveSelectedFieldsUp ( )
slot

Moves up currently selected field.

Definition at line 442 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 415 of file qgsprocessingaggregatewidgets.cpp.

◆ removeSelectedFields

bool QgsAggregateMappingWidget::removeSelectedFields ( )
slot

Removes the currently selected field from the model.

Definition at line 425 of file qgsprocessingaggregatewidgets.cpp.

◆ scrollTo()

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

Scroll the fields view to index.

Definition at line 410 of file qgsprocessingaggregatewidgets.cpp.

◆ selectionModel()

QItemSelectionModel * QgsAggregateMappingWidget::selectionModel ( )

Returns the selection model.

Definition at line 390 of file qgsprocessingaggregatewidgets.cpp.

◆ setMapping()

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

Sets the mapping to show in the model.

Definition at line 385 of file qgsprocessingaggregatewidgets.cpp.

◆ setSourceFields()

void QgsAggregateMappingWidget::setSourceFields ( const QgsFields sourceFields)

Set source fields of the underlying mapping model to sourceFields.

Definition at line 395 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 400 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 405 of file qgsprocessingaggregatewidgets.cpp.


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