Class: QgsAttributeFormEditorWidget¶
- class qgis.gui.QgsAttributeFormEditorWidget(editorWidget: QgsEditorWidgetWrapper, widgetType: str, form: QgsAttributeForm)¶
Bases:
QgsAttributeFormWidget
Constructor for QgsAttributeFormEditorWidget.
- Parameters
editorWidget – associated editor widget wrapper (for default/edit modes)
widgetType – the type identifier of the widget passed in the wrapper
form – parent attribute form
A widget consisting of both an editor widget and additional widgets for controlling the behavior of the editor widget depending on a number of possible modes. For instance, if the parent attribute form is in the multi edit mode, this widget will show both the editor widget and a tool button for controlling the multi edit results.
New in version 2.16:
Methods
Called when field values have been committed;
- param context
Returns the current value of the attached editor widget.
Returns the editor widget wrapper
Returns
True
if the widget's value has been changed since it was initialized.Resets the widget to an initial value.
Set the constraint result label visible or invisible according to the layer editable status
Set the constraint status for this widget.
Sets whether the widget should be displayed in a "mixed values" mode.
Signals
Emitted when the widget's value changes
Emitted when the widget's value changes
- actionEvent(self, QActionEvent)¶
- changeEvent(self, QEvent)¶
- changesCommitted(self)¶
Called when field values have been committed;
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- createSearchWidgetWrappers(self, context: QgsAttributeEditorContext = QgsAttributeEditorContext())¶
- Parameters
context (
QgsAttributeEditorContext
= QgsAttributeEditorContext()) –
- currentValue(self) Any ¶
Returns the current value of the attached editor widget.
- Return type
Any
- 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)¶
- editorWidget(self) QgsEditorWidgetWrapper ¶
Returns the editor widget wrapper
New in version 3.10.
- Return type
- enterEvent(self, QEvent)¶
- event(self, QEvent) bool ¶
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hasChanged(self) bool ¶
Returns
True
if the widget’s value has been changed since it was initialized.See also
- Return type
bool
- hideEvent(self, QHideEvent)¶
- initPainter(self, QPainter)¶
- initialize(self, initialValue: Any, mixedValues: bool = False, additionalFieldValues: Iterable[Any] = [])¶
Resets the widget to an initial value.
- Parameters
initialValue (Any) – initial value to show in widget
mixedValues (bool = False) – set to
True
to initially show the mixed values stateadditionalFieldValues (Iterable[Any] = []) – a variant map of additional field names with their corresponding values
- 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 ¶
- setConstraintResultVisible(self, editable: bool)¶
Set the constraint result label visible or invisible according to the layer editable status
- Parameters
editable (bool) –
- setConstraintStatus(self, constraint: str, description: str, err: str, result: QgsEditorWidgetWrapper.ConstraintResult)¶
Set the constraint status for this widget.
- Parameters
constraint (str) –
description (str) –
err (str) –
result (QgsEditorWidgetWrapper.ConstraintResult) –
- setIsMixed(self, mixed: bool)¶
Sets whether the widget should be displayed in a “mixed values” mode.
- Parameters
mixed (bool) – set to
True
to show in a mixed values state
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- valueChanged¶
Emitted when the widget’s value changes
- Parameters
value (Any) – new widget value
Deprecated since version QGIS: 3.10 use valuesChanged instead [signal]
- valuesChanged¶
Emitted when the widget’s value changes
- Parameters
value (Any) – new widget value
additionalFieldValues (Iterable[Any]) – of the potential additional fields
New in version 3.10: [signal]
- wheelEvent(self, QWheelEvent)¶