-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsdualview.h
477 lines (389 loc) · 13.8 KB
/
qgsdualview.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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
/***************************************************************************
qgsdualview.h
--------------------------------------
Date : 10.2.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 QGSDUALVIEW_H
#define QGSDUALVIEW_H
#include <QStackedWidget>
#include "ui_qgsdualviewbase.h"
#include "qgsattributeeditorcontext.h"
#include "qgsattributetablefiltermodel.h"
#include "qgsattributeform.h"
#include "qgis_gui.h"
class QgsFeatureRequest;
class QSignalMapper;
class QgsMapLayerAction;
class QgsScrollArea;
class QgsFieldConditionalFormatWidget;
/**
* \ingroup gui
* This widget is used to show the attributes of a set of features of a QgsVectorLayer.
* The attributes can be edited.
* It supports two different layouts: the table layout, in which the attributes for the features
* are shown in a table and the editor layout, where the features are shown as a selectable list
* and the attributes for the currently selected feature are shown in a form.
*/
class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBase
{
Q_OBJECT
public:
/**
* The view modes, in which this widget can present information.
* Relates to the QStackedWidget stacks.
*
*/
enum ViewMode
{
/**
* Shows the features and attributes in a table layout
*/
AttributeTable = 0,
/**
* Show a list of the features, where one can be chosen
* and the according attribute dialog will be presented
* in the neighbouring frame.
*/
AttributeEditor = 1
};
Q_ENUM( ViewMode )
//! Action on the map canvas when browsing the list of features
enum FeatureListBrowsingAction
{
NoAction = 0, //!< No action is done
PanToFeature, //!< The map is panned to the center of the feature bounding-box
ZoomToFeature, //!< The map is zoomed to contained the feature bounding-box
};
Q_ENUM( FeatureListBrowsingAction )
/**
* \brief Constructor
* \param parent The parent widget
*/
explicit QgsDualView( QWidget *parent SIP_TRANSFERTHIS = nullptr );
~QgsDualView() override;
/**
* Has to be called to initialize the dual view.
*
* \param layer The layer which should be used to fetch features
* \param mapCanvas The mapCanvas (used for the FilterMode
* QgsAttributeTableFilterModel::ShowVisible)
* \param request Use a modified request to limit the shown features
* \param context The context in which this view is shown
* \param loadFeatures whether to initially load all features into the view. If set to
* FALSE, limited features can later be loaded using setFilterMode()
*/
void init( QgsVectorLayer *layer,
QgsMapCanvas *mapCanvas,
const QgsFeatureRequest &request = QgsFeatureRequest(),
const QgsAttributeEditorContext &context = QgsAttributeEditorContext(),
bool loadFeatures = true );
/**
* Change the current view mode.
*
* \param view The view mode to set
* \see view()
*/
void setView( ViewMode view );
/**
* Returns the current view mode.
* \see setView()
* \since QGIS 2.16
*/
ViewMode view() const;
/**
* Set the filter mode
*
* \param filterMode
*/
void setFilterMode( QgsAttributeTableFilterModel::FilterMode filterMode );
/**
* Gets the filter mode
*
* \returns the filter mode
*/
QgsAttributeTableFilterModel::FilterMode filterMode() { return mFilterModel->filterMode(); }
/**
* Toggle the selectedOnTop flag. If enabled, selected features will be moved to top.
*
* \param selectedOnTop TRUE: Show selected features on top.
* FALSE: Use defined sorting column.
*/
void setSelectedOnTop( bool selectedOnTop );
/**
* Returns the number of features on the layer.
*
* \returns Number of features
*/
int featureCount();
/**
* Returns the number of features which are currently visible, according to the
* filter restrictions
*
* \returns Number of features
*/
int filteredFeatureCount();
/**
* Set a list of currently visible features
*
* \param filteredFeatures A list of feature ids
*
*/
void setFilteredFeatures( const QgsFeatureIds &filteredFeatures );
/**
* Gets a list of currently visible feature ids.
*/
QgsFeatureIds filteredFeatures() { return mFilterModel->filteredFeatures(); }
/**
* Returns the model which has the information about all features (not only filtered)
*
* \returns The master model
*/
QgsAttributeTableModel *masterModel() const { return mMasterModel; }
/**
* Set the request
*
* \param request The request
*/
void setRequest( const QgsFeatureRequest &request );
/**
* Set the feature selection model
*
* \param featureSelectionManager the feature selection model
*/
void setFeatureSelectionManager( QgsIFeatureSelectionManager *featureSelectionManager );
/**
* Returns the table view
*
* \returns The table view
*/
QgsAttributeTableView *tableView() { return mTableView; }
/**
* Set the attribute table config which should be used to control
* the appearance of the attribute table.
*/
void setAttributeTableConfig( const QgsAttributeTableConfig &config );
/**
* Set the expression used for sorting the table and feature list.
*/
void setSortExpression( const QString &sortExpression, Qt::SortOrder sortOrder = Qt::AscendingOrder );
/**
* Gets the expression used for sorting the table and feature list.
*/
QString sortExpression() const;
/**
* The config used for the attribute table.
* \returns The config used for the attribute table.
*/
QgsAttributeTableConfig attributeTableConfig() const;
public slots:
/**
* \brief Set the current edit selection in the AttributeEditor mode.
*
* \param fids A list of edited features (Currently only one at a time is supported)
*/
void setCurrentEditSelection( const QgsFeatureIds &fids );
/**
* \brief saveEditChanges
*
* \returns TRUE if the saving was OK. FALSE is possible due to connected
* validation logic.
*/
bool saveEditChanges();
void openConditionalStyles();
/**
* Sets whether multi edit mode is enabled.
* \since QGIS 2.16
*/
void setMultiEditEnabled( bool enabled );
/**
* Toggles whether search mode should be enabled in the form.
* \param enabled set to TRUE to switch on search mode
* \since QGIS 2.16
*/
void toggleSearchMode( bool enabled );
/**
* Copy the content of the selected cell in the clipboard.
* \since QGIS 1.16
*/
void copyCellContent() const;
/**
* Cancel the progress dialog (if any)
* \since QGIS 3.0
*/
void cancelProgress( );
signals:
/**
* Emitted whenever the display expression is successfully changed
* \param expression The expression that was applied
*/
void displayExpressionChanged( const QString &expression );
/**
* Emitted whenever the filter changes
*/
void filterChanged();
/**
* Emitted when a filter expression is set using the view.
* \param expression filter expression
* \param type filter type
* \since QGIS 2.16
*/
void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type );
/**
* Emitted when the form changes mode.
* \param mode new mode
*/
void formModeChanged( QgsAttributeEditorContext::Mode mode );
/**
* Emitted when selecting context menu on the feature list to create the context menu individually
* \param menu context menu
* \param fid feature id of the selected feature
*/
void showContextMenuExternally( QgsActionMenu *menu, QgsFeatureId fid );
protected:
void hideEvent( QHideEvent *event ) override;
private slots:
void featureListAboutToChangeEditSelection( bool &ok );
/**
* Changes the currently visible feature within the attribute editor
*
* \param feat The newly visible feature
*/
void featureListCurrentEditSelectionChanged( const QgsFeature &feat );
void previewExpressionBuilder();
void previewColumnChanged( QAction *previewAction, const QString &expression );
void viewWillShowContextMenu( QMenu *menu, const QModelIndex &atIndex );
void widgetWillShowContextMenu( QgsActionMenu *menu, const QModelIndex &atIndex );
void showViewHeaderMenu( QPoint point );
void organizeColumns();
void tableColumnResized( int column, int width );
void hideColumn();
void resizeColumn();
void autosizeColumn();
void modifySort();
void previewExpressionChanged( const QString &expression );
void onSortColumnChanged();
void sortByPreviewExpression();
void updateSelectedFeatures();
void extentChanged();
/**
* Will be called whenever the currently shown feature form changes.
* Will forward this signal to the feature list to visually represent
* that there has been an edit event.
*/
void featureFormAttributeChanged( const QString &attribute, const QVariant &value, bool attributeChanged );
/**
* Will be called periodically, when loading layers from slow data providers.
*
* \param i The number of features already loaded
* \param cancel Set to TRUE to cancel
*/
virtual void progress( int i, bool &cancel );
/**
* Will be called, once all the features are loaded.
* Use e.g. to close a dialog created from progress( int i, bool &cancel )
*/
virtual void finished();
//! Zooms to the active feature
void zoomToCurrentFeature();
//! Pans to the active feature
void panToCurrentFeature();
void flashCurrentFeature();
void rebuildFullLayerCache();
void panZoomGroupButtonToggled( QAbstractButton *button, bool checked );
void flashButtonClicked( bool clicked );
private:
/**
* Initializes widgets which depend on the attributes of this layer
*/
void columnBoxInit();
void initLayerCache( bool cacheGeometry );
void initModels( QgsMapCanvas *mapCanvas, const QgsFeatureRequest &request, bool loadFeatures );
void restoreRecentDisplayExpressions();
void saveRecentDisplayExpressions() const;
void setDisplayExpression( const QString &expression );
void insertRecentlyUsedDisplayExpression( const QString &expression );
void updateEditSelectionProgress( int progress, int count );
void panOrZoomToFeature( const QgsFeatureIds &featureset );
QgsFieldConditionalFormatWidget *mConditionalFormatWidget = nullptr;
QgsAttributeEditorContext mEditorContext;
QgsAttributeTableModel *mMasterModel = nullptr;
QgsAttributeTableFilterModel *mFilterModel = nullptr;
QgsFeatureListModel *mFeatureListModel = nullptr;
QgsAttributeForm *mAttributeForm = nullptr;
QMenu *mPreviewColumnsMenu = nullptr;
QMenu *mPreviewActionMenu = nullptr;
QAction *mLastDisplayExpressionAction = nullptr;
QMenu *mHorizontalHeaderMenu = nullptr;
QgsVectorLayerCache *mLayerCache = nullptr;
QPointer< QgsVectorLayer > mLayer = nullptr;
QProgressDialog *mProgressDlg = nullptr;
QgsIFeatureSelectionManager *mFeatureSelectionManager = nullptr;
QString mDisplayExpression;
QgsAttributeTableConfig mConfig;
QgsScrollArea *mAttributeEditorScrollArea = nullptr;
// If the current feature is set, while the form is still not initialized
// we will temporarily save it in here and set it on init
QgsFeature mTempAttributeFormFeature;
QgsFeatureIds mLastFeatureSet;
friend class TestQgsDualView;
friend class TestQgsAttributeTable;
};
/**
* \ingroup gui
* \class QgsAttributeTableAction
*/
class GUI_EXPORT QgsAttributeTableAction : public QAction
{
Q_OBJECT
public:
/**
* Create a new attribute table action.
*
* \since QGIS 3.0
*/
QgsAttributeTableAction( const QString &name, QgsDualView *dualView, QUuid action, const QModelIndex &fieldIdx )
: QAction( name, dualView )
, mDualView( dualView )
, mAction( action )
, mFieldIdx( fieldIdx )
{}
public slots:
void execute();
void featureForm();
private:
QgsDualView *mDualView = nullptr;
QUuid mAction;
QModelIndex mFieldIdx;
};
/**
* \ingroup gui
* \class QgsAttributeTableMapLayerAction
*/
class GUI_EXPORT QgsAttributeTableMapLayerAction : public QAction
{
Q_OBJECT
public:
QgsAttributeTableMapLayerAction( const QString &name, QgsDualView *dualView, QgsMapLayerAction *action, const QModelIndex &fieldIdx )
: QAction( name, dualView )
, mDualView( dualView )
, mAction( action )
, mFieldIdx( fieldIdx )
{}
public slots:
void execute();
private:
QgsDualView *mDualView = nullptr;
QgsMapLayerAction *mAction = nullptr;
QModelIndex mFieldIdx;
};
Q_DECLARE_METATYPE( QModelIndex );
#endif // QGSDUALVIEW_H