Class: QgsRendererPropertiesDialog¶
- class qgis.gui.QgsRendererPropertiesDialog(layer: QgsVectorLayer, style: QgsStyle, embedded: bool = False, parent: QWidget = None)¶
Bases:
PyQt5.QtWidgets.QDialog
Constructor for QgsRendererPropertiesDialog.
- Parameters
layer – associated layer
style – style collection
embedded – set to
True
to indicate that the dialog will be embedded in another widget, rather than shown as a dialog by itselfparent –
parent widget
Methods
Apply the changes from the dialog to the layer.
Connect the given slot to the value changed event for the set of widgets Each widget is checked for type and the common type of signal is connected to the slot.
- param event
Apply and accept the changes for the dialog.
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.called when user changes renderer type
Sets the
context
in which the dialog is shown, e.g., the associated map canvas and expression contexts.Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs
Sets the map canvas associated with the dialog.
Signals
Emitted when expression context variables on the associated vector layers have been changed.
Emit when you require a panel to be show in the interface.
Emitted when something on the widget has changed.
- actionEvent(self, QActionEvent)¶
- apply(self)¶
Apply the changes from the dialog to the layer.
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- connectValueChanged(self, widgets: Iterable[QWidget], slot: str)¶
Connect the given slot to the value changed event for the set of widgets Each widget is checked for type and the common type of signal is connected to the slot.
- Parameters
widgets (Iterable[QWidget]) – The list of widgets to check.
slot (str) – The slot to connect to the signals.
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- customEvent(self, QEvent)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) → bool¶
- eventFilter(self, QObject, QEvent) → bool¶
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) → bool¶
- focusNextPrevChild(self, bool) → bool¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) → bool¶
- hideEvent(self, QHideEvent)¶
- initPainter(self, QPainter)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isSignalConnected(self, QMetaMethod) → bool¶
- keyPressEvent(self, event: QKeyEvent)¶
- Parameters
event (QKeyEvent) –
- keyReleaseEvent(self, QKeyEvent)¶
- 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(self, QEvent)¶
- metric(self, QPaintDevice.PaintDeviceMetric) → int¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, QMouseEvent)¶
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]¶
- onOK(self)¶
Apply and accept the changes for the dialog.
- openPanel(self, panel: QgsPanelWidget)¶
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.If dock mode is
False
this method will open a dialog and block the user.- Parameters
panel (QgsPanelWidget) – The panel widget to open.
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) → int¶
- rendererChanged(self)¶
called when user changes renderer type
- resizeEvent(self, QResizeEvent)¶
- sender(self) → QObject¶
- senderSignalIndex(self) → int¶
- setContext(self, context: QgsSymbolWidgetContext)¶
Sets the
context
in which the dialog is shown, e.g., the associated map canvas and expression contexts.New in version 3.6.
- Parameters
context (QgsSymbolWidgetContext) –
- setDockMode(self, dockMode: bool)¶
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs
- Parameters
dockMode (bool) –
True
to enable dock mode.
- setMapCanvas(self, canvas: QgsMapCanvas)¶
Sets the map canvas associated with the dialog. This allows the widget to retrieve the current map scale and other properties from the canvas.
- Parameters
canvas (QgsMapCanvas) – map canvas
New in version 2.12.
- showEvent(self, QShowEvent)¶
- showPanel¶
Emit when you require a panel to be show in the interface.
- Parameters
panel (QgsPanelWidget) – The panel widget to show.
Note
If you are connected to this signal you should also connect given panels showPanel signal as they can be nested. [signal]
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶
- widgetChanged¶
Emitted when something on the widget has changed. All widgets will fire this event to notify of an internal change. [signal]