Class: QgsEditFormConfig¶

Contains configuration settings for an editor form.

Enums

`DataDefinedProperty`	Data defined properties.
`EditorLayout`	alias of `AttributeFormLayout`
`FeatureFormSuppress`	alias of `AttributeFormSuppression`
`PythonInitCodeSource`	alias of `AttributeFormPythonInitCodeSource`

Methods

`addTab`	Adds a new element to the invisible root container in the layout.
`attributeEditorElementFromDomElement`	Deserialize drag and drop designer elements.
`clearTabs`	Clears all the tabs for the attribute editor form with EditorLayout.TabLayout.
`dataDefinedFieldProperties`	Returns data defined properties for fieldName
`initCode`	Gets Python code for edit form initialization.
`initCodeSource`	Returns Python code source for edit form initialization (if it shall be loaded from a file, read from the provided dialog editor or inherited from the environment)
`initFilePath`	Gets Python external file path for edit form initialization.
`initFunction`	Gets Python function for edit form initialization.
`invisibleRootContainer`	Gets the invisible root container for the drag and drop designer form (EditorLayout.TabLayout).
`labelOnTop`	If this returns `True`, the widget at the given index will receive its label on the previous line while if it returns `False`, the widget will receive its label on the left hand side.
`layout`	Gets the active layout style for the attribute editor for this layer
`propertyDefinitions`	Returns data defined property definitions.
`readOnly`	This returns `True` if the field is manually set to read only or if the field does not support editing like joins or virtual fields.
`readXml`	Read XML information Deserialize on project load
`removeWidgetConfig`	Remove the configuration for the editor widget with the given name
`reuseLastValue`	If this returns `True`, the widget at the given index will remember the previously entered value from this QGIS session when creating new features.
`setDataDefinedFieldProperties`	Set data defined properties for fieldName to properties
`setInitCode`	Set Python code for edit form initialization.
`setInitCodeSource`	Sets if Python code shall be used for edit form initialization and its origin
`setInitFilePath`	Set Python external file path for edit form initialization.
`setInitFunction`	Set Python function for edit form initialization.
`setLabelOnTop`	If this is set to `True`, the widget at the given index will receive its label on the previous line while if it is set to `False`, the widget will receive its label on the left hand side.
`setLayout`	Sets the active layout style for the attribute editor for this layer
`setReadOnly`	If set to `False`, the widget at the given index will be read-only.
`setReuseLastValue`	Sets whether the widget at the given index will remember the previously entered value from this QGIS session when creating new features.
`setSuppress`	Sets type of feature form pop-up suppression after feature creation (overrides app setting)
`setUiForm`	Set path to the .ui form.
`setWidgetConfig`	Set the editor widget config for a widget which is not for a simple field.
`suppress`	Type of feature form pop-up suppression after feature creation (overrides app setting)
`tabs`	Returns a list of tabs for EditorLayout.TabLayout obtained from the invisible root container.
`uiForm`	Returns the path or URL to the .ui form.
`widgetConfig`	Gets the configuration for the editor widget with the given name.
`writeXml`	Write XML information Serialize on project save

class qgis.core.QgsEditFormConfig[source]¶

Bases: object

__init__(o: QgsEditFormConfig)

Parameters:: o (QgsEditFormConfig)

__init__(): Create a new edit form config. Normally invoked by QgsVectorLayer

class DataDefinedProperty(*values)¶

Bases: IntEnum

Data defined properties. Form data defined overrides are stored in a property collection and they can be retrieved using the indexes specified in this enum.

Added in version 3.14.

NoProperty: No property
AllProperties: All properties for item
Alias: Alias
Editable: Editable state

Added in version 3.30.

EditorLayout¶: alias of AttributeFormLayout

FeatureFormSuppress¶: alias of AttributeFormSuppression

class GroupData¶

class GroupData(name: str | None, fields: Iterable[str | None])

class GroupData(a0: QgsEditFormConfig.GroupData)

Bases: object

mFields¶

mName¶

PythonInitCodeSource¶: alias of AttributeFormPythonInitCodeSource

class TabData¶

class TabData(name: str | None, fields: Iterable[str | None], groups: Iterable[QgsEditFormConfig.GroupData])

