Subgroup: Renderer

Class: QgsRendererWidget¶

class qgis.gui.QgsRendererWidget¶

Bases: qgis._gui.QgsPanelWidget

Base class for renderer settings widgets

WORKFLOW: - open renderer dialog with some RENDERER (never null!) - find out which widget to use - instantiate it and set in stacked widget - on any change of renderer type, create some default (dummy?) version and change the stacked widget - when clicked OK/Apply, get the renderer from active widget and clone it for the layer

Methods

acceptDrops

acceptPanel Accept the panel.

accessibleDescription

accessibleName

actionEvent

actions

activateWindow

addAction

addActions

adjustSize

apply

applyChanges This method should be called whenever the renderer is actually set on the layer.

autoDelete The the auto delete property on the widget.

autoFillBackground

backgroundRole

baseSize

blockSignals

changeEvent

changeSymbolAngle Change marker angles of selected symbols

changeSymbolColor Change color of selected symbols

changeSymbolOpacity Change opacity of selected symbols

changeSymbolSize Change marker sizes of selected symbols

changeSymbolUnit Change units mm/map units of selected symbols

changeSymbolWidth Change line widths of selected symbols

childAt childAt(self, int, int) -> QWidget

childEvent

children

childrenRect

childrenRegion

clearFocus

clearMask

close

closeEvent

colorCount

connectChildPanel Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

connectChildPanels Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

connectNotify

contentsMargins

contentsRect

context Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

contextMenuEvent

contextMenuPolicy

contextMenuViewCategories

copy

create

createDataDefinedSizeLegendWidget Creates widget to setup data-defined size legend.

createWindowContainer

cursor

customEvent

deleteLater

depth

destroy

devType

devicePixelRatio

devicePixelRatioF

devicePixelRatioFScale

disconnect

disconnectNotify

dockMode Return the dock mode state.

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

dumpObjectInfo

dumpObjectTree

dynamicPropertyNames

effectiveWinId

ensurePolished

enterEvent

event

eventFilter

find

findChild findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

findChildren findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

findParentPanel Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPolicy

focusPreviousChild

focusProxy

focusWidget

font

fontInfo

fontMetrics

foregroundRole

frameGeometry

frameSize

geometry

getContentsMargins

grab

grabGesture

grabKeyboard

grabMouse grabMouse(self, Union[QCursor, Qt.CursorShape])

grabShortcut

graphicsEffect

graphicsProxyWidget

hasFocus

hasHeightForWidth

hasMouseTracking

hasTabletTracking

height

heightForWidth

heightMM

hide

hideEvent

inherits

initPainter

inputMethodEvent

inputMethodHints

inputMethodQuery

insertAction

insertActions

installEventFilter

isActiveWindow

isAncestorOf

isEnabled

isEnabledTo

isFullScreen

isHidden

isLeftToRight

isMaximized

isMinimized

isModal

isRightToLeft

isSignalConnected

isVisible

isVisibleTo

isWidgetType

isWindow

isWindowModified

isWindowType

keyPressEvent

keyReleaseEvent

keyboardGrabber

killTimer

layout

layoutDirection

leaveEvent

locale

logicalDpiX

logicalDpiY

lower

mapFrom

mapFromGlobal

mapFromParent

mapTo

mapToGlobal

mapToParent

mask

maximumHeight

maximumSize

maximumWidth

metaObject

metric

minimumHeight

minimumSize

minimumSizeHint

minimumWidth

mouseDoubleClickEvent

mouseGrabber

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

move move(self, int, int)

moveEvent

moveToThread

nativeEvent

nativeParentWidget

nextInFocusChain

normalGeometry

objectName

openPanel Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.

overrideWindowFlags

overrideWindowState

paintEngine

paintEvent

paintingActive

palette

panelTitle The title of the panel.

parent

parentWidget

paste

physicalDpiX

physicalDpiY

pos

previousInFocusChain

property

pyqtConfigure Each keyword argument is either the name of a Qt property or a Qt signal.

raise_

receivers

rect

refreshSymbolView

releaseKeyboard

releaseMouse

releaseShortcut

removeAction

removeEventFilter

render render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))

renderer return pointer to the renderer (no transfer of ownership)

repaint repaint(self, int, int, int, int)

resize resize(self, int, int)

resizeEvent

restoreGeometry

saveGeometry

scroll scroll(self, int, int, QRect)

selectedSymbols Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods

sender

senderSignalIndex

setAcceptDrops

setAccessibleDescription

setAccessibleName

setAttribute

setAutoDelete The the auto delete property on the widget.

setAutoFillBackground

setBackgroundRole

setBaseSize setBaseSize(self, QSize)

setContentsMargins setContentsMargins(self, QMargins)

setContext Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

setContextMenuPolicy

setCursor

setDisabled

setDockMode Set the widget in dock mode which tells the widget to emit panel

setEnabled

setFixedHeight

setFixedSize setFixedSize(self, int, int)

setFixedWidth

setFocus setFocus(self, Qt.FocusReason)

setFocusPolicy

setFocusProxy

setFont

setForegroundRole

setGeometry setGeometry(self, int, int, int, int)

setGraphicsEffect

setHidden

setInputMethodHints

setLayout

setLayoutDirection

setLocale

setMask setMask(self, QRegion)

setMaximumHeight

