Class: QgsCalloutWidget

class qgis.gui.QgsCalloutWidget(parent: QWidget, vl: QgsVectorLayer = None)

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsCalloutWidget.

Parameters
  • vl (QgsVectorLayer = None) – associated vector layer

  • parent (QWidget) – parent widget

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

Methods

actionEvent

callout

Returns the callout defined by the current settings in the widget.

changeEvent

childEvent

closeEvent

connectNotify

context

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

contextMenuEvent

create

createExpressionContext

rtype

QgsExpressionContext

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

receivers

registerDataDefinedButton

Registers a data defined override button.

resizeEvent

sender

senderSignalIndex

setCallout

Sets the callout to show in the widget.

setContext

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

setGeometryType

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

sharedPainter

showEvent

tabletEvent

timerEvent

updateMicroFocus

vectorLayer

Returns the vector layer associated with the widget.

wheelEvent

Signals

changed

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

actionEvent()
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

setCallout()

Return type

QgsCallout

changeEvent()
changed

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

childEvent()
closeEvent()
connectNotify()
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

contextMenuEvent()
create()
createExpressionContext(self) → QgsExpressionContext
Return type

QgsExpressionContext

customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
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.

Parameters
resizeEvent()
sender()
senderSignalIndex()
setCallout(self, callout: QgsCallout)

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

See also

callout()

Parameters

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.

Parameters

context (QgsSymbolWidgetContext) – symbol widget context

See also

context()

setGeometryType(self, type: QgsWkbTypes.GeometryType)

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

Parameters

type (QgsWkbTypes.GeometryType) –

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
vectorLayer(self) → QgsVectorLayer

Returns the vector layer associated with the widget.

Return type

QgsVectorLayer

wheelEvent()