Subgroup: Symbol
Class: QgsSymbolSelectorWidget¶
-
class
qgis.gui.
QgsSymbolSelectorWidget
(symbol: QgsSymbol, style: QgsStyle, vl: QgsVectorLayer, parent: QWidget = None)¶ Bases:
qgis._gui.QgsPanelWidget
Symbol selector widget that can be used to select and build a symbol
Parameters: - symbol – The symbol to load into the widget as a start point.
- style – The style used by the widget.
- vl – The vector layer for the symbol.
- parent –
Symbol selector widget that can be used to select and build a symbol
Methods
actionEvent
addLayer
Add a symbol layer to the bottom of the stack. advancedMenu
Returns menu for “advanced” button - create it if doesn’t exist and show the advanced button changeEvent
changeLayer
alters tree and sets proper widget when Layer Type is changed note: The layer is received from the LayerPropertiesWidget 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
currentLayer
The current symbol layer that is active in the interface. customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
duplicateLayer
Duplicates the current symbol layer and places the duplicated layer above the current symbol layer enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
layerChanged
Called when the layer changes in the widget. leaveEvent
loadSymbol
Reload the current symbol in the view. lockLayer
Lock the current active symbol layer. metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
moveLayerByOffset
Move the current active layer by a set offset in the list. moveLayerDown
Move the active symbol layer down. moveLayerUp
Move the active symbol layer up. nativeEvent
paintEvent
receivers
removeLayer
Remove the current active symbol layer. resizeEvent
sender
senderSignalIndex
setContext
Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. setWidget
Set the properties widget for the active symbol layer. sharedPainter
showEvent
symbol
Returns the symbol that is currently active in the widget. symbolChanged
Slot to update tree when a new symbol from style tabletEvent
timerEvent
updateLayerPreview
Update the single symbol layer preview in the widget. updateLockButton
Update the lock button states based on the current symbol layer. updateMicroFocus
updatePreview
Update the preview of the whole symbol in the interface. updateUi
Update the state of the UI based on the currently set symbol layer. wheelEvent
Signals
symbolModified
Emiited when a symbol is modified in the widget. Attributes
-
actionEvent
()¶
-
addLayer
(self)¶ Add a symbol layer to the bottom of the stack.
-
advancedMenu
(self) → QMenu¶ Returns menu for “advanced” button - create it if doesn’t exist and show the advanced button
-
changeEvent
()¶
-
changeLayer
(self, layer: QgsSymbolLayer)¶ alters tree and sets proper widget when Layer Type is changed note: The layer is received from the LayerPropertiesWidget
-
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
New in version 3.0.
-
contextMenuEvent
()¶
-
create
()¶
-
currentLayer
(self) → QgsSymbolLayer¶ The current symbol layer that is active in the interface.
Returns: The active symbol layer.
-
customEvent
()¶
-
destroy
()¶
-
disconnectNotify
()¶
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
dropEvent
()¶
-
duplicateLayer
(self)¶ Duplicates the current symbol layer and places the duplicated layer above the current symbol layer
New in version 2.14.
-
enterEvent
()¶
-
event
()¶
-
focusInEvent
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPreviousChild
()¶
-
hideEvent
()¶
-
initPainter
()¶
-
inputMethodEvent
()¶
-
isSignalConnected
()¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
layerChanged
(self)¶ Called when the layer changes in the widget. Updates the active properties for active symbol layer.
-
leaveEvent
()¶
-
loadSymbol
(self)¶ Reload the current symbol in the view.
-
lockLayer
(self)¶ Lock the current active symbol layer.
-
metric
()¶
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
()¶
-
mouseReleaseEvent
()¶
-
moveEvent
()¶
-
moveLayerByOffset
(self, offset: int)¶ Move the current active layer by a set offset in the list.
Parameters: offset – The offset to move the layer by
-
moveLayerDown
(self)¶ Move the active symbol layer down.
-
moveLayerUp
(self)¶ Move the active symbol layer up.
-
nativeEvent
()¶
-
paintEvent
()¶
-
receivers
()¶
-
removeLayer
(self)¶ Remove the current active symbol layer.
-
resizeEvent
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
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 – symbol widget context See also
New in version 3.0.
-
setWidget
(self, widget: QWidget)¶ Set the properties widget for the active symbol layer.
Parameters: widget – The widget to set to configure the active symbol layer.
-
showEvent
()¶
-
symbol
(self) → QgsSymbol¶ Returns the symbol that is currently active in the widget. Can be null.
Returns: The active symbol.
-
symbolChanged
(self)¶ Slot to update tree when a new symbol from style
-
symbolModified
¶ Emiited when a symbol is modified in the widget. [signal]
-
tabletEvent
()¶
-
timerEvent
()¶
-
updateLayerPreview
(self)¶ Update the single symbol layer preview in the widget.
-
updateLockButton
(self)¶ Update the lock button states based on the current symbol layer.
-
updateMicroFocus
()¶
-
updatePreview
(self)¶ Update the preview of the whole symbol in the interface.
-
updateUi
(self)¶ Update the state of the UI based on the currently set symbol layer.
-
wheelEvent
()¶