Class: QgsExpressionBuilderDialog¶
- class qgis.gui.QgsExpressionBuilderDialog¶
Bases:
PyQt5.QtWidgets.QDialog
A generic dialog for building expression strings @remarks This class also shows an example on how to use
QgsExpressionBuilderWidget
Methods
Allow accepting invalid expressions.
Is called when the dialog get accepted or rejected Used to save geometry
Returns the expected format string, which is shown in the dialog.
The builder widget that is used by the dialog
Returns the expression context for the dialog.
- rtype
str
Allow accepting expressions with evaluation errors.
Set the
expected
format string, which is shown in the dialog.Sets the expression context for the dialog.
- param text
Sets geometry calculator used in distance/area calculations.
Signals
Allow accepting expressions with evaluation errors.
- accept(self)¶
- actionEvent(self, QActionEvent)¶
- allowEvalErrors(self) → bool¶
Allow accepting invalid expressions. This can be useful when we are not able to provide an expression context of which we are sure it’s completely populated.
New in version 3.0.
- Return type
bool
- allowEvalErrorsChanged¶
Allow accepting expressions with evaluation errors. This can be useful when we are not able to provide an expression context of which we are sure it’s completely populated.
New in version 3.0: [signal]
- 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)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- done(self, r: int)¶
Is called when the dialog get accepted or rejected Used to save geometry
- Parameters
r (int) – result value (unused)
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) → bool¶
- eventFilter(self, QObject, QEvent) → bool¶
- expectedOutputFormat(self) → str¶
Returns the expected format string, which is shown in the dialog. This is purely a text format and no expression validation is done against it.
See also
- Return type
str
- expressionBuilder(self) → QgsExpressionBuilderWidget¶
The builder widget that is used by the dialog
- Return type
- expressionContext(self) → QgsExpressionContext¶
Returns the expression context for the dialog. The context is used for the expression preview result and for populating the list of available functions and variables.
See also
New in version 2.12.
- Return type
- expressionText(self) → str¶
- Return type
str
- 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, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- 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]¶
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) → int¶
- resizeEvent(self, QResizeEvent)¶
- sender(self) → QObject¶
- senderSignalIndex(self) → int¶
- setAllowEvalErrors(self, allowEvalErrors: bool)¶
Allow accepting expressions with evaluation errors. This can be useful when we are not able to provide an expression context of which we are sure it’s completely populated.
New in version 3.0.
- Parameters
allowEvalErrors (bool) –
- setExpectedOutputFormat(self, expected: str)¶
Set the
expected
format string, which is shown in the dialog. This is purely a text format and no expression validation is done against it.See also
- Parameters
expected (str) –
- setExpressionContext(self, context: QgsExpressionContext)¶
Sets the expression context for the dialog. The context is used for the expression preview result and for populating the list of available functions and variables.
- Parameters
context (QgsExpressionContext) – expression context
See also
New in version 2.12.
- setExpressionText(self, text: str)¶
- Parameters
text (str) –
- setGeomCalculator(self, da: QgsDistanceArea)¶
Sets geometry calculator used in distance/area calculations.
- Parameters
da (QgsDistanceArea) –
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