class TabData(a0: QgsEditFormConfig.TabData)

Bases: object

mFields¶

mGroups¶

mName¶

addTab(self, data: QgsAttributeEditorElement | None)[source]¶

Adds a new element to the invisible root container in the layout.

This is only useful in combination with EditorLayout.TabLayout.

Parameters:: data (Optional[QgsAttributeEditorElement])

attributeEditorElementFromDomElement(self, elem: QDomElement, parent: QgsAttributeEditorElement | None, layerId: str | None = '', context: QgsReadWriteContext = QgsReadWriteContext()) → QgsAttributeEditorElement | None[source]¶

Deserialize drag and drop designer elements.

Deprecated since version 3.18: Use QgsAttributeEditorElement.create instead.

Parameters:

elem (QDomElement)
parent (Optional[QgsAttributeEditorElement])
layerId (Optional[str] = '')
context (QgsReadWriteContext = QgsReadWriteContext())

Return type:

Optional[QgsAttributeEditorElement]

clearTabs(self)[source]¶: Clears all the tabs for the attribute editor form with EditorLayout.TabLayout.

dataDefinedFieldProperties(self, fieldName: str | None) → QgsPropertyCollection[source]¶

Returns data defined properties for fieldName

Added in version 3.14.

Parameters:: fieldName (Optional[str])
Return type:: QgsPropertyCollection

initCode(self) → str[source]¶

Gets Python code for edit form initialization.

Return type:: str

initCodeSource(self) → Qgis.AttributeFormPythonInitCodeSource[source]¶

Returns Python code source for edit form initialization (if it shall be loaded from a file, read from the provided dialog editor or inherited from the environment)

Return type:: Qgis.AttributeFormPythonInitCodeSource

initFilePath(self) → str[source]¶

Gets Python external file path for edit form initialization.

Return type:: str

initFunction(self) → str[source]¶

Gets Python function for edit form initialization. Will be looked up in a Python file relative to the project folder if it includes a module name or if it’s a pure function name it will searched in the Python code set with setInitCode().

Return type:: str

invisibleRootContainer(self) → QgsAttributeEditorContainer | None[source]¶

Gets the invisible root container for the drag and drop designer form (EditorLayout.TabLayout).

Added in version 3.

Return type:: Optional[QgsAttributeEditorContainer]

labelOnTop(self, idx: int) → bool[source]¶

If this returns True, the widget at the given index will receive its label on the previous line while if it returns False, the widget will receive its label on the left hand side. Labeling on top leaves more horizontal space for the widget itself.

Parameters:: idx (int)
Return type:: bool

layout(self) → Qgis.AttributeFormLayout[source]¶

Gets the active layout style for the attribute editor for this layer

Return type:: Qgis.AttributeFormLayout

propertyDefinitions() → Dict[int, QgsPropertyDefinition]¶

Returns data defined property definitions.

Added in version 3.14.

Return type:: Dict[int, QgsPropertyDefinition]

readOnly(self, idx: int) → bool[source]¶

This returns True if the field is manually set to read only or if the field does not support editing like joins or virtual fields.

Parameters:: idx (int)
Return type:: bool

readXml(self, node: QDomNode, context: QgsReadWriteContext)[source]¶

Read XML information Deserialize on project load

Parameters:

node (QDomNode)
context (QgsReadWriteContext)

removeWidgetConfig(self, widgetName: str | None) → bool[source]¶

Remove the configuration for the editor widget with the given name

Parameters:: widgetName (Optional[str]) – The name of the widget.
Return type:: bool
Returns:: True if a configuration has been removed

reuseLastValue(self, index: int) → bool[source]¶

If this returns True, the widget at the given index will remember the previously entered value from this QGIS session when creating new features.

Example¶

editFormConfig = layer.editFormConfig()
editFormConfig.setWidgetConfig( 'relation_id', { 'nm-rel': 'other_relation' } )
layer.setEditFormConfig(editFormConfig)

type widgetName:: Optional[str]
param widgetName:: The name of the widget to configure
type config:: Dict[str, Any]
param config:: The config to set for this widget
rtype:: bool
return:: False if a field exists with the provided widgetName. In this case QgsVectorLayer.setEditorWidgetSetup should be used.