Class: QgsSymbolLayerWidget

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

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsSymbolLayerWidget.

actionEvent(self, QActionEvent)
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


New in version 3.0.

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: QgsSymbolLayer.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.

New in version 3.0.

resizeEvent(self, QResizeEvent)
sender(self) QObject
senderSignalIndex(self) int
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


New in version 3.0.

setSymbolLayer(self, layer: QgsSymbolLayer)

layer (QgsSymbolLayer) –

sharedPainter(self) QPainter
showEvent(self, QShowEvent)

Should be emitted whenever the sub symbol changed on this symbol layer configuration. Normally changed() should be preferred.

See also

changed() [signal]

symbolLayer(self) QgsSymbolLayer
Return type


tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
vectorLayer(self) QgsVectorLayer

Returns the vector layer associated with the widget.

New in version 2.12.

Return type


wheelEvent(self, QWheelEvent)