Class: QgsAggregateToolButton

class qgis.gui.QgsAggregateToolButton

Bases: PyQt5.QtWidgets.QToolButton

Offers a toolbutton to choose between different aggregate functions. Functions are filtered based on the type.

New in version 3.0.

QgsAggregateToolButton() Constructor

Methods

actionEvent
active	When this flag is False, the aggregate will be deactivated.
aggregate	The function name of the selected aggregate or a Null String if none is chosen.
changeEvent
checkStateSet
childEvent
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
hitButton
initPainter
initStyleOption
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
nextCheckState
paintEvent
receivers
resizeEvent
sender
senderSignalIndex
setActive	When this flag is False, the aggregate will be deactivated.
setAggregate	The function name of the selected aggregate or a Null String if none is chosen.
setType	Based on the type of underlying data, some aggregates will be available or not.
sharedPainter
showEvent
tabletEvent
timerEvent
type	Based on the type of underlying data, some aggregates will be available or not.
updateMicroFocus
wheelEvent

Signals

activeChanged	pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
aggregateChanged	pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

actionEvent(self, QActionEvent)

active(self) → bool

When this flag is False, the aggregate will be deactivated. I.e. no aggregate is chosen.

Return type

bool

activeChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters

• name (str = ...) –

• revision (int = ...) –

• arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

aggregate(self) → str

The function name of the selected aggregate or a Null String if none is chosen.

Return type

str

aggregateChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters

• name (str = ...) –

• revision (int = ...) –

• arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

changeEvent(self, QEvent)

checkStateSet(self)

childEvent(self, QChildEvent)

closeEvent(self, QCloseEvent)

connectNotify(self, QMetaMethod)

contextMenuEvent(self, QContextMenuEvent)

create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)

customEvent(self, QEvent)

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

enterEvent(self, QEvent)

event(self, QEvent) → bool

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPreviousChild(self) → bool

hideEvent(self, QHideEvent)

hitButton(self, QPoint) → bool

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionToolButton)

inputMethodEvent(self, QInputMethodEvent)

isSignalConnected(self, QMetaMethod) → bool

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

leaveEvent(self, QEvent)

metric(self, QPaintDevice.PaintDeviceMetric) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

moveEvent(self, QMoveEvent)

nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) → Tuple[bool, int]

nextCheckState(self)

paintEvent(self, QPaintEvent)

receivers(self, PYQT_SIGNAL) → int

resizeEvent(self, QResizeEvent)

sender(self) → QObject

senderSignalIndex(self) → int

setActive(self, active: bool)

When this flag is False, the aggregate will be deactivated. I.e. no aggregate is chosen.

Parameters

active (bool) –

setAggregate(self, aggregate: str)

The function name of the selected aggregate or a Null String if none is chosen.

Parameters

aggregate (str) –

setType(self, type: QVariant.Type)

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

Parameters

type (QVariant.Type) –

sharedPainter(self) → QPainter

showEvent(self, QShowEvent)

tabletEvent(self, QTabletEvent)

timerEvent(self, QTimerEvent)

type(self) → QVariant.Type

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

Return type

QVariant.Type

updateMicroFocus(self)

wheelEvent(self, QWheelEvent)