QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Signals | Public Member Functions | List of all members
QgsAggregateToolButton Class Reference

Offers a toolbutton to choose between different aggregate functions. More...

#include <qgsaggregatetoolbutton.h>

Inheritance diagram for QgsAggregateToolButton:
Inheritance graph
[legend]

Signals

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

Public Member Functions

 QgsAggregateToolButton ()
 Constructor. More...
 
bool active () const
 When this flag is false, the aggregate will be deactivated. More...
 
QString aggregate () const
 The function name of the selected aggregate or a Null String if none is chosen. More...
 
void setActive (bool active)
 When this flag is false, the aggregate will be deactivated. More...
 
void setAggregate (const QString &aggregate)
 The function name of the selected aggregate or a Null String if none is chosen. More...
 
void setType (QVariant::Type type)
 Based on the type of underlying data, some aggregates will be available or not. More...
 
QVariant::Type type () const
 Based on the type of underlying data, some aggregates will be available or not. More...
 

Detailed Description

Offers a toolbutton to choose between different aggregate functions.

Functions are filtered based on the type.

Since
QGIS 3.0

Definition at line 33 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 116 of file qgsaggregatetoolbutton.cpp.

◆ activeChanged

void QgsAggregateToolButton::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 89 of file qgsaggregatetoolbutton.cpp.

◆ aggregateChanged

void QgsAggregateToolButton::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 77 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 94 of file qgsaggregatetoolbutton.cpp.

◆ setType()

void QgsAggregateToolButton::setType ( QVariant::Type  type)

Based on the type of underlying data, some aggregates will be available or not.

Definition at line 34 of file qgsaggregatetoolbutton.cpp.

◆ type()

QVariant::Type QgsAggregateToolButton::type ( ) const

Based on the type of underlying data, some aggregates will be available or not.

Definition at line 121 of file qgsaggregatetoolbutton.cpp.


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