Class: QgsAttributeFormWidget¶

Base class for all widgets shown on a QgsAttributeForm. Consists of the widget which is visible in edit mode as well as the widget visible in search mode.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: createSearchWidgetWrappers()

Class Hierarchy¶

Base classes¶

QWidget
QObject
QPaintDevice

Subclasses¶

`QgsAttributeFormEditorWidget`	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.
`QgsAttributeFormRelationEditorWidget`	Widget to show for child relations on an attribute form.

Abstract Methods

createSearchWidgetWrappers

Creates the search widget wrappers for the widget used when the form is in search mode.

Methods

`addAdditionalSearchWidgetWrapper`	Adds an additional search widget wrapper.
`form`	The form on which this widget is shown.
`layer`	The layer for which this widget and its form is shown.
`mode`	Returns the current mode for the widget.
`resetSearch`	Resets the search/filter value of the widget.
`searchWidgetToolButtonVisible`	The visibility of the search widget tool button, that allows (de)activating this search widgte or defines the comparison operator to use.
`searchWidgetWrappers`	Returns the search widget wrapper used in this widget.
`setMode`	Sets the current mode for the widget.
`setSearchWidgetToolButtonVisible`	The visibility of the search widget tool button, that allows (de)activating this search widgte or defines the comparison operator to use.
`setSearchWidgetWrapper`	Sets the search widget wrapper for the widget used when the form is in search mode.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsAttributeFormWidget. See the FAQ for more details.

currentFilterExpression

Creates an expression matching the current search filter value and search properties represented in the widget.

Attributes

`AggregateSearchMode`
`DefaultMode`
`MultiEditMode`
`SearchMode`

class qgis.gui.QgsAttributeFormWidget[source]¶

Bases: QWidget

__init__(widget: QgsWidgetWrapper | None, form: QgsAttributeForm | None)

A new form widget for the wrapper widget on form.

Parameters:

widget (Optional[QgsWidgetWrapper])
form (Optional[QgsAttributeForm])

AggregateSearchMode = 3¶

DefaultMode = 0¶

class Mode¶: Bases: int

MultiEditMode = 1¶

SearchMode = 2¶

addAdditionalSearchWidgetWrapper(self, wrapper: QgsSearchWidgetWrapper | None)[source]¶

Adds an additional search widget wrapper. Used to register a secondary search widget as used for “between” searches.

Parameters:: wrapper (Optional[QgsSearchWidgetWrapper])

abstract createSearchWidgetWrappers(self)[source]¶: Creates the search widget wrappers for the widget used when the form is in search mode.

virtual currentFilterExpression(self) → str[source]¶

Creates an expression matching the current search filter value and search properties represented in the widget.

Return type:: str

form(self) → QgsAttributeForm | None[source]¶

The form on which this widget is shown.

Return type:: Optional[QgsAttributeForm]

layer(self) → QgsVectorLayer | None[source]¶

The layer for which this widget and its form is shown.

Return type:: Optional[QgsVectorLayer]

mode(self) → QgsAttributeFormWidget.Mode[source]¶

Returns the current mode for the widget.