Offers a toolbutton to choose between different aggregate functions. More...
#include <qgsaggregatetoolbutton.h>
Signals | |
| void | activeChanged () |
| A function has been selected or deselected. | |
| void | aggregateChanged () |
| The function name of the selected aggregate has changed. | |
Public Member Functions | |
| QgsAggregateToolButton () | |
| Constructor. | |
| bool | active () const |
When this flag is false, the aggregate will be deactivated. | |
| QString | aggregate () const |
| The function name of the selected aggregate or a Null String if none is chosen. | |
| void | setActive (bool active) |
When this flag is false, the aggregate will be deactivated. | |
| void | setAggregate (const QString &aggregate) |
| The function name of the selected aggregate or a Null String if none is chosen. | |
| void | setType (QMetaType::Type type) |
| Based on the type of underlying data, some aggregates will be available or not. | |
| Q_DECL_DEPRECATED void | setType (QVariant::Type type) |
| Based on the type of underlying data, some aggregates will be available or not. | |
| QMetaType::Type | type () const |
| Based on the type of underlying data, some aggregates will be available or not. | |
Detailed Description
Offers a toolbutton to choose between different aggregate functions.
Functions are filtered based on the type.
Definition at line 32 of file qgsaggregatetoolbutton.h.
Constructor & Destructor Documentation
◆ QgsAggregateToolButton()
| QgsAggregateToolButton::QgsAggregateToolButton | ( | ) |
Constructor.
Definition at line 22 of file qgsaggregatetoolbutton.cpp.
Member Function Documentation
◆ active()
| bool QgsAggregateToolButton::active | ( | ) | const |
When this flag is false, the aggregate will be deactivated.
I.e. no aggregate is chosen.
Definition at line 121 of file qgsaggregatetoolbutton.cpp.
◆ activeChanged
|
signal |
A function has been selected or deselected.
◆ aggregate()
| QString QgsAggregateToolButton::aggregate | ( | ) | const |
The function name of the selected aggregate or a Null String if none is chosen.
Definition at line 94 of file qgsaggregatetoolbutton.cpp.
◆ aggregateChanged
|
signal |
The function name of the selected aggregate has changed.
◆ setActive()
| void QgsAggregateToolButton::setActive | ( | bool | active | ) |
When this flag is false, the aggregate will be deactivated.
I.e. no aggregate is chosen.
Definition at line 82 of file qgsaggregatetoolbutton.cpp.
◆ setAggregate()
| void QgsAggregateToolButton::setAggregate | ( | const QString & | aggregate | ) |
The function name of the selected aggregate or a Null String if none is chosen.
Definition at line 99 of file qgsaggregatetoolbutton.cpp.
◆ setType() [1/2]
| void QgsAggregateToolButton::setType | ( | QMetaType::Type | type | ) |
Based on the type of underlying data, some aggregates will be available or not.
Definition at line 34 of file qgsaggregatetoolbutton.cpp.
◆ setType() [2/2]
| void QgsAggregateToolButton::setType | ( | QVariant::Type | type | ) |
Based on the type of underlying data, some aggregates will be available or not.
- Deprecated:
- since QGIS 3.38, use the method with a QMetaType::Type argument instead
Definition at line 43 of file qgsaggregatetoolbutton.cpp.
◆ type()
| QMetaType::Type QgsAggregateToolButton::type | ( | ) | const |
Based on the type of underlying data, some aggregates will be available or not.
Definition at line 126 of file qgsaggregatetoolbutton.cpp.
The documentation for this class was generated from the following files:
- /home/fischer/src/qgis-3.38/src/gui/qgsaggregatetoolbutton.h
- /home/fischer/src/qgis-3.38/src/gui/qgsaggregatetoolbutton.cpp