setMaximumSize setMaximumSize(self, QSize)

setMaximumWidth

setMinimumHeight

setMinimumSize setMinimumSize(self, QSize)

setMinimumWidth

setMouseTracking

setObjectName

setPalette

setPanelTitle Set the title of the panel when shown in the interface.

setParent setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])

setProperty

setShortcutAutoRepeat

setShortcutEnabled

setSizeIncrement setSizeIncrement(self, QSize)

setSizePolicy setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)

setStatusTip

setStyle

setStyleSheet

setTabOrder

setTabletTracking

setToolTip

setToolTipDuration

setUpdatesEnabled

setVisible

setWhatsThis

setWindowFilePath

setWindowFlag

setWindowFlags

setWindowIcon

setWindowIconText

setWindowModality

setWindowModified

setWindowOpacity

setWindowRole

setWindowState

setWindowTitle

sharedPainter

show

showEvent

showFullScreen

showMaximized

showMinimized

showNormal

showSymbolLevelsDialog show a dialog with renderer’s symbol level settings

signalsBlocked

size

sizeHint

sizeIncrement

sizePolicy

stackUnder

startTimer

statusTip

style

styleSheet

tabletEvent

testAttribute

thread

timerEvent

toolTip

toolTipDuration

tr

underMouse

ungrabGesture

unsetCursor

unsetLayoutDirection

unsetLocale

update update(self, QRect)

updateGeometry

updateMicroFocus

updatesEnabled

vectorLayer Returns the vector layer associated with the widget.

visibleRegion

whatsThis

wheelEvent

width

widthMM

winId

window

windowFilePath

windowFlags

windowHandle

windowIcon

windowIconText

windowModality

windowOpacity

windowRole

windowState

windowTitle

windowType

x

y

Attributes

DrawChildren

DrawWindowBackground

IgnoreMask

PdmDepth

PdmDevicePixelRatio

PdmDevicePixelRatioScaled

PdmDpiX

PdmDpiY

PdmHeight

PdmHeightMM

PdmNumColors

PdmPhysicalDpiX

PdmPhysicalDpiY

PdmWidth

PdmWidthMM

customContextMenuRequested customContextMenuRequested(self, QPoint) [signal]

destroyed destroyed(self, QObject = None) [signal]

layerVariablesChanged Emitted when expression context variables on the associated vector layers have been changed.

objectNameChanged objectNameChanged(self, str) [signal]

panelAccepted Emitted when the panel is accepted by the user.

showPanel Emit when you require a panel to be show in the interface.

staticMetaObject

widgetChanged Emitted when the widget state changes.

windowIconChanged windowIconChanged(self, QIcon) [signal]

windowIconTextChanged windowIconTextChanged(self, str) [signal]

windowTitleChanged windowTitleChanged(self, str) [signal]

actionEvent()¶

apply()¶

applyChanges(self)¶: This method should be called whenever the renderer is actually set on the layer.

changeEvent()¶

changeSymbolAngle(self)¶: Change marker angles of selected symbols

changeSymbolColor(self)¶: Change color of selected symbols

changeSymbolOpacity(self)¶: Change opacity of selected symbols

changeSymbolSize(self)¶: Change marker sizes of selected symbols

changeSymbolUnit(self)¶: Change units mm/map units of selected symbols

changeSymbolWidth(self)¶: Change line widths of selected symbols

childEvent()¶

closeEvent()¶

connectNotify()¶

context(self) → QgsSymbolWidgetContext¶: Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

See also

setContext()

New in version 3.0.

contextMenuEvent()¶

contextMenuViewCategories(self, p: QPoint)¶

copy(self)¶

create()¶

createDataDefinedSizeLegendWidget(self, symbol: QgsMarkerSymbol, ddsLegend: QgsDataDefinedSizeLegend) → QgsDataDefinedSizeLegendWidget¶: Creates widget to setup data-defined size legend. Returns newly created panel - may be null if it could not be opened. Ownership is transferred to the caller.

New in version 3.0.

customEvent()¶

destroy()¶

disconnectNotify()¶

dragEnterEvent()¶

dragLeaveEvent()¶

dragMoveEvent()¶

dropEvent()¶

enterEvent()¶

event()¶

focusInEvent()¶

focusNextChild()¶

focusNextPrevChild()¶

focusOutEvent()¶

focusPreviousChild()¶

hideEvent()¶

initPainter()¶

inputMethodEvent()¶

isSignalConnected()¶

keyPressEvent()¶

keyReleaseEvent()¶

layerVariablesChanged¶: Emitted when expression context variables on the associated vector layers have been changed. Will request the parent dialog to re-synchronize with the variables. [signal]

leaveEvent()¶

metric()¶

mouseDoubleClickEvent()¶

mouseMoveEvent()¶

mousePressEvent()¶

mouseReleaseEvent()¶

moveEvent()¶

nativeEvent()¶

paintEvent()¶

paste(self)¶

receivers()¶

refreshSymbolView(self)¶

renderer(self) → QgsFeatureRenderer¶: return pointer to the renderer (no transfer of ownership)

resizeEvent()¶

selectedSymbols(self) → List[QgsSymbol]¶: Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&)*

sender()¶

senderSignalIndex()¶

setContext(self, context: QgsSymbolWidgetContext)¶

Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

Parameters:	context – symbol widget context