Class: QgsCalloutWidget

class qgis.gui.QgsCalloutWidget

Bases: PyQt5.QtWidgets.QWidget

Base class for widgets which allow control over the properties of callouts.

New in version 3.10.

QgsCalloutWidget(parent: QWidget, vl: QgsVectorLayer = None) Constructor for QgsCalloutWidget.

actionEvent(self, QActionEvent)
callout(self) QgsCallout

Returns the callout defined by the current settings in the widget. Ownership is not transferred, and the caller should clone the returned value.

See also


Return type


changeEvent(self, QEvent)

Should be emitted whenever configuration changes happened on this symbol layer configuration. If the subsymbol is changed, symbolChanged() should be emitted instead. [signal]

childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
context(self) QgsSymbolWidgetContext

Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

See also


Return type


contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createExpressionContext(self) QgsExpressionContext
Return type


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)
initPainter(self, QPainter)
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], sip.voidptr) Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) int
registerDataDefinedButton(self, button: QgsPropertyOverrideButton, key: QgsCallout.Property)

Registers a data defined override button. Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.

resizeEvent(self, QResizeEvent)
sender(self) QObject
senderSignalIndex(self) int
setCallout(self, callout: QgsCallout)

Sets the callout to show in the widget. Ownership is not transferred.

See also



callout (QgsCallout) –

setContext(self, context: QgsSymbolWidgetContext)

Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.


context (QgsSymbolWidgetContext) – symbol widget context

See also


setGeometryType(self, type: QgsWkbTypes.GeometryType)

Sets the geometry type of the features to customize the widget accordingly.


type (QgsWkbTypes.GeometryType) –

sharedPainter(self) QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
vectorLayer(self) QgsVectorLayer

Returns the vector layer associated with the widget.

Return type


wheelEvent(self, QWheelEvent)