Class: QgsSymbolsListWidget

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

QgsSymbolsListWidget

QgsSymbolsListWidget

Class Hierarchy

Inheritance diagram of qgis.gui.QgsSymbolsListWidget

Base classes

QWidget

QObject

QPaintDevice

class qgis.gui.QgsSymbolsListWidget[source]

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[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

clipFeaturesToggled(self, checked: bool)[source]
Parameters:

checked (bool)

context(self) QgsSymbolWidgetContext[source]

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[source]

Returns the vector layer associated with the widget.

Return type:

Optional[QgsVectorLayer]

setContext(self, context: QgsSymbolWidgetContext)[source]

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)[source]
Parameters:

width (float)

setMarkerAngle(self, angle: float)[source]
Parameters:

angle (float)

setMarkerSize(self, size: float)[source]
Parameters:

size (float)

setSymbolColor(self, color: QColor | Qt.GlobalColor)[source]
Parameters:

color (Union[QColor, Qt.GlobalColor])

updateDataDefinedLineWidth(self)[source]
updateDataDefinedMarkerAngle(self)[source]
updateDataDefinedMarkerSize(self)[source]