Class: QgsSymbolButton

class qgis.gui.QgsSymbolButton

Bases: PyQt5.QtWidgets.QToolButton

A button for creating and modifying QgsSymbol settings.

The button shows a preview icon for the current symbol, and will open a detailed symbol editor dialog (or panel widget) when clicked.

New in version 3.0.

QgsSymbolButton(parent: QWidget = None, dialogTitle: str = ‘’) Construct a new symbol button. Use dialogTitle string to define the title to show in the symbol settings dialog.

Methods

actionEvent

changeEvent

param e

checkStateSet

childEvent

closeEvent

connectNotify

contextMenuEvent

copyColor

Copies the current symbol color to the clipboard.

copySymbol

Copies the current symbol to the clipboard.

create

customEvent

destroy

dialogTitle

Returns the title for the symbol settings dialog window.

disconnectNotify

dragEnterEvent

param e

dragLeaveEvent

param e

dragMoveEvent

dropEvent

param e

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

hitButton

initPainter

initStyleOption

inputMethodEvent

isSignalConnected

keyPressEvent

param e

keyReleaseEvent

layer

Returns the layer associated with the widget.

leaveEvent

mapCanvas

Returns the map canvas associated with the widget.

messageBar

Returns the message bar associated with the widget.

metric

minimumSizeHint

rtype

QSize

mouseDoubleClickEvent

mouseMoveEvent

param e

mousePressEvent

param e

mouseReleaseEvent

param e

moveEvent

nativeEvent

nextCheckState

paintEvent

pasteColor

Pastes a color from the clipboard to the symbol.

pasteSymbol

Pastes a symbol from the clipboard.

receivers

registerExpressionContextGenerator

Register an expression context generator class that will be used to retrieve an expression context for the button when required.

resizeEvent

param event

sender

senderSignalIndex

setColor

Sets the current color for the symbol.

setDialogTitle

Sets the title for the symbol settings dialog window.

setLayer

Sets a layer to associate with the widget.

setMapCanvas

Sets a map canvas to associate with the widget.

setMessageBar

Sets the message bar associated with the widget.

setSymbol

Sets the symbol for the button.

setSymbolType

Sets the symbol type which the button requires.

sharedPainter

showEvent

param e

sizeHint

rtype

QSize

symbol

Returns the current symbol defined by the button.

symbolType

Returns the symbol type which the button requires.

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

changed

Emitted when the symbol’s settings are changed.

actionEvent(self, QActionEvent)
changeEvent(self, e: QEvent)
Parameters

e (QEvent) –

changed

Emitted when the symbol’s settings are changed.

See also

symbol()

See also

setSymbol() [signal]

checkStateSet(self)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
copyColor(self)

Copies the current symbol color to the clipboard.

See also

pasteColor()

copySymbol(self)

Copies the current symbol to the clipboard.

See also

pasteSymbol()

create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
dialogTitle(self)str

Returns the title for the symbol settings dialog window.

See also

setDialogTitle()

Return type

str

disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, e: QDragEnterEvent)
Parameters

e (QDragEnterEvent) –

dragLeaveEvent(self, e: QDragLeaveEvent)
Parameters

e (QDragLeaveEvent) –

dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, e: QDropEvent)
Parameters

e (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)
hitButton(self, QPoint)bool
initPainter(self, QPainter)
initStyleOption(self, QStyleOptionToolButton)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, e: QKeyEvent)
Parameters

e (QKeyEvent) –

keyReleaseEvent(self, QKeyEvent)
layer(self)QgsVectorLayer

Returns the layer associated with the widget.

See also

setLayer()

Return type

QgsVectorLayer

leaveEvent(self, QEvent)
mapCanvas(self)QgsMapCanvas

Returns the map canvas associated with the widget.

See also

setMapCanvas()

Return type

QgsMapCanvas

messageBar(self)QgsMessageBar

Returns the message bar associated with the widget.

See also

setMessageBar()

New in version 3.6.

Return type

QgsMessageBar

metric(self, QPaintDevice.PaintDeviceMetric)int
minimumSizeHint(self)QSize
Return type

QSize

mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, e: QMouseEvent)
Parameters

e (QMouseEvent) –

mousePressEvent(self, e: QMouseEvent)
Parameters

e (QMouseEvent) –

mouseReleaseEvent(self, e: QMouseEvent)
Parameters

e (QMouseEvent) –

moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
nextCheckState(self)
paintEvent(self, QPaintEvent)
pasteColor(self)

Pastes a color from the clipboard to the symbol. If clipboard does not contain a valid color or string representation of a color, then no change is applied.

See also

copyColor()

pasteSymbol(self)

Pastes a symbol from the clipboard. If clipboard does not contain a valid symbol then no change is applied.

See also

copySymbol()

receivers(self, PYQT_SIGNAL)int
registerExpressionContextGenerator(self, generator: QgsExpressionContextGenerator)

Register an expression context generator class that will be used to retrieve an expression context for the button when required.

Parameters

generator (QgsExpressionContextGenerator) –

resizeEvent(self, event: QResizeEvent)
Parameters

event (QResizeEvent) –

sender(self)QObject
senderSignalIndex(self)int
setColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the current color for the symbol. Will emit a changed() signal if the color is different to the previous symbol color.

Parameters

color (Union[QColor) –

setDialogTitle(self, title: str)

Sets the title for the symbol settings dialog window.

See also

dialogTitle()

Parameters

title (str) –

setLayer(self, layer: QgsVectorLayer)

Sets a layer to associate with the widget. This allows the widget to setup layer related settings within the symbol settings dialog, such as correctly populating data defined override buttons.

See also

layer()

Parameters

layer (QgsVectorLayer) –

setMapCanvas(self, canvas: QgsMapCanvas)

Sets a map canvas to associate with the widget. This allows the widget to fetch current settings from the map canvas, such as current scale.

See also

mapCanvas()

Parameters

canvas (QgsMapCanvas) –

setMessageBar(self, bar: QgsMessageBar)

Sets the message bar associated with the widget. This allows the widget to push feedback messages to the appropriate message bar.

See also

messageBar()

New in version 3.6.

Parameters

bar (QgsMessageBar) –

setSymbol(self, symbol: QgsSymbol)

Sets the symbol for the button. Ownership of symbol is transferred to the button.

See also

symbol()

See also

changed()

Parameters

symbol (QgsSymbol) –

setSymbolType(self, type: Qgis.SymbolType)

Sets the symbol type which the button requires. If the type differs from the current symbol type, the symbol will be reset to a default symbol style of the new type.

See also

symbolType()

Parameters

type (Qgis.SymbolType) –

sharedPainter(self)QPainter
showEvent(self, e: QShowEvent)
Parameters

e (QShowEvent) –

sizeHint(self)QSize
Return type

QSize

symbol(self)QgsSymbol

Returns the current symbol defined by the button.

See also

setSymbol()

See also

changed()

Return type

QgsSymbol

symbolType(self)Qgis.SymbolType

Returns the symbol type which the button requires.

See also

setSymbolType()

Return type

Qgis.SymbolType

tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)