-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsrelationreferencewidget.h
370 lines (312 loc) · 11.4 KB
/
qgsrelationreferencewidget.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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
/***************************************************************************
qgsrelationreferencewidget.h
--------------------------------------
Date : 20.4.2013
Copyright : (C) 2013 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 QGSRELATIONREFERENCEWIDGET_H
#define QGSRELATIONREFERENCEWIDGET_H
#include "qgsattributeeditorcontext.h"
#include "qgis_sip.h"
#include "qgsfeature.h"
#include "qobjectuniqueptr.h"
#include <QComboBox>
#include <QToolButton>
#include <QLineEdit>
#include <QHBoxLayout>
#include <QStandardItemModel>
#include "qgis_gui.h"
class QgsAttributeForm;
class QgsVectorLayerTools;
class QgsMapCanvas;
class QgsMessageBar;
class QgsHighlight;
class QgsMapTool;
class QgsMapToolIdentifyFeature;
class QgsMapToolDigitizeFeature;
class QgsMessageBarItem;
class QgsFeatureListComboBox;
class QgsCollapsibleGroupBox;
class QLabel;
#ifdef SIP_RUN
% ModuleHeaderCode
// fix to allow compilation with sip that for some reason
// doesn't add this include to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsrelationreferencewidget.h>
% End
#endif
/**
* \ingroup gui
* \class QgsRelationReferenceWidget
*/
class GUI_EXPORT QgsRelationReferenceWidget : public QWidget
{
#ifdef SIP_RUN
SIP_CONVERT_TO_SUBCLASS_CODE
if ( qobject_cast<QgsRelationReferenceWidget *>( sipCpp ) )
sipType = sipType_QgsRelationReferenceWidget;
else
sipType = NULL;
SIP_END
#endif
Q_OBJECT
Q_PROPERTY( bool openFormButtonVisible READ openFormButtonVisible WRITE setOpenFormButtonVisible )
public:
enum CanvasExtent
{
Fixed,
Pan,
Scale
};
explicit QgsRelationReferenceWidget( QWidget *parent SIP_TRANSFERTHIS );
~QgsRelationReferenceWidget() override;
void setRelation( const QgsRelation &relation, bool allowNullValue );
void setRelationEditable( bool editable );
/**
* this sets the related feature using from the foreign key
* \deprecated since QGIS 3.10 use setForeignKeys
*/
Q_DECL_DEPRECATED void setForeignKey( const QVariant &value ) SIP_DEPRECATED;
/**
* Sets the related feature using the foreign keys
* \since QGIS 3.10
*/
void setForeignKeys( const QVariantList &values );
/**
* returns the related feature foreign key
* \deprecated since QGIS 3.10
*/
Q_DECL_DEPRECATED QVariant foreignKey() const SIP_DEPRECATED;
//! returns the related feature foreign key
/**
* Returns the related feature foreign keys
* \since QGIS 3.10
*/
QVariantList foreignKeys() const;
/**
* Sets the editor \a context
* \note if context cadDockWidget is null, it won't be possible to digitize
* the geometry of a referenced feature from this widget
*/
void setEditorContext( const QgsAttributeEditorContext &context, QgsMapCanvas *canvas, QgsMessageBar *messageBar );
//! determines if the form of the related feature will be shown
bool embedForm() { return mEmbedForm; }
void setEmbedForm( bool display );
//! determines if the foreign key is shown in a combox box or a read-only line edit
bool readOnlySelector() { return mReadOnlySelector; }
void setReadOnlySelector( bool readOnly );
//! determines if the widget offers the possibility to select the related feature on the map (using a dedicated map tool)
bool allowMapIdentification() { return mAllowMapIdentification; }
void setAllowMapIdentification( bool allowMapIdentification );
//! If the widget will order the combobox entries by value
bool orderByValue() { return mOrderByValue; }
//! Sets if the widget will order the combobox entries by value
void setOrderByValue( bool orderByValue );
//! Sets the fields for which filter comboboxes will be created
void setFilterFields( const QStringList &filterFields );
//! determines the open form button is visible in the widget
bool openFormButtonVisible() { return mOpenFormButtonVisible; }
void setOpenFormButtonVisible( bool openFormButtonVisible );
/**
* Determines if the filters are chained
*
* \returns TRUE if filters are chained
*/
bool chainFilters() const { return mChainFilters; }
/**
* Set if filters are chained.
* Chained filters restrict the option of subsequent filters based on the selection of a previous filter.
*
* \param chainFilters If chaining should be enabled
*/
void setChainFilters( bool chainFilters );
/**
* Returns the currently set filter expression.
*/
QString filterExpression() const { return mFilterExpression; };
/**
* If not empty, will be used as filter expression.
* Only if this evaluates to TRUE, the value will be shown.
*/
void setFilterExpression( const QString &filterExpression );
/**
* Returns the related feature (from the referenced layer)
* if no feature is related, it returns an invalid feature
*/
QgsFeature referencedFeature() const;
/**
* Sets the widget to display in an indeterminate "mixed value" state.
* \since QGIS 2.16
*/
void showIndeterminateState();
/**
* Determines if a button for adding new features should be shown.
*
* \since QGIS 2.16
*/
bool allowAddFeatures() const;
/**
* Determines if a button for adding new features should be shown.
*
* \since QGIS 2.16
*/
void setAllowAddFeatures( bool allowAddFeatures );
/**
* Returns the current relation, which might be invalid
* \since QGIS 3.10
*/
QgsRelation relation() const;
/**
* Set the current form feature (from the referencing layer)
*
* \since QGIS 3.10
*/
void setFormFeature( const QgsFeature &formFeature );
/**
* Returns the public data source of the referenced layer
* \since QGIS 3.12
*/
QString referencedLayerDataSource() const;
/**
* Set the public data source of the referenced layer to \a referencedLayerDataSource
* \since QGIS 3.12
*/
void setReferencedLayerDataSource( const QString &referencedLayerDataSource );
/**
* Returns the data provider key of the referenced layer
* \since QGIS 3.12
*/
QString referencedLayerProviderKey() const;
/**
* Set the data provider key of the referenced layer to \a referencedLayerProviderKey
* \since QGIS 3.12
*/
void setReferencedLayerProviderKey( const QString &referencedLayerProviderKey );
/**
* Returns the id of the referenced layer
* \since QGIS 3.12
*/
QString referencedLayerId() const;
/**
* Set the id of the referenced layer to \a referencedLayerId
* \since QGIS 3.12
*/
void setReferencedLayerId( const QString &referencedLayerId );
/**
* Returns the name of the referenced layer
* \since QGIS 3.12
*/
QString referencedLayerName() const;
/**
* Set the name of the referenced layer to \a referencedLayerName
* \since QGIS 3.12
*/
void setReferencedLayerName( const QString &referencedLayerName );
public slots:
//! open the form of the related feature in a new dialog
void openForm();
//! activate the map tool to select a new related feature on the map
void mapIdentification();
//! unset the currently related feature
void deleteForeignKeys();
protected:
void showEvent( QShowEvent *e ) override;
void init();
signals:
/**
* Emitted when the foreign key changed
* \deprecated since QGIS 3.10
*/
Q_DECL_DEPRECATED void foreignKeyChanged( const QVariant & ) SIP_DEPRECATED;
/**
* Emitted when the foreign keys changed
* \since QGIS 3.10
*/
void foreignKeysChanged( const QVariantList & );
private slots:
void highlightActionTriggered( QAction *action );
void deleteHighlight();
void comboReferenceChanged( int index );
void featureIdentified( const QgsFeature &feature );
void setMapTool( QgsMapTool *mapTool );
void unsetMapTool();
void mapToolDeactivated();
void filterChanged();
void addEntry();
void updateAddEntryButton();
void entryAdded( const QgsFeature &f );
void onKeyPressed( QKeyEvent *e );
private:
void highlightFeature( QgsFeature f = QgsFeature(), CanvasExtent canvasExtent = Fixed );
void updateAttributeEditorFrame( const QgsFeature &feature );
void disableChainedComboBoxes( const QComboBox *cb );
void emitForeignKeysChanged( const QVariantList &foreignKeys, bool force = false );
// initialized
QgsAttributeEditorContext mEditorContext;
QgsMapCanvas *mCanvas = nullptr;
QgsMessageBar *mMessageBar = nullptr;
QVariantList mForeignKeys;
QgsFeature mFeature;
QgsFeature mFormFeature;
// Index of the referenced layer key
QStringList mReferencedFields;
bool mAllowNull = true;
QgsHighlight *mHighlight = nullptr;
QgsMapTool *mCurrentMapTool = nullptr;
QObjectUniquePtr<QgsMapToolIdentifyFeature> mMapToolIdentify;
QObjectUniquePtr<QgsMapToolDigitizeFeature> mMapToolDigitize;
QgsMessageBarItem *mMessageBarItem = nullptr;
QgsAttributeForm *mReferencedAttributeForm = nullptr;
QgsVectorLayer *mReferencedLayer = nullptr;
QgsVectorLayer *mReferencingLayer = nullptr;
QgsFeatureListComboBox *mComboBox = nullptr;
QList<QComboBox *> mFilterComboBoxes;
QString mFilterExpression;
QWidget *mWindowWidget = nullptr;
bool mShown = false;
QgsRelation mRelation;
bool mIsEditable = true;
QStringList mFilterFields;
QMap<QString, QMap<QString, QSet<QString> > > mFilterCache;
bool mInitialized = false;
// Q_PROPERTY
bool mEmbedForm = false;
bool mReadOnlySelector = false;
bool mAllowMapIdentification = false;
bool mOrderByValue = false;
bool mOpenFormButtonVisible = true;
bool mChainFilters = false;
bool mAllowAddFeatures = false;
QString mReferencedLayerId;
QString mReferencedLayerName;
QString mReferencedLayerDataSource;
QString mReferencedLayerProviderKey;
// UI
QVBoxLayout *mTopLayout = nullptr;
QToolButton *mMapIdentificationButton = nullptr;
QToolButton *mRemoveFKButton = nullptr;
QToolButton *mOpenFormButton = nullptr;
QToolButton *mHighlightFeatureButton = nullptr;
QToolButton *mAddEntryButton = nullptr;
QAction *mHighlightFeatureAction = nullptr;
QAction *mScaleHighlightFeatureAction = nullptr;
QAction *mPanHighlightFeatureAction = nullptr;
QWidget *mChooserContainer = nullptr;
QWidget *mFilterContainer = nullptr;
QHBoxLayout *mFilterLayout = nullptr;
QgsCollapsibleGroupBox *mAttributeEditorFrame = nullptr;
QVBoxLayout *mAttributeEditorLayout = nullptr;
QLineEdit *mLineEdit = nullptr;
QLabel *mInvalidLabel = nullptr;
friend class TestQgsRelationReferenceWidget;
};
#endif // QGSRELATIONREFERENCEWIDGET_H