QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
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 | |
Constructor for QgsAttributeEditorContext. More... | |
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. More... | |
Mode | attributeFormMode () const |
Returns current attributeFormMode. More... | |
QString | attributeFormModeString () const |
Returns given attributeFormMode as string. More... | |
QgsAdvancedDigitizingDockWidget * | cadDockWidget () const |
Returns the associated CAD dock widget (e.g. More... | |
const QgsDistanceArea & | distanceArea () const |
Returns the distance area object used for area/length calculations. More... | |
QgsFeature | formFeature () const |
Returns current feature from the currently edited form or table row. More... | |
FormMode | formMode () const |
Returns the form mode. More... | |
QgsMessageBar * | mainMessageBar () |
Returns the main message bar. More... | |
QgsMapCanvas * | mapCanvas () const |
Returns the associated map canvas (e.g. More... | |
const QgsAttributeEditorContext * | parentContext () const |
QgsFeature | parentFormFeature () const |
Returns the feature of the currently edited parent form in its actual state. More... | |
const QgsRelation & | relation () const |
Returns the attribute relation. More... | |
RelationMode | relationMode () const |
Returns the attribute relation mode. More... | |
void | setAllowCustomUi (bool allow) |
Sets whether the attribute editor should permit use of custom UI forms. More... | |
void | setAttributeFormMode (const Mode &attributeFormMode) |
Set attributeFormMode for the edited form. More... | |
void | setCadDockWidget (QgsAdvancedDigitizingDockWidget *cadDockWidget) |
Sets the associated CAD dock widget, cadDockWidget, (e.g. More... | |
void | setDistanceArea (const QgsDistanceArea &distanceArea) |
Sets distance area object, distanceArea, for area/length calculations. More... | |
void | setFormFeature (const QgsFeature &feature) |
Set current feature for the currently edited form or table row. More... | |
void | setFormMode (FormMode mode) |
Sets the form mode. More... | |
void | setMainMessageBar (QgsMessageBar *messageBar) |
Set current messageBar as the main message bar. More... | |
void | setMapCanvas (QgsMapCanvas *mapCanvas) |
Sets the associated map canvas, mapCanvas, (e.g. More... | |
void | setParentFormFeature (const QgsFeature &feature) |
Sets the feature of the currently edited parent form. More... | |
void | setRelation (const QgsRelation &relation, RelationMode mode) |
Set attribute relation and mode. More... | |
void | setVectorLayerTools (QgsVectorLayerTools *vlTools) |
Sets the associated vector layer tools. More... | |
const QgsVectorLayerTools * | vectorLayerTools () const |
Returns the associated vector layer tools. More... | |
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.
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.
modes
Definition at line 47 of file qgsattributeeditorcontext.h.
Determines in which direction a relation was resolved.
Definition at line 63 of file qgsattributeeditorcontext.h.
|
default |
Constructor for QgsAttributeEditorContext.
|
inline |
Definition at line 80 of file qgsattributeeditorcontext.h.
|
inline |
Definition at line 93 of file qgsattributeeditorcontext.h.
|
inline |
Returns true
if the attribute editor should permit use of custom UI forms.
Definition at line 219 of file qgsattributeeditorcontext.h.
|
inline |
Returns current attributeFormMode.
Definition at line 264 of file qgsattributeeditorcontext.h.
|
inline |
Returns given attributeFormMode as string.
Definition at line 276 of file qgsattributeeditorcontext.h.
|
inline |
Returns the associated CAD dock widget (e.g.
to be used in map tools).
Definition at line 156 of file qgsattributeeditorcontext.h.
|
inline |
Returns the distance area object used for area/length calculations.
Definition at line 126 of file qgsattributeeditorcontext.h.
|
inline |
Returns current feature from the currently edited form or table row.
Definition at line 237 of file qgsattributeeditorcontext.h.
|
inline |
Returns the form mode.
Definition at line 204 of file qgsattributeeditorcontext.h.
|
inline |
Returns the main message bar.
Definition at line 292 of file qgsattributeeditorcontext.h.
|
inline |
Returns the associated map canvas (e.g.
to zoom to related features).
Definition at line 140 of file qgsattributeeditorcontext.h.
|
inline |
Definition at line 230 of file qgsattributeeditorcontext.h.
|
inline |
Returns the feature of the currently edited parent form in its actual state.
Definition at line 251 of file qgsattributeeditorcontext.h.
|
inline |
Returns the attribute relation.
Definition at line 190 of file qgsattributeeditorcontext.h.
|
inline |
Returns the attribute relation mode.
Definition at line 198 of file qgsattributeeditorcontext.h.
|
inline |
Sets whether the attribute editor should permit use of custom UI forms.
allow | set to true to allow custom UI forms, or false to disable them and use default generated QGIS forms |
Definition at line 228 of file qgsattributeeditorcontext.h.
|
inline |
Set attributeFormMode for the edited form.
Definition at line 270 of file qgsattributeeditorcontext.h.
void QgsAttributeEditorContext::setCadDockWidget | ( | QgsAdvancedDigitizingDockWidget * | cadDockWidget | ) |
Sets the associated CAD dock widget, cadDockWidget, (e.g.
to be used in map tools).
Definition at line 18 of file qgsattributeeditorcontext.cpp.
|
inline |
Sets distance area object, distanceArea, for area/length calculations.
Definition at line 112 of file qgsattributeeditorcontext.h.
|
inline |
Set current feature for the currently edited form or table row.
Definition at line 244 of file qgsattributeeditorcontext.h.
|
inline |
Sets the form mode.
mode | form mode |
Definition at line 212 of file qgsattributeeditorcontext.h.
|
inline |
Set current messageBar as the main message bar.
Definition at line 286 of file qgsattributeeditorcontext.h.
|
inline |
Sets the associated map canvas, mapCanvas, (e.g.
to zoom to related features).
Definition at line 133 of file qgsattributeeditorcontext.h.
|
inline |
Sets the feature of the currently edited parent form.
Definition at line 258 of file qgsattributeeditorcontext.h.
|
inline |
Set attribute relation and mode.
relation | relation |
mode | relation mode |
Definition at line 182 of file qgsattributeeditorcontext.h.
|
inline |
Sets the associated vector layer tools.
vlTools | vector layer tools |
Definition at line 164 of file qgsattributeeditorcontext.h.
|
inline |
Returns the associated vector layer tools.
Definition at line 172 of file qgsattributeeditorcontext.h.