/
qgsattributeform.h
356 lines (292 loc) · 10.9 KB
/
qgsattributeform.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
/***************************************************************************
qgsattributeform.h
--------------------------------------
Date : 3.5.2014
Copyright : (C) 2014 Matthias Kuhn
Email : matthias at opengis dot ch
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSATTRIBUTEFORM_H
#define QGSATTRIBUTEFORM_H
#include "qgsfeature.h"
#include "qgsvectorlayer.h"
#include "qgsattributeeditorcontext.h"
#include <QWidget>
#include <QLabel>
#include <QDialogButtonBox>
class QgsAttributeFormInterface;
class QgsAttributeFormEditorWidget;
class QgsMessageBar;
class QgsMessageBarItem;
class QgsWidgetWrapper;
class GUI_EXPORT QgsAttributeForm : public QWidget
{
Q_OBJECT
public:
//! Form modes
enum Mode
{
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. */
MultiEditMode, /*!< Multi edit mode, for editing fields of multiple features at once */
SearchMode, /*!< Form values are used for searching/filtering the layer */
};
//! Filter types
enum FilterType
{
ReplaceFilter, /*!< Filter should replace any existing filter */
FilterAnd, /*!< Filter should be combined using "AND" */
FilterOr, /*!< Filter should be combined using "OR" */
};
explicit QgsAttributeForm( QgsVectorLayer* vl, const QgsFeature &feature = QgsFeature(), const QgsAttributeEditorContext& context = QgsAttributeEditorContext(), QWidget *parent = nullptr );
~QgsAttributeForm();
const QgsFeature& feature() { return mFeature; }
/**
* Hides the button box (Ok/Cancel) and enables auto-commit
*/
void hideButtonBox();
/**
* Shows the button box (Ok/Cancel) and disables auto-commit
*/
void showButtonBox();
/**
* Disconnects the button box (Ok/Cancel) from the accept/resetValues slots
* If this method is called, you have to create these connections from outside
*/
void disconnectButtonBox();
/**
* Takes ownership
* @param iface
*/
void addInterface( QgsAttributeFormInterface* iface );
/**
* Returns the layer for which this form is shown
*
* @return Layer
*/
QgsVectorLayer* layer() { return mLayer; }
/**
* Returns if the form is currently in editable mode.
*
* @return Editable mode of this form
*/
bool editable();
/** Returns the current mode of the form.
* @note added in QGIS 2.16
* @see setMode()
*/
Mode mode() const { return mMode; }
/** Sets the current mode of the form.
* @param mode form mode
* @note added in QGIS 2.16
* @see mode()
*/
void setMode( Mode mode );
/**
* Toggles the form mode between edit feature and add feature.
* If set to true, the dialog will be editable even with an invalid feature.
* If set to true, the dialog will add a new feature when the form is accepted.
*
* @param isAddDialog If set to true, turn this dialog into an add feature dialog.
* @deprecated use setMode() instead
*/
Q_DECL_DEPRECATED void setIsAddDialog( bool isAddDialog );
/**
* Sets the edit command message (Undo) that will be used when the dialog is accepted
*
* @param message The message
*/
void setEditCommandMessage( const QString& message ) { mEditCommandMessage = message; }
/**
* Intercepts keypress on custom form (escape should not close it)
*
* @param object The object for which the event has been sent
* @param event The event which is being filtered
*
* @return true if the event has been handled (key was ESC)
*/
bool eventFilter( QObject* object, QEvent* event ) override;
/** Sets all feature IDs which are to be edited if the form is in multiedit mode
* @param fids feature ID list
* @note added in QGIS 2.16
*/
void setMultiEditFeatureIds( const QgsFeatureIds& fids );
signals:
/**
* Notifies about changes of attributes
*
* @param attribute The name of the attribute that changed.
* @param value The new value of the attribute.
*/
void attributeChanged( const QString& attribute, const QVariant& value );
/**
* Will be emitted before the feature is saved. Use this signal to perform sanity checks.
* You can set the parameter ok to false to notify the form that you don't want it to be saved.
* If you want the form to be saved, leave the parameter untouched.
*
* @param ok Set this parameter to false if you don't want the form to be saved
* @note not available in python bindings
*/
void beforeSave( bool& ok );
/**
* Is emitted, when a feature is changed or added
*/
void featureSaved( const QgsFeature& feature );
/** Is emitted when a filter expression is set using the form.
* @param expression filter expression
* @param type filter type
* @note added in QGIS 2.16
*/
void filterExpressionSet( const QString& expression, QgsAttributeForm::FilterType type );
/** Emitted when the form changes mode.
* @param mode new mode
*/
void modeChanged( QgsAttributeForm::Mode mode );
public slots:
/**
* Call this to change the content of a given attribute. Will update the editor(s) related to this field.
*
* @param field The field to change
* @param value The new value
*/
void changeAttribute( const QString& field, const QVariant& value );
/**
* Update all editors to correspond to a different feature.
*
* @param feature The feature which will be represented by the form
*/
void setFeature( const QgsFeature& feature );
/**
* Save all the values from the editors to the layer.
*
* @return True if successful
*/
bool save();
/**
* Alias for save()
*
* @deprecated
*/
Q_DECL_DEPRECATED void accept() { save(); }
/**
* Alias for resetValues()
*
* @deprecated
*/
Q_DECL_DEPRECATED void reject() { resetValues(); }
/**
* Sets all values to the values of the current feature
*/
void resetValues();
/** Resets the search/filter form values.
* @note added in QGIS 2.16
*/
void resetSearch();
/**
* reload current feature
*/
void refreshFeature();
private slots:
void onAttributeChanged( const QVariant& value );
void onAttributeAdded( int idx );
void onAttributeDeleted( int idx );
void onUpdatedFields();
void onConstraintStatusChanged( const QString& constraint,
const QString &description, const QString& err, bool ok );
void preventFeatureRefresh();
void synchronizeEnabledState();
void layerSelectionChanged();
//! Save multi edit changes
bool saveMultiEdits();
void resetMultiEdit( bool promptToSave = false );
void multiEditMessageClicked( const QString& link );
void filterAndTriggered();
void filterOrTriggered();
void filterTriggered();
void searchSetSelection();
void searchAddToSelection();
void searchRemoveFromSelection();
void searchIntersectSelection();
private:
void init();
void cleanPython();
void initPython();
struct WidgetInfo
{
WidgetInfo()
: widget( nullptr )
, labelOnTop( false )
, labelAlignRight( false )
{}
QWidget* widget;
QString labelText;
bool labelOnTop;
bool labelAlignRight;
};
WidgetInfo createWidgetFromDef( const QgsAttributeEditorElement* widgetDef, QWidget* parent, QgsVectorLayer* vl, QgsAttributeEditorContext& context );
void addWidgetWrapper( QgsEditorWidgetWrapper* eww );
/**
* Creates widget wrappers for all suitable widgets found.
* Called once maximally.
*/
void createWrappers();
void afterWidgetInit();
void scanForEqualAttributes( QgsFeatureIterator& fit, QSet< int >& mixedValueFields, QHash< int, QVariant >& fieldSharedValues ) const;
//! Save single feature or add feature edits
bool saveEdits();
int messageTimeout();
void clearMultiEditMessages();
void pushSelectedFeaturesMessage();
void runSearchSelect( QgsVectorLayer::SelectBehaviour behaviour );
QString createFilterExpression() const;
//! constraints management
void updateAllConstaints();
void updateConstraints( QgsEditorWidgetWrapper *w );
bool currentFormFeature( QgsFeature &feature );
bool currentFormValidConstraints( QStringList &invalidFields, QStringList &descriptions );
void constraintDependencies( QgsEditorWidgetWrapper *w, QList<QgsEditorWidgetWrapper*> &wDeps );
void clearInvalidConstraintsMessage();
void displayInvalidConstraintMessage( const QStringList &invalidFields,
const QStringList &description );
void displayNullFieldsMessage();
QgsMessageBarItem *mInvalidConstraintMessageBarItem;
QgsMessageBarItem *mFieldNotInitializedMessageBarItem;
QgsVectorLayer* mLayer;
QgsFeature mFeature;
QgsMessageBar* mMessageBar;
QgsMessageBarItem* mMultiEditUnsavedMessageBarItem;
QgsMessageBarItem* mMultiEditMessageBarItem;
QList<QgsWidgetWrapper*> mWidgets;
QgsAttributeEditorContext mContext;
QDialogButtonBox* mButtonBox;
QWidget* mSearchButtonBox;
QList<QgsAttributeFormInterface*> mInterfaces;
QMap< int, QgsAttributeFormEditorWidget* > mFormEditorWidgets;
// Variables below are used for python
static int sFormCounter;
int mFormNr;
QString mPyFormVarName;
//! Set to true while saving to prevent recursive saves
bool mIsSaving;
//! Flag to prevent refreshFeature() to change mFeature
bool mPreventFeatureRefresh;
//! Set to true while setting feature to prevent attributeChanged signal
bool mIsSettingFeature;
bool mIsSettingMultiEditFeatures;
QgsFeatureIds mMultiEditFeatureIds;
bool mUnsavedMultiEditChanges;
QString mEditCommandMessage;
Mode mMode;
//! Backlinks widgets to buddies.
QMap<QWidget*, QLabel*> mBuddyMap;
friend class TestQgsDualView;
friend class TestQgsAttributeForm;
};
#endif // QGSATTRIBUTEFORM_H