Class: QgsSymbolSelectorDialog

A dialog that can be used to select and build a symbol.

QgsSymbolSelectorDialog

Class Hierarchy

Base classes

QDialog
QWidget
QObject
QPaintDevice

class qgis.gui.QgsSymbolSelectorDialog

Bases: QDialog

__init__(symbol: QgsSymbol | None, style: QgsStyle | None, vl: QgsVectorLayer | None, parent: QWidget | None = None, embedded: bool = False)

Constructor for QgsSymbolSelectorDialog.

Parameters:

• symbol (Optional[QgsSymbol]) – The symbol

• style (Optional[QgsStyle]) – The style

• vl (Optional[QgsVectorLayer]) – Associated vector layer

• parent (Optional[QWidget] = None) – Parent widget

• embedded (bool = False) – True to embed in renderer properties dialog, False otherwise

addLayer(self)

advancedMenu(self) → QMenu | None

Returns menu for “advanced” button - create it if doesn’t exist and show the advanced button

Return type:

Optional[QMenu]

buttonBox(self) → QDialogButtonBox | None

Returns a reference to the dialog’s button box.

Added in version 3.10.

Return type:

Optional[QDialogButtonBox]

changeLayer(self, layer: QgsSymbolLayer | None)

Alters tree and sets proper widget when Layer Type is changed

Note

The layer is received from the LayerPropertiesWidget

Parameters:

layer (Optional[QgsSymbolLayer])

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

duplicateLayer(self)

Duplicates the current symbol layer and places the duplicated layer above the current symbol layer

layerChanged(self)

lockLayer(self)

moveLayerDown(self)

moveLayerUp(self)

removeLayer(self)

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

symbol(self) → QgsSymbol | None

Returns the symbol that is currently active in the widget. Can be None.

Return type:

Optional[QgsSymbol]

Returns:

The active symbol.

symbolChanged(self)

Slot to update tree when a new symbol from style

signal symbolModified

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.

updateLayerPreview(self)

updatePreview(self)