Class: QgsAttributeEditorContext

class qgis.gui.QgsAttributeEditorContext

Bases: sip.wrapper

Constructor for QgsAttributeEditorContext

QgsAttributeEditorContext(parentContext: QgsAttributeEditorContext, formMode: QgsAttributeEditorContext.FormMode)

QgsAttributeEditorContext(parentContext: QgsAttributeEditorContext, relation: QgsRelation, relationMode: QgsAttributeEditorContext.RelationMode, widgetMode: QgsAttributeEditorContext.FormMode)

QgsAttributeEditorContext(QgsAttributeEditorContext)

This class contains context information for attribute editor widgets. It will be passed to embedded widgets whenever this occurs (e.g. when showing an embedded form due to relations)

Methods

allowCustomUi

Returns True if the attribute editor should permit use of custom UI forms.

attributeFormMode

Returns current attributeFormMode

attributeFormModeString

Returns given attributeFormMode as string

cadDockWidget

Returns the associated CAD dock widget (e.g.

distanceArea

Returns the distance area object used for area/length calculations.

formFeature

Returns current feature from the currently edited form or table row

formMode

Returns the form mode.

mapCanvas

Returns the associated map canvas (e.g.

parentContext

rtype

QgsAttributeEditorContext

relation

Returns the attribute relation.

relationMode

Returns the attribute relation mode.

setAllowCustomUi

Sets whether the attribute editor should permit use of custom UI forms.

setAttributeFormMode

Set attributeFormMode for the edited form

setCadDockWidget

Sets the associated CAD dock widget, cadDockWidget, (e.g.

setDistanceArea

Sets distance area object, distanceArea, for area/length calculations

setFormFeature

Set current feature for the currently edited form or table row

setFormMode

Sets the form mode.

setMapCanvas

Sets the associated map canvas, mapCanvas, (e.g.

setRelation

Set attribute relation and mode

setVectorLayerTools

Sets the associated vector layer tools.

vectorLayerTools

Returns the associated vector layer tools.

Attributes

AddFeatureMode

AggregateSearchMode

Embed

IdentifyMode

MultiEditMode

Multiple

Popup

SearchMode

Single

SingleEditMode

StandaloneDialog

Undefined

staticMetaObject

AddFeatureMode = 1
AggregateSearchMode = 4
Embed = 0
class FormMode

Bases: int

IdentifyMode = 5
class Mode

Bases: int

baseClass

alias of QgsAttributeEditorContext

MultiEditMode = 2
Multiple = 1
Popup = 2
class RelationMode

Bases: int

SearchMode = 3
Single = 2
SingleEditMode = 0
StandaloneDialog = 1
Undefined = 0
allowCustomUi(self) → bool

Returns True if the attribute editor should permit use of custom UI forms.

New in version 2.16.

Return type

bool

attributeFormMode(self) → QgsAttributeEditorContext.Mode

Returns current attributeFormMode

New in version 3.4.

Return type

QgsAttributeEditorContext.Mode

attributeFormModeString(self) → str

Returns given attributeFormMode as string

New in version 3.4.

Return type

str

cadDockWidget(self) → QgsAdvancedDigitizingDockWidget

Returns the associated CAD dock widget (e.g. to be used in map tools).

Note

Unstable API. This method is unstable API and may be modified or removed at any time.

New in version 3.10.

Return type

QgsAdvancedDigitizingDockWidget

distanceArea(self) → QgsDistanceArea

Returns the distance area object used for area/length calculations.

New in version 2.2.

Return type

QgsDistanceArea

formFeature(self) → QgsFeature

Returns current feature from the currently edited form or table row

See also

setFormFeature()

New in version 3.2.

Return type

QgsFeature

formMode(self) → QgsAttributeEditorContext.FormMode

Returns the form mode.

See also

setFormMode()

Return type

QgsAttributeEditorContext.FormMode

mapCanvas(self) → QgsMapCanvas

Returns the associated map canvas (e.g. to zoom to related features).

See also

setMapCanvas()

New in version 3.2.

Return type

QgsMapCanvas

parentContext(self) → QgsAttributeEditorContext
Return type

QgsAttributeEditorContext

relation(self) → QgsRelation

Returns the attribute relation.

See also

setRelation()

See also

relationMode()

New in version 2.6.

Return type

QgsRelation

relationMode(self) → QgsAttributeEditorContext.RelationMode

Returns the attribute relation mode.

See also

setRelation()

See also

relation()

New in version 2.6.

Return type

QgsAttributeEditorContext.RelationMode

setAllowCustomUi(self, allow: bool)

Sets whether the attribute editor should permit use of custom UI forms.

Parameters

allow (bool) – set to True to allow custom UI forms, or False to disable them and use default generated QGIS forms

See also

allowCustomUi()

New in version 2.16.

setAttributeFormMode(self, attributeFormMode: QgsAttributeEditorContext.Mode)

Set attributeFormMode for the edited form

New in version 3.4.

Parameters

attributeFormMode (QgsAttributeEditorContext.Mode) –

setCadDockWidget(self, cadDockWidget: QgsAdvancedDigitizingDockWidget)

Sets the associated CAD dock widget, cadDockWidget, (e.g. to be used in map tools).

Note

Unstable API. This method is unstable API and may be modified or removed at any time.

See also

cadDockWidget()

New in version 3.10.

Parameters

cadDockWidget (QgsAdvancedDigitizingDockWidget) –

setDistanceArea(self, distanceArea: QgsDistanceArea)

Sets distance area object, distanceArea, for area/length calculations

See also

distanceArea()

New in version 2.2.

Parameters

distanceArea (QgsDistanceArea) –

setFormFeature(self, feature: QgsFeature)

Set current feature for the currently edited form or table row

See also

formFeature()

New in version 3.2.

Parameters

feature (QgsFeature) –

setFormMode(self, mode: QgsAttributeEditorContext.FormMode)

Sets the form mode.

Parameters

mode (QgsAttributeEditorContext.FormMode) – form mode

See also

formMode()

New in version 2.16.

setMapCanvas(self, mapCanvas: QgsMapCanvas)

Sets the associated map canvas, mapCanvas, (e.g. to zoom to related features).

See also

mapCanvas()

New in version 3.2.

Parameters

mapCanvas (QgsMapCanvas) –

setRelation(self, relation: QgsRelation, mode: QgsAttributeEditorContext.RelationMode)

Set attribute relation and mode

Parameters

See also

relation()

See also

relationMode()

New in version 2.6.

setVectorLayerTools(self, vlTools: QgsVectorLayerTools)

Sets the associated vector layer tools.

Parameters

vlTools (QgsVectorLayerTools) – vector layer tools

New in version 2.2.

staticMetaObject = <PyQt5.QtCore.QMetaObject object>
vectorLayerTools(self) → QgsVectorLayerTools

Returns the associated vector layer tools.

New in version 2.2.

Return type

QgsVectorLayerTools