Class: QgsFieldConditionalFormatWidget¶
- class qgis.gui.QgsFieldConditionalFormatWidget(parent: QWidget = None)¶
Bases:
QgsPanelWidget
Constructor for QgsFieldConditionalFormatWidget.
A widget for customizing conditional formatting options.
Methods
Returns a list of the default presets.
Switches the widget to the edit style mode for the specified style, where
index
is the index of the conditional style to edit andstyle
is the initial definition of the style.Overridden key press event to handle the esc event on the widget.
Resets the formatting options to their default state.
Sets the vector
layer
associated with the widget.Sets the preset
styles
that can be used for quick pick.Switches the widget to the rules page.
Signals
Emitted when the conditional styling rules are updated.
- actionEvent(self, QActionEvent)¶
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- customEvent(self, QEvent)¶
- defaultPresets() → List[QgsConditionalStyle]¶
Returns a list of the default presets. Normally used when the widget is created, however calling
setPresets()
will override the default styles.- Return type
List[QgsConditionalStyle]
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- editStyle(self, index: int, style: QgsConditionalStyle)¶
Switches the widget to the edit style mode for the specified style, where
index
is the index of the conditional style to edit andstyle
is the initial definition of the style.- Parameters
index (int) –
style (QgsConditionalStyle) –
- 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)¶
- initPainter(self, QPainter)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isSignalConnected(self, QMetaMethod) → bool¶
- keyPressEvent(self, event: QKeyEvent)¶
Overridden key press event to handle the esc event on the widget.
- Parameters
event – The key event
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
- loadStyle(self, style: QgsConditionalStyle)¶
Deprecated since version no: longer used, use
QgsEditConditionalFormatRuleWidget
.loadStyle instead.- Parameters
style (QgsConditionalStyle) –
- 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]¶
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) → int¶
- reset(self)¶
Resets the formatting options to their default state.
Deprecated since version no: longer used, will be removed in QGIS 4.0
- resizeEvent(self, QResizeEvent)¶
- rulesUpdated¶
Emitted when the conditional styling rules are updated.
The
fieldName
argument indicates the name of the field whose rules have been modified, or an emptyfieldName
indicates that a row-based rule was updated. [signal]- Parameters
fieldName (str) –
- sender(self) → QObject¶
- senderSignalIndex(self) → int¶
- setLayer(self, layer: QgsVectorLayer)¶
Sets the vector
layer
associated with the widget.- Parameters
layer (QgsVectorLayer) –
- setPresets(self, styles: Iterable[QgsConditionalStyle])¶
Sets the preset
styles
that can be used for quick pick.- Parameters
styles (Iterable[QgsConditionalStyle]) –
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- viewRules(self)¶
Switches the widget to the rules page.
Deprecated since version no: longer used, will be removed in QGIS 4.0
- wheelEvent(self, QWheelEvent)¶