Class: QgsWidgetWrapper

class qgis.gui.QgsWidgetWrapper

Bases: PyQt5.QtCore.QObject

Manages an editor widget Widget and wrapper share the same parent

A wrapper controls one attribute editor widget and is able to create a default widget or use a pre-existent widget. It is able to set the widget to the value implied by a field of a vector layer, or return the value it currently holds. Every time it is changed it has to emit a valueChanged signal. If it fails to do so, there is no guarantee that the changed status of the widget will be saved.

QgsWidgetWrapper(vl: Optional[QgsVectorLayer], editor: Optional[QWidget] = None, parent: Optional[QWidget] = None) Create a new widget wrapper

Parameters:
  • vl – The layer on which the field is

  • editor – An editor widget. Can be None if one should be autogenerated.

  • parent

    A parent widget for this widget wrapper and the created widget.

    Enums

    Property

    Bases: enum.IntEnum

    Methods

    childEvent

    config

    Use this inside your overridden classes to access the configuration.

    connectNotify

    context

    Returns information about the context in which this widget is shown

    createWidget

    This method should create a new widget with the provided parent.

    customEvent

    dataDefinedProperties

    Returns a reference to the editor widget's property collection, used for data defined overrides.

    disconnectNotify

    fromWidget

    Will return a wrapper for a given widget

    initWidget

    This method should initialize the editor widget with runtime data.

    isSignalConnected

    layer

    Returns the vector layer associated with the widget.

    notifyAboutToSave

    Notify this widget, that the containing form is about to save and that any pending changes should be pushed to the edit buffer or they might be lost.

    propertyDefinitions

    Returns the editor widget property definitions.

    receivers

    sender

    senderSignalIndex

    setConfig

    Will set the config of this wrapper to the specified config.

    setContext

    Set the context in which this widget is shown

    setDataDefinedProperties

    Sets the editor widget's property collection, used for data defined overrides.

    setEnabled

    Is used to enable or disable the edit functionality of the managed widget.

    setFeature

    Is called when the value of the widget needs to be changed.

    timerEvent

    valid

    Returns True if the widget has been properly initialized.

    widget

    Access the widget managed by this wrapper

    Signals

    contextChanged

    pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

class Property(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Data defined properties for different editor widgets.

  • RootPath: Root path for external resource

  • DocumentViewerContent: Document type for external resource

  • StorageUrl: Storage URL for external resource

childEvent(self, a0: QChildEvent | None)
config(self, key: str | None, defaultVal: Any = None) Any

Use this inside your overridden classes to access the configuration.

Parameters:
  • key (Optional[str]) – The configuration option you want to load

  • defaultVal (Any = None) – Default value

Return type:

Any

Returns:

the value assigned to this configuration option

config(self) -> Dict[str, Any] Returns the whole config

connectNotify(self, signal: QMetaMethod)
context(self) QgsAttributeEditorContext

Returns information about the context in which this widget is shown

Return type:

QgsAttributeEditorContext

contextChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:
  • name (str = ...)

  • revision (int = ...)

  • arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

createWidget(self, parent: QWidget | None) QWidget | None

This method should create a new widget with the provided parent. This will only be called if the form did not already provide a widget, so it is not guaranteed to be called! You should not do initialization stuff, which also has to be done for custom editor widgets inside this method. Things like filling comboboxes and assigning other data which will also be used to make widgets on forms created in the QtDesigner usable should be assigned in initWidget().

Parameters:

parent (Optional[QWidget]) – You should set this parent on the created widget.

Return type:

Optional[QWidget]

Returns:

A new widget

customEvent(self, a0: QEvent | None)
dataDefinedProperties(self) QgsPropertyCollection

Returns a reference to the editor widget’s property collection, used for data defined overrides.

See also

Property

Return type:

QgsPropertyCollection

disconnectNotify(self, signal: QMetaMethod)
fromWidget(widget: QWidget | None) QgsWidgetWrapper | None

Will return a wrapper for a given widget

Parameters:

widget (Optional[QWidget]) – The widget which was created by a wrapper

Return type:

Optional[QgsWidgetWrapper]

Returns:

The wrapper for the widget or None

initWidget(self, editor: QWidget | None)

This method should initialize the editor widget with runtime data. Fill your comboboxes here.

Parameters:

editor (Optional[QWidget]) – The widget which will represent this attribute editor in a form.

isSignalConnected(self, signal: QMetaMethod) bool
layer(self) QgsVectorLayer | None

Returns the vector layer associated with the widget.

Return type:

Optional[QgsVectorLayer]

notifyAboutToSave(self)

Notify this widget, that the containing form is about to save and that any pending changes should be pushed to the edit buffer or they might be lost.

Added in version 3.2.

propertyDefinitions() Dict[int, QgsPropertyDefinition]

Returns the editor widget property definitions.

Return type:

Dict[int, QgsPropertyDefinition]

receivers(self, signal: PYQT_SIGNAL) int
sender(self) QObject | None
senderSignalIndex(self) int
setConfig(self, config: Dict[str, Any])

Will set the config of this wrapper to the specified config.

Parameters:

config (Dict[str) – The config for this wrapper

setContext(self, context: QgsAttributeEditorContext)

Set the context in which this widget is shown

Parameters:

context (QgsAttributeEditorContext) – context information

setDataDefinedProperties(self, collection: QgsPropertyCollection)

Sets the editor widget’s property collection, used for data defined overrides.

Parameters:

collection (QgsPropertyCollection) – property collection. Existing properties will be replaced.

See also

Property

setEnabled(self, enabled: bool)

Is used to enable or disable the edit functionality of the managed widget. By default this will not change the enabled state of the widget

Parameters:

enabled (bool) – Enable or Disable?

setFeature(self, feature: QgsFeature)

Is called when the value of the widget needs to be changed. Updates the widget representation to reflect the new value.

Parameters:

feature (QgsFeature) – The new feature

timerEvent(self, a0: QTimerEvent | None)
valid(self) bool

Returns True if the widget has been properly initialized. This acts as hint for the calling party if this wrapper can be used after initializing it. If it cannot be used this is a hint to the caller that he may try to find another suitable widget type instead.

Return type:

bool

Returns:

Validity status of this widget.

widget(self) QWidget | None

Access the widget managed by this wrapper

Return type:

Optional[QWidget]

Returns:

The widget