QGIS API Documentation  2.99.0-Master (9fdd060)
qgsattributetableview.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  QgsAttributeTableView.cpp
3  --------------------------------------
4  Date : Feb 2009
5  Copyright : (C) 2009 Vita Cizek
6  Email : weetya (at) gmail.com
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 #include <QKeyEvent>
17 #include <QHeaderView>
18 #include <QMenu>
19 #include <QToolButton>
20 #include <QHBoxLayout>
21 
22 #include "qgssettings.h"
23 #include "qgsactionmanager.h"
24 #include "qgsattributetableview.h"
25 #include "qgsattributetablemodel.h"
28 #include "qgsvectorlayer.h"
29 #include "qgsvectorlayercache.h"
31 #include "qgsvectordataprovider.h"
32 #include "qgslogger.h"
33 #include "qgsmapcanvas.h"
36 #include "qgsfeatureiterator.h"
37 #include "qgsgui.h"
38 
40  : QTableView( parent )
41 {
42  QgsSettings settings;
43  restoreGeometry( settings.value( QStringLiteral( "BetterAttributeTable/geometry" ) ).toByteArray() );
44 
45  //verticalHeader()->setDefaultSectionSize( 20 );
46  horizontalHeader()->setHighlightSections( false );
47 
48  // We need mouse move events to create the action button on hover
49  mTableDelegate = new QgsAttributeTableDelegate( this );
50  setItemDelegate( mTableDelegate );
51 
52  setEditTriggers( QAbstractItemView::AllEditTriggers );
53 
54  setSelectionBehavior( QAbstractItemView::SelectRows );
55  setSelectionMode( QAbstractItemView::ExtendedSelection );
56  setSortingEnabled( true ); // At this point no data is in the model yet, so actually nothing is sorted.
57  horizontalHeader()->setSortIndicatorShown( false ); // So hide the indicator to avoid confusion.
58 
59  verticalHeader()->viewport()->installEventFilter( this );
60 
61  connect( verticalHeader(), &QHeaderView::sectionPressed, this, [ = ]( int row ) { selectRow( row, true ); } );
62  connect( verticalHeader(), &QHeaderView::sectionEntered, this, &QgsAttributeTableView::_q_selectRow );
63  connect( horizontalHeader(), &QHeaderView::sectionResized, this, &QgsAttributeTableView::columnSizeChanged );
64  connect( horizontalHeader(), &QHeaderView::sortIndicatorChanged, this, &QgsAttributeTableView::showHorizontalSortIndicator );
65  connect( QgsGui::mapLayerActionRegistry(), &QgsMapLayerActionRegistry::changed, this, &QgsAttributeTableView::recreateActionWidgets );
66 }
67 
68 bool QgsAttributeTableView::eventFilter( QObject *object, QEvent *event )
69 {
70  if ( object == verticalHeader()->viewport() )
71  {
72  switch ( event->type() )
73  {
74  case QEvent::MouseButtonPress:
75  mFeatureSelectionModel->enableSync( false );
76  break;
77 
78  case QEvent::MouseButtonRelease:
79  mFeatureSelectionModel->enableSync( true );
80  break;
81 
82  default:
83  break;
84  }
85  }
86  return false;
87 }
88 
90 {
91  int i = 0;
92  Q_FOREACH ( const QgsAttributeTableConfig::ColumnConfig &columnConfig, config.columns() )
93  {
94  if ( columnConfig.hidden )
95  continue;
96 
97  if ( columnConfig.width >= 0 )
98  {
99  setColumnWidth( i, columnConfig.width );
100  }
101  else
102  {
103  setColumnWidth( i, horizontalHeader()->defaultSectionSize() );
104  }
105  i++;
106  }
107 }
108 
110 {
111  mFilterModel = filterModel;
112  QTableView::setModel( filterModel );
113 
114  if ( mFilterModel )
115  {
116  connect( mFilterModel, &QObject::destroyed, this, &QgsAttributeTableView::modelDeleted );
117  connect( mTableDelegate, &QgsAttributeTableDelegate::actionColumnItemPainted, this, &QgsAttributeTableView::onActionColumnItemPainted );
118  }
119 
120  delete mFeatureSelectionModel;
121  mFeatureSelectionModel = nullptr;
122 
123  if ( filterModel )
124  {
125  if ( !mFeatureSelectionManager )
126  {
127  mFeatureSelectionManager = new QgsVectorLayerSelectionManager( mFilterModel->layer(), mFilterModel );
128  }
129 
130  mFeatureSelectionModel = new QgsFeatureSelectionModel( mFilterModel, mFilterModel, mFeatureSelectionManager, mFilterModel );
131  setSelectionModel( mFeatureSelectionModel );
132  mTableDelegate->setFeatureSelectionModel( mFeatureSelectionModel );
133  connect( mFeatureSelectionModel, static_cast<void ( QgsFeatureSelectionModel::* )( const QModelIndexList &indexes )>( &QgsFeatureSelectionModel::requestRepaint ),
134  this, static_cast<void ( QgsAttributeTableView::* )( const QModelIndexList &indexes )>( &QgsAttributeTableView::repaintRequested ) );
135  connect( mFeatureSelectionModel, static_cast<void ( QgsFeatureSelectionModel::* )()>( &QgsFeatureSelectionModel::requestRepaint ),
136  this, static_cast<void ( QgsAttributeTableView::* )()>( &QgsAttributeTableView::repaintRequested ) );
137  }
138 }
139 
141 {
142  if ( mFeatureSelectionManager )
143  delete mFeatureSelectionManager;
144 
145  mFeatureSelectionManager = featureSelectionManager;
146 
147  if ( mFeatureSelectionModel )
148  mFeatureSelectionModel->setFeatureSelectionManager( mFeatureSelectionManager );
149 }
150 
151 QWidget *QgsAttributeTableView::createActionWidget( QgsFeatureId fid )
152 {
153  QgsAttributeTableConfig attributeTableConfig = mFilterModel->layer()->attributeTableConfig();
154 
155  QToolButton *toolButton = nullptr;
156  QWidget *container = nullptr;
157 
158  if ( attributeTableConfig.actionWidgetStyle() == QgsAttributeTableConfig::DropDown )
159  {
160  toolButton = new QToolButton();
161  toolButton->setToolButtonStyle( Qt::ToolButtonTextBesideIcon );
162  toolButton->setPopupMode( QToolButton::MenuButtonPopup );
163  container = toolButton;
164  }
165  else
166  {
167  container = new QWidget();
168  container->setLayout( new QHBoxLayout() );
169  container->layout()->setMargin( 0 );
170  }
171 
172  QList< QAction * > actionList;
173  QAction *defaultAction = nullptr;
174 
175  // first add user created layer actions
176  QList<QgsAction> actions = mFilterModel->layer()->actions()->actions( QStringLiteral( "Feature" ) );
177  Q_FOREACH ( const QgsAction &action, actions )
178  {
179  QString actionTitle = !action.shortTitle().isEmpty() ? action.shortTitle() : action.icon().isNull() ? action.name() : QLatin1String( "" );
180  QAction *act = new QAction( action.icon(), actionTitle, container );
181  act->setToolTip( action.name() );
182  act->setData( "user_action" );
183  act->setProperty( "fid", fid );
184  act->setProperty( "action_id", action.id() );
185  connect( act, &QAction::triggered, this, &QgsAttributeTableView::actionTriggered );
186  actionList << act;
187 
188  if ( mFilterModel->layer()->actions()->defaultAction( QStringLiteral( "Feature" ) ).id() == action.id() )
189  defaultAction = act;
190  }
191 
192  // next add any registered actions for this layer
193  Q_FOREACH ( QgsMapLayerAction *mapLayerAction,
194  QgsGui::mapLayerActionRegistry()->mapLayerActions( mFilterModel->layer(),
196  {
197  QAction *action = new QAction( mapLayerAction->icon(), mapLayerAction->text(), container );
198  action->setData( "map_layer_action" );
199  action->setToolTip( mapLayerAction->text() );
200  action->setProperty( "fid", fid );
201  action->setProperty( "action", qVariantFromValue( qobject_cast<QObject *>( mapLayerAction ) ) );
202  connect( action, &QAction::triggered, this, &QgsAttributeTableView::actionTriggered );
203  actionList << action;
204 
205  if ( !defaultAction &&
206  QgsGui::mapLayerActionRegistry()->defaultActionForLayer( mFilterModel->layer() ) == mapLayerAction )
207  defaultAction = action;
208  }
209 
210  if ( !defaultAction && !actionList.isEmpty() )
211  defaultAction = actionList.at( 0 );
212 
213  Q_FOREACH ( QAction *act, actionList )
214  {
215  if ( attributeTableConfig.actionWidgetStyle() == QgsAttributeTableConfig::DropDown )
216  {
217  toolButton->addAction( act );
218 
219  if ( act == defaultAction )
220  toolButton->setDefaultAction( act );
221 
222  container = toolButton;
223  }
224  else
225  {
226  QToolButton *btn = new QToolButton;
227  btn->setDefaultAction( act );
228  container->layout()->addWidget( btn );
229  }
230  }
231 
232  if ( attributeTableConfig.actionWidgetStyle() == QgsAttributeTableConfig::ButtonList )
233  {
234  static_cast< QHBoxLayout * >( container->layout() )->addStretch();
235  }
236 
237  // TODO: Rethink default actions
238 #if 0
239  if ( toolButton && !toolButton->actions().isEmpty() && actions->defaultAction() == -1 )
240  toolButton->setDefaultAction( toolButton->actions().at( 0 ) );
241 #endif
242 
243  return container;
244 }
245 
246 void QgsAttributeTableView::closeEvent( QCloseEvent *e )
247 {
248  Q_UNUSED( e );
249  QgsSettings settings;
250  settings.setValue( QStringLiteral( "BetterAttributeTable/geometry" ), QVariant( saveGeometry() ) );
251 }
252 
253 void QgsAttributeTableView::mousePressEvent( QMouseEvent *event )
254 {
255  setSelectionMode( QAbstractItemView::NoSelection );
256  QTableView::mousePressEvent( event );
257  setSelectionMode( QAbstractItemView::ExtendedSelection );
258 }
259 
261 {
262  setSelectionMode( QAbstractItemView::NoSelection );
263  QTableView::mouseReleaseEvent( event );
264  setSelectionMode( QAbstractItemView::ExtendedSelection );
265 }
266 
267 void QgsAttributeTableView::mouseMoveEvent( QMouseEvent *event )
268 {
269  setSelectionMode( QAbstractItemView::NoSelection );
270  QTableView::mouseMoveEvent( event );
271  setSelectionMode( QAbstractItemView::ExtendedSelection );
272 }
273 
274 void QgsAttributeTableView::keyPressEvent( QKeyEvent *event )
275 {
276  switch ( event->key() )
277  {
278 
279  // Default Qt behavior would be to change the selection.
280  // We don't make it that easy for the user to trash his selection.
281  case Qt::Key_Up:
282  case Qt::Key_Down:
283  case Qt::Key_Left:
284  case Qt::Key_Right:
285  setSelectionMode( QAbstractItemView::NoSelection );
286  QTableView::keyPressEvent( event );
287  setSelectionMode( QAbstractItemView::ExtendedSelection );
288  break;
289 
290  default:
291  QTableView::keyPressEvent( event );
292  break;
293  }
294 }
295 
296 void QgsAttributeTableView::repaintRequested( const QModelIndexList &indexes )
297 {
298  Q_FOREACH ( const QModelIndex &index, indexes )
299  {
300  update( index );
301  }
302 }
303 
305 {
306  setDirtyRegion( viewport()->rect() );
307 }
308 
310 {
311  QItemSelection selection;
312  selection.append( QItemSelectionRange( mFilterModel->index( 0, 0 ), mFilterModel->index( mFilterModel->rowCount() - 1, 0 ) ) );
313  mFeatureSelectionModel->selectFeatures( selection, QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows );
314 }
315 
316 void QgsAttributeTableView::contextMenuEvent( QContextMenuEvent *event )
317 {
318  delete mActionPopup;
319  mActionPopup = nullptr;
320 
321  QModelIndex idx = indexAt( event->pos() );
322  if ( !idx.isValid() )
323  {
324  return;
325  }
326 
327  QgsVectorLayer *vlayer = mFilterModel->layer();
328  if ( !vlayer )
329  return;
330 
331  mActionPopup = new QMenu( this );
332 
333  mActionPopup->addAction( tr( "Select All" ), this, SLOT( selectAll() ), QKeySequence::SelectAll );
334 
335  // let some other parts of the application add some actions
336  emit willShowContextMenu( mActionPopup, idx );
337 
338  if ( !mActionPopup->actions().isEmpty() )
339  {
340  mActionPopup->popup( event->globalPos() );
341  }
342 }
343 
345 {
346  selectRow( row, true );
347 }
348 
350 {
351  selectRow( row, false );
352 }
353 
354 void QgsAttributeTableView::modelDeleted()
355 {
356  mFilterModel = nullptr;
357  mFeatureSelectionManager = nullptr;
358  mFeatureSelectionModel = nullptr;
359 }
360 
361 void QgsAttributeTableView::selectRow( int row, bool anchor )
362 {
363  if ( selectionBehavior() == QTableView::SelectColumns
364  || ( selectionMode() == QTableView::SingleSelection
365  && selectionBehavior() == QTableView::SelectItems ) )
366  return;
367 
368  if ( row >= 0 && row < model()->rowCount() )
369  {
370  int column = horizontalHeader()->logicalIndexAt( isRightToLeft() ? viewport()->width() : 0 );
371  QModelIndex index = model()->index( row, column );
372  QItemSelectionModel::SelectionFlags command = selectionCommand( index );
373  selectionModel()->setCurrentIndex( index, QItemSelectionModel::NoUpdate );
374  if ( ( anchor && !( command & QItemSelectionModel::Current ) )
375  || ( selectionMode() == QTableView::SingleSelection ) )
376  mRowSectionAnchor = row;
377 
378  if ( selectionMode() != QTableView::SingleSelection
379  && command.testFlag( QItemSelectionModel::Toggle ) )
380  {
381  if ( anchor )
382  mCtrlDragSelectionFlag = mFeatureSelectionModel->isSelected( index )
383  ? QItemSelectionModel::Deselect : QItemSelectionModel::Select;
384  command &= ~QItemSelectionModel::Toggle;
385  command |= mCtrlDragSelectionFlag;
386  if ( !anchor )
387  command |= QItemSelectionModel::Current;
388  }
389 
390  QModelIndex tl = model()->index( std::min( mRowSectionAnchor, row ), 0 );
391  QModelIndex br = model()->index( std::max( mRowSectionAnchor, row ), model()->columnCount() - 1 );
392  if ( verticalHeader()->sectionsMoved() && tl.row() != br.row() )
393  setSelection( visualRect( tl ) | visualRect( br ), command );
394  else
395  mFeatureSelectionModel->selectFeatures( QItemSelection( tl, br ), command );
396  }
397 }
398 
399 void QgsAttributeTableView::showHorizontalSortIndicator()
400 {
401  horizontalHeader()->setSortIndicatorShown( true );
402 }
403 
404 void QgsAttributeTableView::actionTriggered()
405 {
406  QAction *action = qobject_cast<QAction *>( sender() );
407  QgsFeatureId fid = action->property( "fid" ).toLongLong();
408 
409  QgsFeature f;
410  mFilterModel->layerCache()->getFeatures( QgsFeatureRequest( fid ) ).nextFeature( f );
411 
412  if ( action->data().toString() == QLatin1String( "user_action" ) )
413  {
414  mFilterModel->layer()->actions()->doAction( action->property( "action_id" ).toString(), f );
415  }
416  else if ( action->data().toString() == QLatin1String( "map_layer_action" ) )
417  {
418  QObject *object = action->property( "action" ).value<QObject *>();
419  QgsMapLayerAction *layerAction = qobject_cast<QgsMapLayerAction *>( object );
420  if ( layerAction )
421  {
422  layerAction->triggerForFeature( mFilterModel->layer(), &f );
423  }
424  }
425 }
426 
427 void QgsAttributeTableView::columnSizeChanged( int index, int oldWidth, int newWidth )
428 {
429  Q_UNUSED( oldWidth )
430  emit columnResized( index, newWidth );
431 }
432 
433 void QgsAttributeTableView::onActionColumnItemPainted( const QModelIndex &index )
434 {
435  if ( !indexWidget( index ) )
436  {
437  QWidget *widget = createActionWidget( mFilterModel->data( index, QgsAttributeTableModel::FeatureIdRole ).toLongLong() );
438  mActionWidgets.insert( index, widget );
439  setIndexWidget( index, widget );
440  }
441 }
442 
443 void QgsAttributeTableView::recreateActionWidgets()
444 {
445  QMap< QModelIndex, QWidget * > newWidgets;
446  QMap< QModelIndex, QWidget * >::const_iterator it = mActionWidgets.constBegin();
447  for ( ; it != mActionWidgets.constEnd(); ++it )
448  {
449  it.value()->deleteLater(); //?
450  QWidget *widget = createActionWidget( mFilterModel->data( it.key(), QgsAttributeTableModel::FeatureIdRole ).toLongLong() );
451  newWidgets.insert( it.key(), widget );
452  setIndexWidget( it.key(), widget );
453  }
454  mActionWidgets = newWidgets;
455 }
QgsActionManager * actions()
Get all layer actions defined on this layer.
QgsVectorLayer * layer() const
Returns the layer this filter acts on.
virtual QVariant data(const QModelIndex &index, int role) const override
Provides a table view of features of a QgsVectorLayer.
virtual bool isSelected(QgsFeatureId fid)
Returns the selection status of a given feature id.
void willShowContextMenu(QMenu *menu, const QModelIndex &atIndex)
Is emitted, in order to provide a hook to add additional* menu entries to the context menu...
This class is a composition of two QSettings instances:
Definition: qgssettings.h:55
QList< QgsAction > actions(const QString &actionScope=QString()) const
Return a list of actions that are available in the given action scope.
void columnResized(int column, int width)
Emitted when a column in the view has been resized.
virtual bool eventFilter(QObject *object, QEvent *event) override
This event filter is installed on the verticalHeader to intercept mouse press and release events...
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:62
QString shortTitle() const
The short title is used to label user interface elements like buttons.
Definition: qgsaction.h:98
void doAction(const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex=0)
Does the given action.
virtual void selectAll() override
void actionColumnItemPainted(const QModelIndex &index) const
Is emitted when an action column item is painted.
void enableSync(bool enable)
Enables or disables synchronisation to the QgsVectorLayer When synchronisation is disabled...
void setFeatureSelectionModel(QgsFeatureSelectionModel *featureSelectionModel)
void mouseReleaseEvent(QMouseEvent *event) override
Called for mouse release events on a table cell.
Get the feature id of the feature in this row.
void setValue(const QString &key, const QVariant &value, const QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.
ActionWidgetStyle actionWidgetStyle() const
Get the style of the action widget.
void requestRepaint()
Request a repaint of the visible items of connected views.
QgsAttributeTableView(QWidget *parent=0)
Utility class that encapsulates an action based on vector attributes.
Definition: qgsaction.h:35
virtual void selectFeatures(const QItemSelection &selection, SelectionFlags command)
Select features on this table.
void mousePressEvent(QMouseEvent *event) override
Called for mouse press events on a table cell.
bool hidden
Flag that controls if the column is hidden.
This class wraps a request for features to a vector layer (or directly its vector data provider)...
virtual void setFeatureSelectionManager(QgsIFeatureSelectionManager *featureSelectionManager)
QIcon icon() const
The icon.
Definition: qgsaction.h:118
QString name() const
The name of the action. This may be a longer description.
Definition: qgsaction.h:95
void changed()
Triggered when an action is added or removed from the registry.
QgsAction defaultAction(const QString &actionScope)
Each scope can have a default action.
virtual void setModel(QgsAttributeTableFilterModel *filterModel)
void mouseMoveEvent(QMouseEvent *event) override
Called for mouse move events on a table cell.
QVector< QgsAttributeTableConfig::ColumnConfig > columns() const
Get the list with all columns and their configuration.
QgsAttributeTableConfig attributeTableConfig() const
Get the attribute table configuration object.
int width
Width of column, or -1 for default width.
A tool button with a drop-down to select the current action.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), const Section section=NoSection) const
Returns the value for setting key.
void setFeatureSelectionManager(QgsIFeatureSelectionManager *featureSelectionManager)
setFeatureSelectionManager
A delegate item class for QgsAttributeTable (see Qt documentation for QItemDelegate).
void setAttributeTableConfig(const QgsAttributeTableConfig &config)
Set the attribute table config which should be used to control the appearance of the attribute table...
Defines the configuration of a column in the attribute table.
qint64 QgsFeatureId
Definition: qgsfeature.h:37
virtual void selectRow(int row)
QUuid id() const
Returns a unique id for this action.
Definition: qgsaction.h:105
virtual void _q_selectRow(int row)
bool nextFeature(QgsFeature &f)
This is a container for configuration of the attribute table.
Is an interface class to abstract feature selection handling.
void closeEvent(QCloseEvent *event) override
Saves geometry to the settings on close.
Represents a vector layer which manages a vector based data sets.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &featureRequest=QgsFeatureRequest())
Query this VectorLayerCache for features.
static QgsMapLayerActionRegistry * mapLayerActionRegistry()
Returns the global map layer action registry, used for registering map layer actions.
Definition: qgsgui.cpp:64
void triggerForFeature(QgsMapLayer *layer, const QgsFeature *feature)
Triggers the action with the specified layer and feature.
An action which can run on map layers.
void keyPressEvent(QKeyEvent *event) override
Called for key press events Disables selection change by only pressing an arrow key.
void contextMenuEvent(QContextMenuEvent *event) override
Is called when the context menu will be shown.
QgsVectorLayerCache * layerCache() const
Returns the layerCache this filter acts on.