QgsAggregateToolButton class

Offers a toolbutton to choose between different aggregate functions.

Functions are filtered based on the type.

Constructors, destructors, conversion operators

QgsAggregateToolButton()
Constructor.

Public functions

auto active() const -> bool
When this flag is false, the aggregate will be deactivated.
auto aggregate() const -> QString
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(QVariant::Type type)
Based on the type of underlying data, some aggregates will be available or not.
auto type() const -> QVariant::Type
Based on the type of underlying data, some aggregates will be available or not.

Signals

void activeChanged()
A function has been selected or deselected.
void aggregateChanged()
The function name of the selected aggregate has changed.

Function documentation

bool QgsAggregateToolButton::active() const

When this flag is false, the aggregate will be deactivated.

I.e. no aggregate is chosen.

void QgsAggregateToolButton::setActive(bool active)

When this flag is false, the aggregate will be deactivated.

I.e. no aggregate is chosen.