Class: QgsSymbolsListWidget

A widget which presents symbol-level properties (such as size), and allows selection of symbols from stored styles.

QgsSymbolsListWidget

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Methods

clipFeaturesToggled
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.
setContext	Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
setLineWidth
setMarkerAngle
setMarkerSize
setSymbolColor
updateDataDefinedLineWidth
updateDataDefinedMarkerAngle
updateDataDefinedMarkerSize

Signals

changed

Emitted when the symbol is modified in the widget.

class qgis.gui.QgsSymbolsListWidget

Bases: QWidget

__init__(symbol: QgsSymbol | None, style: QgsStyle | None, menu: QMenu | None, parent: QWidget | None, layer: QgsVectorLayer | None = None)

Constructor for QgsSymbolsListWidget.

Parameters:

• symbol (Optional[QgsSymbol]) – the symbol

• style (Optional[QgsStyle]) – the style

• menu (Optional[QMenu]) – the menu where to show it

• parent (Optional[QWidget]) – parent widget

• layer (Optional[QgsVectorLayer] = None) – associated vector layer

signal changed

Emitted when the symbol is modified in the widget.

clipFeaturesToggled(self, checked: bool)

Parameters:

checked (bool)

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

layer(self) → QgsVectorLayer | None

Returns the vector layer associated with the widget.

Return type:

Optional[QgsVectorLayer]

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

setLineWidth(self, width: float)

Parameters:

width (float)

setMarkerAngle(self, angle: float)

Parameters:

angle (float)

setMarkerSize(self, size: float)

Parameters:

size (float)

setSymbolColor(self, color: QColor | Qt.GlobalColor)

Parameters:

color (Union[QColor, Qt.GlobalColor])

updateDataDefinedLineWidth(self)

updateDataDefinedMarkerAngle(self)

updateDataDefinedMarkerSize(self)