This class contains context information for attribute editor widgets. More...

#include <qgsattributeeditorcontext.h>

Public Types
enum	FormMode { Embed , StandaloneDialog , Popup }

enum	Mode { SingleEditMode , AddFeatureMode , FixAttributeMode , MultiEditMode , SearchMode , AggregateSearchMode , IdentifyMode }
	modes More...

enum	RelationMode { Undefined , Multiple , Single }
	Determines in which direction a relation was resolved. More...

Public Member Functions
	QgsAttributeEditorContext ()=default

	QgsAttributeEditorContext (const QgsAttributeEditorContext &parentContext, const QgsRelation &relation, RelationMode relationMode, FormMode widgetMode)

	QgsAttributeEditorContext (const QgsAttributeEditorContext &parentContext, FormMode formMode)

bool	allowCustomUi () const
	Returns `true` if the attribute editor should permit use of custom UI forms.

Mode	attributeFormMode () const
	Returns current attributeFormMode.

QString	attributeFormModeString () const
	Returns given attributeFormMode as string.

QgsAdvancedDigitizingDockWidget *	cadDockWidget () const
	Returns the associated CAD dock widget (e.g.

const QgsDistanceArea &	distanceArea () const
	Returns the distance area object used for area/length calculations.

QgsFeature	formFeature () const
	Returns current feature from the currently edited form or table row.

FormMode	formMode () const
	Returns the form mode.

QgsMessageBar *	mainMessageBar ()
	Returns the main message bar.

QgsMapCanvas *	mapCanvas () const
	Returns the associated map canvas (e.g.

const QgsAttributeEditorContext *	parentContext () const

QgsFeature	parentFormFeature () const
	Returns the feature of the currently edited parent form in its actual state.

const QgsRelation &	relation () const
	Returns the attribute relation.

RelationMode	relationMode () const
	Returns the attribute relation mode.

void	setAllowCustomUi (bool allow)
	Sets whether the attribute editor should permit use of custom UI forms.

void	setAttributeFormMode (const Mode &attributeFormMode)
	Set attributeFormMode for the edited form.

void	setCadDockWidget (QgsAdvancedDigitizingDockWidget *cadDockWidget)
	Sets the associated CAD dock widget, cadDockWidget, (e.g.

void	setDistanceArea (const QgsDistanceArea &distanceArea)
	Sets distance area object, distanceArea, for area/length calculations.

void	setFormFeature (const QgsFeature &feature)
	Set current feature for the currently edited form or table row.

void	setFormMode (FormMode mode)
	Sets the form mode.

void	setMainMessageBar (QgsMessageBar *messageBar)
	Set current messageBar as the main message bar.

void	setMapCanvas (QgsMapCanvas *mapCanvas)
	Sets the associated map canvas, mapCanvas, (e.g.

void	setParentFormFeature (const QgsFeature &feature)
	Sets the feature of the currently edited parent form.

void	setRelation (const QgsRelation &relation, RelationMode mode)
	Set attribute relation and mode.

void	setVectorLayerTools (QgsVectorLayerTools *vlTools)
	Sets the associated vector layer tools.

const QgsVectorLayerTools *	vectorLayerTools () const
	Returns the associated vector layer tools.

Detailed Description

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)

Definition at line 40 of file qgsattributeeditorcontext.h.

Member Enumeration Documentation

◆ FormMode

enum QgsAttributeEditorContext::FormMode

Enumerator
Embed	A form was embedded as a widget on another form.
StandaloneDialog	A form was opened as a new dialog.
Popup	A widget was opened as a popup (e.g. attribute table editor widget)

Definition at line 70 of file qgsattributeeditorcontext.h.

◆ Mode

enum QgsAttributeEditorContext::Mode

modes

Enumerator
SingleEditMode	Single edit mode, for editing a single feature.
AddFeatureMode	Add feature mode, for setting attributes for a new feature. In this mode the dialog will be editable even with an invalid feature and will add a new feature when the form is accepted.
FixAttributeMode	Fix feature mode, for modifying the feature attributes without saving. The updated feature is available via `feature()` after `save()`
MultiEditMode	Multi edit mode, for editing fields of multiple features at once.
SearchMode	Form values are used for searching/filtering the layer.
AggregateSearchMode	Form is in aggregate search mode, show each widget in this mode.
IdentifyMode	Identify the feature.

Definition at line 47 of file qgsattributeeditorcontext.h.

◆ RelationMode

enum QgsAttributeEditorContext::RelationMode

Determines in which direction a relation was resolved.

Enumerator
Undefined	This context is not defined by a relation.
Multiple	When showing a list of features (e.g. houses as an embedded form in a district form)
Single	When showing a single feature (e.g. district information when looking at the form of a house)

Definition at line 63 of file qgsattributeeditorcontext.h.

Constructor & Destructor Documentation

◆ QgsAttributeEditorContext() [1/3]

QgsAttributeEditorContext::QgsAttributeEditorContext ( )

default

◆ QgsAttributeEditorContext() [2/3]

QgsAttributeEditorContext::QgsAttributeEditorContext	(	const QgsAttributeEditorContext &	parentContext,
		FormMode	formMode
	)

inline

Definition at line 79 of file qgsattributeeditorcontext.h.

◆ QgsAttributeEditorContext() [3/3]

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

inline

Definition at line 92 of file qgsattributeeditorcontext.h.

Member Function Documentation

◆ allowCustomUi()

bool QgsAttributeEditorContext::allowCustomUi ( ) const

inline

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

See also: setAllowCustomUi()

Definition at line 209 of file qgsattributeeditorcontext.h.

◆ attributeFormMode()

Mode QgsAttributeEditorContext::attributeFormMode ( ) const

inline

Returns current attributeFormMode.

Since: QGIS 3.4

Definition at line 253 of file qgsattributeeditorcontext.h.

◆ attributeFormModeString()

QString QgsAttributeEditorContext::attributeFormModeString ( ) const

inline

Returns given attributeFormMode as string.

Since: QGIS 3.4

Definition at line 265 of file qgsattributeeditorcontext.h.

◆ cadDockWidget()

QgsAdvancedDigitizingDockWidget * QgsAttributeEditorContext::cadDockWidget ( ) const

inline

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.

See also: setCadDockWidget()

Since: QGIS 3.10

Definition at line 153 of file qgsattributeeditorcontext.h.

◆ distanceArea()

const QgsDistanceArea & QgsAttributeEditorContext::distanceArea ( ) const

inline

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

See also: setDistanceArea()

Definition at line 123 of file qgsattributeeditorcontext.h.

◆ formFeature()

QgsFeature QgsAttributeEditorContext::formFeature ( ) const

inline

Returns current feature from the currently edited form or table row.

See also: setFormFeature()

Since: QGIS 3.2

Definition at line 226 of file qgsattributeeditorcontext.h.

◆ formMode()

FormMode QgsAttributeEditorContext::formMode ( ) const

inline

Returns the form mode.

See also: setFormMode()

Definition at line 196 of file qgsattributeeditorcontext.h.

◆ mainMessageBar()

QgsMessageBar * QgsAttributeEditorContext::mainMessageBar ( )

inline

Returns the main message bar.

Since: QGIS 3.12

Definition at line 281 of file qgsattributeeditorcontext.h.

◆ mapCanvas()

QgsMapCanvas * QgsAttributeEditorContext::mapCanvas ( ) const

inline

Returns the associated map canvas (e.g.

to zoom to related features).

See also: setMapCanvas()

Since: QGIS 3.2

Definition at line 137 of file qgsattributeeditorcontext.h.

◆ parentContext()

const QgsAttributeEditorContext * QgsAttributeEditorContext::parentContext ( ) const

inline

Definition at line 219 of file qgsattributeeditorcontext.h.

◆ parentFormFeature()

QgsFeature QgsAttributeEditorContext::parentFormFeature ( ) const

inline

Returns the feature of the currently edited parent form in its actual state.

See also: setParentFormFeature()

Since: QGIS 3.14

Definition at line 240 of file qgsattributeeditorcontext.h.

◆ relation()

const QgsRelation & QgsAttributeEditorContext::relation ( ) const

inline

Returns the attribute relation.

See also: setRelation(); relationMode()

Definition at line 183 of file qgsattributeeditorcontext.h.

◆ relationMode()

RelationMode QgsAttributeEditorContext::relationMode ( ) const

inline

Returns the attribute relation mode.

See also: setRelation(); relation()

Definition at line 190 of file qgsattributeeditorcontext.h.

◆ setAllowCustomUi()

void QgsAttributeEditorContext::setAllowCustomUi ( bool allow )

inline

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

Parameters

allow set to true to allow custom UI forms, or false to disable them and use default generated QGIS forms

See also: allowCustomUi()

Definition at line 217 of file qgsattributeeditorcontext.h.

◆ setAttributeFormMode()

void QgsAttributeEditorContext::setAttributeFormMode ( const Mode & attributeFormMode )

inline

Set attributeFormMode for the edited form.

Since: QGIS 3.4

Definition at line 259 of file qgsattributeeditorcontext.h.

◆ setCadDockWidget()

void QgsAttributeEditorContext::setCadDockWidget ( QgsAdvancedDigitizingDockWidget * cadDockWidget )

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()

Since: QGIS 3.10

Definition at line 18 of file qgsattributeeditorcontext.cpp.

◆ setDistanceArea()

void QgsAttributeEditorContext::setDistanceArea ( const QgsDistanceArea & distanceArea )

inline

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

See also: distanceArea()

Definition at line 110 of file qgsattributeeditorcontext.h.

◆ setFormFeature()

void QgsAttributeEditorContext::setFormFeature ( const QgsFeature & feature )

inline

Set current feature for the currently edited form or table row.

See also: formFeature()

Since: QGIS 3.2

Definition at line 233 of file qgsattributeeditorcontext.h.

◆ setFormMode()

void QgsAttributeEditorContext::setFormMode ( FormMode mode )

inline

Sets the form mode.

Parameters

mode form mode

See also: formMode()

Definition at line 203 of file qgsattributeeditorcontext.h.

◆ setMainMessageBar()

void QgsAttributeEditorContext::setMainMessageBar ( QgsMessageBar * messageBar )

inline

Set current messageBar as the main message bar.

Since: QGIS 3.12

Definition at line 275 of file qgsattributeeditorcontext.h.

◆ setMapCanvas()

void QgsAttributeEditorContext::setMapCanvas ( QgsMapCanvas * mapCanvas )

inline

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

to zoom to related features).

See also: mapCanvas()

Since: QGIS 3.2

Definition at line 130 of file qgsattributeeditorcontext.h.

◆ setParentFormFeature()

void QgsAttributeEditorContext::setParentFormFeature ( const QgsFeature & feature )

inline

Sets the feature of the currently edited parent form.

See also: parentFormFeature()

Since: QGIS 3.14

Definition at line 247 of file qgsattributeeditorcontext.h.

◆ setRelation()

void QgsAttributeEditorContext::setRelation	(	const QgsRelation &	relation,
		RelationMode	mode
	)

inline

Set attribute relation and mode.

Parameters

relation	relation
mode	relation mode

See also: relation(); relationMode()

Definition at line 176 of file qgsattributeeditorcontext.h.

◆ setVectorLayerTools()

void QgsAttributeEditorContext::setVectorLayerTools ( QgsVectorLayerTools * vlTools )

inline

Sets the associated vector layer tools.

Parameters

vlTools vector layer tools

See also: vectorLayerTools()

Definition at line 160 of file qgsattributeeditorcontext.h.

◆ vectorLayerTools()

const QgsVectorLayerTools * QgsAttributeEditorContext::vectorLayerTools ( ) const

inline

Returns the associated vector layer tools.

See also: setVectorLayerTools()

Definition at line 167 of file qgsattributeeditorcontext.h.

The documentation for this class was generated from the following files:

/build/qgis-3.40.0+99sid/src/gui/qgsattributeeditorcontext.h
/build/qgis-3.40.0+99sid/src/gui/qgsattributeeditorcontext.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ FormMode

◆ Mode

◆ RelationMode

Constructor & Destructor Documentation

◆ QgsAttributeEditorContext() [1/3]

◆ QgsAttributeEditorContext() [2/3]

◆ QgsAttributeEditorContext() [3/3]

Member Function Documentation

◆ allowCustomUi()

◆ attributeFormMode()

◆ attributeFormModeString()

◆ cadDockWidget()

◆ distanceArea()

◆ formFeature()

◆ formMode()

◆ mainMessageBar()

◆ mapCanvas()

◆ parentContext()

◆ parentFormFeature()

◆ relation()

◆ relationMode()

◆ setAllowCustomUi()

◆ setAttributeFormMode()

◆ setCadDockWidget()

◆ setDistanceArea()

◆ setFormFeature()

◆ setFormMode()

◆ setMainMessageBar()

◆ setMapCanvas()

◆ setParentFormFeature()

◆ setRelation()

◆ setVectorLayerTools()

◆ vectorLayerTools()