QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
qgsattributeeditorcontext.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsattributeeditorcontext.h
3 --------------------------------------
4 Date : 30.7.2013
5 Copyright : (C) 2013 Matthias Kuhn
6 Email : matthias at opengis dot ch
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSATTRIBUTEEDITORCONTEXT_H
17#define QGSATTRIBUTEEDITORCONTEXT_H
18
19#include <QMap>
20#include <QWidget>
21#include <QMetaEnum>
22
23#include "qgsdistancearea.h"
24#include "qgsvectorlayertools.h"
25#include "qgsvectorlayer.h"
26#include "qgis_gui.h"
27#include "qgsproject.h"
28
29class QgsMapCanvas;
31class QgsMessageBar;
32
41{
42 Q_GADGET
43
44 public:
45
58 Q_ENUM( Mode )
59
60
64 {
67 Single
68 };
69
71 {
74 Popup
75 };
76
78
80 : mParentContext( &parentContext )
81 , mVectorLayerTools( parentContext.mVectorLayerTools )
82 , mMapCanvas( parentContext.mMapCanvas )
83 , mMainMessageBar( parentContext.mMainMessageBar )
84 , mCadDockWidget( parentContext.mCadDockWidget )
85 , mDistanceArea( parentContext.mDistanceArea )
86 , mFormFeature( parentContext.mFormFeature )
87 , mFormMode( formMode )
88 {
89 Q_ASSERT( parentContext.vectorLayerTools() );
90 }
91
92 QgsAttributeEditorContext( const QgsAttributeEditorContext &parentContext, const QgsRelation &relation, RelationMode relationMode, FormMode widgetMode )
93 : mParentContext( &parentContext )
94 , mVectorLayerTools( parentContext.mVectorLayerTools )
95 , mMapCanvas( parentContext.mMapCanvas )
96 , mMainMessageBar( parentContext.mMainMessageBar )
97 , mCadDockWidget( parentContext.mCadDockWidget )
98 , mDistanceArea( parentContext.mDistanceArea )
99 , mRelation( relation )
100 , mRelationMode( relationMode )
101 , mFormMode( widgetMode )
102 {
103 Q_ASSERT( parentContext.vectorLayerTools() );
104 }
105
110 inline void setDistanceArea( const QgsDistanceArea &distanceArea )
111 {
112 if ( mLayer )
113 {
114 mDistanceArea = distanceArea;
115 mDistanceArea.setSourceCrs( mLayer->crs(), QgsProject::instance()->transformContext() );
116 }
117 }
118
123 inline const QgsDistanceArea &distanceArea() const { return mDistanceArea; }
124
130 inline void setMapCanvas( QgsMapCanvas *mapCanvas ) { mMapCanvas = mapCanvas; }
131
137 inline QgsMapCanvas *mapCanvas() const { return mMapCanvas; }
138
145 void setCadDockWidget( QgsAdvancedDigitizingDockWidget *cadDockWidget );
146
153 QgsAdvancedDigitizingDockWidget *cadDockWidget() const { return mCadDockWidget; }
154
160 inline void setVectorLayerTools( QgsVectorLayerTools *vlTools ) { mVectorLayerTools = vlTools; }
161 // TODO QGIS 4.0 - rename vlTools to tools
162
167 inline const QgsVectorLayerTools *vectorLayerTools() const { return mVectorLayerTools; }
168
176 inline void setRelation( const QgsRelation &relation, RelationMode mode ) { mRelation = relation; mRelationMode = mode; }
177
183 inline const QgsRelation &relation() const { return mRelation; }
184
190 inline RelationMode relationMode() const { return mRelationMode; }
191
196 inline FormMode formMode() const { return mFormMode; }
197
203 inline void setFormMode( FormMode mode ) { mFormMode = mode; }
204
209 bool allowCustomUi() const { return mAllowCustomUi; }
210
217 void setAllowCustomUi( bool allow ) { mAllowCustomUi = allow; }
218
219 inline const QgsAttributeEditorContext *parentContext() const { return mParentContext; }
220
226 QgsFeature formFeature() const { return mFormFeature; }
227
233 void setFormFeature( const QgsFeature &feature ) { mFormFeature = feature ; }
234
240 QgsFeature parentFormFeature() const { return mParentFormFeature; }
241
247 void setParentFormFeature( const QgsFeature &feature ) { mParentFormFeature = feature ; }
248
253 Mode attributeFormMode() const { return mAttributeFormMode; }
254
259 void setAttributeFormMode( const Mode &attributeFormMode ) { mAttributeFormMode = attributeFormMode; }
260
266 {
267 const QMetaEnum metaEnum( QMetaEnum::fromType<Mode>() );
268 return metaEnum.valueToKey( static_cast<int>( mAttributeFormMode ) );
269 }
270
275 void setMainMessageBar( QgsMessageBar *messageBar ) { mMainMessageBar = messageBar; }
276
281 QgsMessageBar *mainMessageBar() { return mMainMessageBar; }
282
283 private:
284 const QgsAttributeEditorContext *mParentContext = nullptr;
285 QgsVectorLayer *mLayer = nullptr;
286 QgsVectorLayerTools *mVectorLayerTools = nullptr;
287 QgsMapCanvas *mMapCanvas = nullptr;
288 QgsMessageBar *mMainMessageBar = nullptr;
289 QgsAdvancedDigitizingDockWidget *mCadDockWidget = nullptr;
290 QgsDistanceArea mDistanceArea;
291 QgsRelation mRelation;
292 RelationMode mRelationMode = Undefined;
294 QgsFeature mFormFeature;
296 QgsFeature mParentFormFeature;
297 FormMode mFormMode = Embed;
298 bool mAllowCustomUi = true;
299 Mode mAttributeFormMode = SingleEditMode;
300};
301
302#endif // QGSATTRIBUTEEDITORCONTEXT_H
The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of...
This class contains context information for attribute editor widgets.
void setMapCanvas(QgsMapCanvas *mapCanvas)
Sets the associated map canvas, mapCanvas, (e.g.
RelationMode relationMode() const
Returns the attribute relation mode.
QgsAttributeEditorContext()=default
QgsMapCanvas * mapCanvas() const
Returns the associated map canvas (e.g.
FormMode formMode() const
Returns the form mode.
void setFormFeature(const QgsFeature &feature)
Set current feature for the currently edited form or table row.
void setRelation(const QgsRelation &relation, RelationMode mode)
Set attribute relation and mode.
const QgsDistanceArea & distanceArea() const
Returns the distance area object used for area/length calculations.
QgsAdvancedDigitizingDockWidget * cadDockWidget() const
Returns the associated CAD dock widget (e.g.
QString attributeFormModeString() const
Returns given attributeFormMode as string.
RelationMode
Determines in which direction a relation was resolved.
@ Multiple
When showing a list of features (e.g. houses as an embedded form in a district form)
@ Undefined
This context is not defined by a relation.
QgsFeature parentFormFeature() const
Returns the feature of the currently edited parent form in its actual state.
const QgsVectorLayerTools * vectorLayerTools() const
Returns the associated vector layer tools.
@ Embed
A form was embedded as a widget on another form.
@ StandaloneDialog
A form was opened as a new dialog.
void setParentFormFeature(const QgsFeature &feature)
Sets the feature of the currently edited parent form.
QgsAttributeEditorContext(const QgsAttributeEditorContext &parentContext, const QgsRelation &relation, RelationMode relationMode, FormMode widgetMode)
void setFormMode(FormMode mode)
Sets the form mode.
QgsMessageBar * mainMessageBar()
Returns the main message bar.
void setVectorLayerTools(QgsVectorLayerTools *vlTools)
Sets the associated vector layer tools.
void setMainMessageBar(QgsMessageBar *messageBar)
Set current messageBar as the main message bar.
QgsAttributeEditorContext(const QgsAttributeEditorContext &parentContext, FormMode formMode)
bool allowCustomUi() const
Returns true if the attribute editor should permit use of custom UI forms.
@ SearchMode
Form values are used for searching/filtering the layer.
@ FixAttributeMode
Fix feature mode, for modifying the feature attributes without saving. The updated feature is availab...
@ SingleEditMode
Single edit mode, for editing a single feature.
@ AggregateSearchMode
Form is in aggregate search mode, show each widget in this mode.
@ MultiEditMode
Multi edit mode, for editing fields of multiple features at once.
void setAttributeFormMode(const Mode &attributeFormMode)
Set attributeFormMode for the edited form.
QgsFeature formFeature() const
Returns current feature from the currently edited form or table row.
void setAllowCustomUi(bool allow)
Sets whether the attribute editor should permit use of custom UI forms.
const QgsAttributeEditorContext * parentContext() const
const QgsRelation & relation() const
Returns the attribute relation.
Mode attributeFormMode() const
Returns current attributeFormMode.
void setDistanceArea(const QgsDistanceArea &distanceArea)
Sets distance area object, distanceArea, for area/length calculations.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Map canvas is a class for displaying all GIS data types on a canvas.
A bar for displaying non-blocking messages to the user.
static QgsProject * instance()
Returns the QgsProject singleton instance.
QgsCoordinateTransformContext transformContext
Definition qgsproject.h:113
Represents a relationship between two vector layers.
Definition qgsrelation.h:44
Methods in this class are used to handle basic operations on vector layers.
Represents a vector layer which manages a vector based data sets.