Class: QgsCalloutWidget

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

Added in version 3.10.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: callout(), setCallout(), setGeometryType()

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Abstract Methods

callout	Returns the callout defined by the current settings in the widget.
setCallout	Sets the callout to show in the widget.
setGeometryType	Sets the geometry type of the features to customize the widget accordingly.

Methods

context	Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
layer	Returns the vector layer associated with the widget.
registerDataDefinedButton	Registers a data defined override button.
vectorLayer	Returns the vector layer associated with the widget.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsCalloutWidget. See the FAQ for more details.

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

Signals

changed

Should be emitted whenever configuration changes happened on this symbol layer configuration.

class qgis.gui.QgsCalloutWidget

Bases: QWidget

__init__(parent: QWidget | None, vl: QgsMapLayer | None = None)

Constructor for QgsCalloutWidget.

Parameters:

• vl (Optional[QgsMapLayer] = None) – associated map layer

• parent (Optional[QWidget]) – parent widget

abstract callout(self) → QgsCallout | None

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

setCallout()

Return type:

Optional[QgsCallout]

signal changed

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

context(self) → QgsSymbolWidgetContext

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

See also

setContext()

Return type:

QgsSymbolWidgetContext

virtual createExpressionContext(self) → QgsExpressionContext

Return type:

QgsExpressionContext

layer(self) → QgsMapLayer | None

Returns the vector layer associated with the widget.

Added in version 3.40.

Return type:

Optional[QgsMapLayer]

registerDataDefinedButton(self, button: QgsPropertyOverrideButton | None, 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.

Parameters:

• button (Optional[QgsPropertyOverrideButton])

• key (QgsCallout.Property)

abstract setCallout(self, callout: QgsCallout | None)

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

See also

callout()

Parameters:

callout (Optional[QgsCallout])

virtual setContext(self, context: QgsSymbolWidgetContext)

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

Parameters:

context (QgsSymbolWidgetContext) – symbol widget context

See also

context()

abstract setGeometryType(self, type: Qgis.GeometryType)

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

Parameters:

type (Qgis.GeometryType)

vectorLayer(self) → QgsVectorLayer | None

Returns the vector layer associated with the widget.

Deprecated since version 3.40: Use layer() instead.

Return type:

Optional[QgsVectorLayer]