Class: QgsFieldConditionalFormatWidget

class qgis.gui.QgsFieldConditionalFormatWidget(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsFieldConditionalFormatWidget.

Parameters

parent (QWidget = None) – parent widget

A widget for customizing conditional formatting options.

Methods

actionEvent

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

customEvent

defaultPresets

The default presets for the widget.

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

editStyle

Switches the widget to the edit style mode for the specified style.

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

loadStyle

type style

QgsConditionalStyle

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

receivers

reset

Resets the formatting options to their default state.

resizeEvent

sender

senderSignalIndex

setLayer

Sets the vector layer associated with the widget.

setPresets

Set the presets that can be used for quick pick

sharedPainter

showEvent

tabletEvent

timerEvent

updateMicroFocus

viewRules

Switches the widget to the rules page.

wheelEvent

Signals

rulesUpdated

Emitted when the conditional styling rules are updated.

actionEvent()
changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
defaultPresets(self) → List[QgsConditionalStyle]

The default presets for the widget. Normally set when the widget is created however called setPresets will override the default styles.

Return type

List[QgsConditionalStyle]

Returns

List of default presets.

destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
editStyle(self, index: int, style: QgsConditionalStyle)

Switches the widget to the edit style mode for the specified style.

Parameters
  • index (int) – index of conditional style to edit

  • style (QgsConditionalStyle) – initial conditional styling options

enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
loadStyle(self, style: QgsConditionalStyle)
Parameters

style (QgsConditionalStyle) – initial conditional styling options

metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
reset(self)

Resets the formatting options to their default state.

resizeEvent()
rulesUpdated

Emitted when the conditional styling rules are updated.

Parameters

fieldName – name of field whose rules have been modified. [signal]

sender()
senderSignalIndex()
setLayer(self, layer: QgsVectorLayer)

Sets the vector layer associated with the widget.

Parameters

layer (QgsVectorLayer) – vector layer

setPresets(self, styles: Iterable[QgsConditionalStyle])

Set the presets that can be used for quick pick

Parameters

styles (Iterable[QgsConditionalStyle]) – A list of styles used as presets

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
viewRules(self)

Switches the widget to the rules page.

wheelEvent()