Class: QgsAttributeFormEditorWidget

class qgis.gui.QgsAttributeFormEditorWidget(editorWidget: QgsEditorWidgetWrapper, widgetType: str, form: QgsAttributeForm)

Bases: qgis._gui.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

actionEvent
changeEvent
changesCommitted Called when field values have been committed;
childEvent
closeEvent
connectNotify
contextMenuEvent
create
createSearchWidgetWrappers
currentValue Returns the current value of the attached editor widget.
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hasChanged Returns true if the widget’s value has been changed since it was initialized.
hideEvent
initPainter
initialize Resets the widget to an initial value.
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
receivers
resizeEvent
sender
senderSignalIndex
setConstraintResultVisible Set the constraint result label visible or invisible according to the layer editable status
setConstraintStatus Set the constraint status for this widget.
setIsMixed Sets whether the widget should be displayed in a “mixed values” mode.
sharedPainter
showEvent
tabletEvent
timerEvent
updateMicroFocus
wheelEvent

Signals

valueChanged Emitted when the widget’s value changes

Attributes

actionEvent()
changeEvent()
changesCommitted(self)

Called when field values have been committed;

childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
createSearchWidgetWrappers(self)
currentValue(self) → Any

Returns the current value of the attached editor widget.

customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hasChanged(self) → bool

Returns true if the widget’s value has been changed since it was initialized.

See also

initialize()

hideEvent()
initPainter()
initialize(self, initialValue: Any, mixedValues: bool = False)

Resets the widget to an initial value.

Parameters:
  • initialValue – initial value to show in widget
  • mixedValues – set to true to initially show the mixed values state
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent()
sender()
senderSignalIndex()
setConstraintResultVisible(self, editable: bool)

Set the constraint result label visible or invisible according to the layer editable status

setConstraintStatus(self, constraint: str, description: str, err: str, result: QgsEditorWidgetWrapper.ConstraintResult)

Set the constraint status for this widget.

setIsMixed(self, mixed: bool)

Sets whether the widget should be displayed in a “mixed values” mode.

Parameters:mixed – set to true to show in a mixed values state
sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
valueChanged

Emitted when the widget’s value changes

Parameters:value – new widget value [signal]
wheelEvent()