qgsattributetableview.cpp

Go to the documentation of this file.

/***************************************************************************
     QgsAttributeTableView.cpp
     --------------------------------------
    Date                 : Feb 2009
    Copyright            : (C) 2009 Vita Cizek
    Email                : weetya (at) gmail.com
 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsattributetableview.h"
 
#include "qgsactionmanager.h"
#include "qgsattributetabledelegate.h"
#include "qgsattributetablefiltermodel.h"
#include "qgsattributetablemodel.h"
#include "qgsfeatureiterator.h"
#include "qgsfeatureselectionmodel.h"
#include "qgsgui.h"
#include "qgsmaplayeraction.h"
#include "qgsmaplayeractionregistry.h"
#include "qgsstringutils.h"
#include "qgsvectorlayer.h"
#include "qgsvectorlayercache.h"
#include "qgsvectorlayerselectionmanager.h"
 
#include <QDesktopServices>
#include <QHBoxLayout>
#include <QHeaderView>
#include <QKeyEvent>
#include <QMenu>
#include <QString>
#include <QToolButton>
 
#include "moc_qgsattributetableview.cpp"
 
using namespace Qt::StringLiterals;
 
QgsAttributeTableView::QgsAttributeTableView( QWidget *parent )
  : QgsTableView( parent )
{
  const QgsSettings settings;
  restoreGeometry( settings.value( u"BetterAttributeTable/geometry"_s ).toByteArray() );
 
  //verticalHeader()->setDefaultSectionSize( 20 );
  horizontalHeader()->setHighlightSections( false );
 
  // We need mouse move events to create the action button on hover
  mTableDelegate = new QgsAttributeTableDelegate( this );
  setItemDelegate( mTableDelegate );
 
  setEditTriggers( QAbstractItemView::AllEditTriggers );
 
  setSelectionBehavior( QAbstractItemView::SelectRows );
  setSelectionMode( QAbstractItemView::ExtendedSelection );
  setSortingEnabled( true );                          // At this point no data is in the model yet, so actually nothing is sorted.
  horizontalHeader()->setSortIndicatorShown( false ); // So hide the indicator to avoid confusion.
 
  setHorizontalScrollMode( QAbstractItemView::ScrollPerPixel );
 
  verticalHeader()->viewport()->installEventFilter( this );
 
  connect( verticalHeader(), &QHeaderView::sectionPressed, this, [this]( int row ) { selectRow( row, true ); } );
  connect( verticalHeader(), &QHeaderView::sectionEntered, this, &QgsAttributeTableView::_q_selectRow );
  connect( horizontalHeader(), &QHeaderView::sectionResized, this, &QgsAttributeTableView::columnSizeChanged );
  connect( horizontalHeader(), &QHeaderView::sortIndicatorChanged, this, &QgsAttributeTableView::showHorizontalSortIndicator );
  connect( QgsGui::mapLayerActionRegistry(), &QgsMapLayerActionRegistry::changed, this, &QgsAttributeTableView::recreateActionWidgets );
}
 
bool QgsAttributeTableView::eventFilter( QObject *object, QEvent *event )
{
  if ( object == verticalHeader()->viewport() )
  {
    switch ( event->type() )
    {
      case QEvent::MouseButtonPress:
        mFeatureSelectionModel->enableSync( false );
        break;
 
      case QEvent::MouseButtonRelease:
        mFeatureSelectionModel->enableSync( true );
        break;
 
      case QEvent::MouseButtonDblClick:
      {
        QMouseEvent *mouseEvent = static_cast<QMouseEvent *>( event );
        if ( mouseEvent->button() == Qt::LeftButton )
        {
          const int row = verticalHeader()->logicalIndexAt( mouseEvent->pos() );
          if ( row >= 0 && mFilterModel )
          {
            const QModelIndex index = mFilterModel->index( row, 0 );
            if ( index.isValid() )
            {
              const QgsFeatureId fid = mFilterModel->rowToId( index );
              emit rowHeaderDoubleClicked( fid );
            }
          }
        }
        break;
      }
 
      default:
        break;
    }
  }
  return QTableView::eventFilter( object, event );
}
 
void QgsAttributeTableView::setAttributeTableConfig( const QgsAttributeTableConfig &config )
{
  int i = 0;
  const auto constColumns = config.columns();
  QMap<QString, int> columns;
  for ( const QgsAttributeTableConfig::ColumnConfig &columnConfig : constColumns )
  {
    if ( columnConfig.hidden )
      continue;
 
    if ( columnConfig.width >= 0 )
    {
      setColumnWidth( i, columnConfig.width );
    }
    else
    {
      setColumnWidth( i, horizontalHeader()->defaultSectionSize() );
    }
    columns.insert( columnConfig.name, i );
    i++;
  }
  mConfig = config;
  if ( config.sortExpression().isEmpty() )
  {
    horizontalHeader()->setSortIndicatorShown( false );
  }
  else
  {
    if ( mSortExpression != config.sortExpression() )
    {
      const QgsExpression sortExp { config.sortExpression() };
      if ( sortExp.isField() )
      {
        const QStringList refCols { sortExp.referencedColumns().values() };
        horizontalHeader()->setSortIndicatorShown( true );
        horizontalHeader()->setSortIndicator( columns.value( refCols.constFirst() ), config.sortOrder() );
      }
      else
      {
        horizontalHeader()->setSortIndicatorShown( false );
      }
    }
  }
  mSortExpression = config.sortExpression();
}
 
QList<QgsFeatureId> QgsAttributeTableView::selectedFeaturesIds() const
{
  // In order to get the ids in the right sorted order based on the view we have to get the feature ids first
  // from the selection manager which is in the order the user selected them when clicking
  // then get the model index, sort that, and finally return the new sorted features ids.
  const QgsFeatureIds featureIds = mFeatureSelectionManager->selectedFeatureIds();
  QModelIndexList indexList;
  for ( const QgsFeatureId &id : featureIds )
  {
    const QModelIndex index = mFilterModel->fidToIndex( id );
    indexList << index;
  }
 
  std::sort( indexList.begin(), indexList.end() );
  QList<QgsFeatureId> ids;
  for ( const QModelIndex &index : indexList )
  {
    const QgsFeatureId id = mFilterModel->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FeatureId ) ).toLongLong();
    ids.append( id );
  }
  return ids;
}
 
void QgsAttributeTableView::setModel( QgsAttributeTableFilterModel *filterModel )
{
  mFilterModel = filterModel;
  QTableView::setModel( mFilterModel );
 
  if ( mFilterModel )
  {
    connect( mFilterModel, &QObject::destroyed, this, &QgsAttributeTableView::modelDeleted );
    connect( mTableDelegate, &QgsAttributeTableDelegate::actionColumnItemPainted, this, &QgsAttributeTableView::onActionColumnItemPainted );
  }
 
  delete mFeatureSelectionModel;
  mFeatureSelectionModel = nullptr;
 
  if ( mFilterModel )
  {
    if ( !mFeatureSelectionManager )
    {
      mOwnedFeatureSelectionManager = new QgsVectorLayerSelectionManager( mFilterModel->layer(), this );
      mFeatureSelectionManager = mOwnedFeatureSelectionManager;
    }
 
    mFeatureSelectionModel = new QgsFeatureSelectionModel( mFilterModel, mFilterModel, mFeatureSelectionManager, mFilterModel );
    setSelectionModel( mFeatureSelectionModel );
    mTableDelegate->setFeatureSelectionModel( mFeatureSelectionModel );
    connect(
      mFeatureSelectionModel,
      static_cast<void ( QgsFeatureSelectionModel::* )( const QModelIndexList &indexes )>( &QgsFeatureSelectionModel::requestRepaint ),
      this,
      static_cast<void ( QgsAttributeTableView::* )( const QModelIndexList &indexes )>( &QgsAttributeTableView::repaintRequested )
    );
    connect( mFeatureSelectionModel, static_cast<void ( QgsFeatureSelectionModel::* )()>( &QgsFeatureSelectionModel::requestRepaint ), this, static_cast<void ( QgsAttributeTableView::* )()>( &QgsAttributeTableView::repaintRequested ) );
 
    connect( mFilterModel->layer(), &QgsVectorLayer::editingStarted, this, &QgsAttributeTableView::recreateActionWidgets );
    connect( mFilterModel->layer(), &QgsVectorLayer::editingStopped, this, &QgsAttributeTableView::recreateActionWidgets );
    connect( mFilterModel->layer(), &QgsVectorLayer::readOnlyChanged, this, &QgsAttributeTableView::recreateActionWidgets );
  }
}
 
void QgsAttributeTableView::setFeatureSelectionManager( QgsIFeatureSelectionManager *featureSelectionManager )
{
  mFeatureSelectionManager = featureSelectionManager;
 
  if ( mFeatureSelectionModel )
    mFeatureSelectionModel->setFeatureSelectionManager( mFeatureSelectionManager );
 
  // only delete the owner selection manager and not one created from outside
  if ( mOwnedFeatureSelectionManager )
  {
    mOwnedFeatureSelectionManager->deleteLater();
    mOwnedFeatureSelectionManager = nullptr;
  }
}
 
QWidget *QgsAttributeTableView::createActionWidget( QgsFeatureId fid )
{
  const QgsAttributeTableConfig attributeTableConfig = mConfig;
 
  QToolButton *toolButton = nullptr;
  QWidget *container = nullptr;
 
  if ( attributeTableConfig.actionWidgetStyle() == QgsAttributeTableConfig::DropDown )
  {
    toolButton = new QToolButton();
    toolButton->setToolButtonStyle( Qt::ToolButtonTextBesideIcon );
    toolButton->setPopupMode( QToolButton::MenuButtonPopup );
    container = toolButton;
  }
  else
  {
    container = new QWidget();
    container->setLayout( new QHBoxLayout() );
    container->layout()->setContentsMargins( 0, 0, 0, 0 );
  }
 
  QList<QAction *> actionList;
  QAction *defaultAction = nullptr;
 
  // first add user created layer actions
  const QList<QgsAction> actions = mFilterModel->layer()->actions()->actions( u"Feature"_s );
  const auto constActions = actions;
  for ( const QgsAction &action : constActions )
  {
    if ( !mFilterModel->layer()->isEditable() && action.isEnabledOnlyWhenEditable() )
      continue;
 
    const QString actionTitle = !action.shortTitle().isEmpty() ? action.shortTitle() : action.icon().isNull() ? action.name() : QString();
    QAction *act = new QAction( action.icon(), actionTitle, container );
    act->setToolTip( action.name() );
    act->setData( "user_action" );
    act->setProperty( "fid", fid );
    act->setProperty( "action_id", action.id() );
    connect( act, &QAction::triggered, this, &QgsAttributeTableView::actionTriggered );
    actionList << act;
 
    if ( mFilterModel->layer()->actions()->defaultAction( u"Feature"_s ).id() == action.id() )
      defaultAction = act;
  }
 
  QgsMapLayerActionContext context;
  const QList<QgsMapLayerAction *> mapLayerActions = QgsGui::mapLayerActionRegistry()->mapLayerActions( mFilterModel->layer(), Qgis::MapLayerActionTarget::SingleFeature, context );
  // next add any registered actions for this layer
  for ( QgsMapLayerAction *mapLayerAction : mapLayerActions )
  {
    QAction *action = new QAction( mapLayerAction->icon(), mapLayerAction->text(), container );
    action->setData( "map_layer_action" );
    action->setToolTip( mapLayerAction->text() );
    action->setProperty( "fid", fid );
    action->setProperty( "action", QVariant::fromValue( qobject_cast<QObject *>( mapLayerAction ) ) );
    connect( action, &QAction::triggered, this, &QgsAttributeTableView::actionTriggered );
    actionList << action;
 
    if ( !defaultAction && QgsGui::mapLayerActionRegistry()->defaultActionForLayer( mFilterModel->layer() ) == mapLayerAction )
      defaultAction = action;
  }
 
  if ( !defaultAction && !actionList.isEmpty() )
    defaultAction = actionList.at( 0 );
 
  const auto constActionList = actionList;
  for ( QAction *act : constActionList )
  {
    if ( attributeTableConfig.actionWidgetStyle() == QgsAttributeTableConfig::DropDown )
    {
      toolButton->addAction( act );
 
      if ( act == defaultAction )
        toolButton->setDefaultAction( act );
 
      container = toolButton;
    }
    else
    {
      QToolButton *btn = new QToolButton;
      btn->setDefaultAction( act );
      container->layout()->addWidget( btn );
    }
  }
 
  if ( attributeTableConfig.actionWidgetStyle() == QgsAttributeTableConfig::ButtonList )
  {
    static_cast<QHBoxLayout *>( container->layout() )->addStretch();
  }
 
  // TODO: Rethink default actions
#if 0
  if ( toolButton && !toolButton->actions().isEmpty() && actions->defaultAction() == -1 )
    toolButton->setDefaultAction( toolButton->actions().at( 0 ) );
#endif
 
  return container;
}
 
void QgsAttributeTableView::closeEvent( QCloseEvent *e )
{
  Q_UNUSED( e )
  QgsSettings settings;
  settings.setValue( u"BetterAttributeTable/geometry"_s, QVariant( saveGeometry() ) );
}
 
void QgsAttributeTableView::mousePressEvent( QMouseEvent *event )
{
  setSelectionMode( QAbstractItemView::NoSelection );
  QTableView::mousePressEvent( event );
  setSelectionMode( QAbstractItemView::ExtendedSelection );
}
 
void QgsAttributeTableView::mouseReleaseEvent( QMouseEvent *event )
{
  setSelectionMode( QAbstractItemView::NoSelection );
  QTableView::mouseReleaseEvent( event );
  setSelectionMode( QAbstractItemView::ExtendedSelection );
  if ( event->modifiers() == Qt::ControlModifier )
  {
    const QModelIndex index = indexAt( event->pos() );
    const QVariant data = model()->data( index, Qt::DisplayRole );
    if ( data.userType() == QMetaType::Type::QString )
    {
      const QString textVal = data.toString();
      if ( QgsStringUtils::isUrl( textVal ) )
      {
        QDesktopServices::openUrl( QUrl( textVal ) );
      }
    }
  }
}
 
void QgsAttributeTableView::mouseMoveEvent( QMouseEvent *event )
{
  setSelectionMode( QAbstractItemView::NoSelection );
  QTableView::mouseMoveEvent( event );
  setSelectionMode( QAbstractItemView::ExtendedSelection );
}
 
void QgsAttributeTableView::keyPressEvent( QKeyEvent *event )
{
  switch ( event->key() )
  {
    // Default Qt behavior would be to change the selection.
    // We don't make it that easy for the user to trash his selection.
    case Qt::Key_Up:
    case Qt::Key_Down:
    case Qt::Key_Left:
    case Qt::Key_Right:
      setSelectionMode( QAbstractItemView::NoSelection );
      QTableView::keyPressEvent( event );
      setSelectionMode( QAbstractItemView::ExtendedSelection );
      break;
 
    default:
      QTableView::keyPressEvent( event );
      break;
  }
}
 
void QgsAttributeTableView::repaintRequested( const QModelIndexList &indexes )
{
  const auto constIndexes = indexes;
  for ( const QModelIndex &index : constIndexes )
  {
    update( index );
  }
}
 
void QgsAttributeTableView::repaintRequested()
{
  setDirtyRegion( viewport()->rect() );
}
 
void QgsAttributeTableView::selectAll()
{
  QItemSelection selection;
  selection.append( QItemSelectionRange( mFilterModel->index( 0, 0 ), mFilterModel->index( mFilterModel->rowCount() - 1, 0 ) ) );
  mFeatureSelectionModel->selectFeatures( selection, QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows );
}
 
void QgsAttributeTableView::contextMenuEvent( QContextMenuEvent *event )
{
  delete mActionPopup;
  mActionPopup = nullptr;
 
  const QModelIndex idx = mFilterModel->mapToMaster( indexAt( event->pos() ) );
  if ( !idx.isValid() )
  {
    return;
  }
 
  QgsVectorLayer *vlayer = mFilterModel->layer();
  if ( !vlayer )
    return;
 
  mActionPopup = new QMenu( this );
 
  QAction *selectAllAction = mActionPopup->addAction( tr( "Select All" ) );
  selectAllAction->setShortcut( QKeySequence::SelectAll );
  connect( selectAllAction, &QAction::triggered, this, &QgsAttributeTableView::selectAll );
 
  // let some other parts of the application add some actions
  emit willShowContextMenu( mActionPopup, idx );
 
  if ( !mActionPopup->actions().isEmpty() )
  {
    mActionPopup->popup( event->globalPos() );
  }
}
 
void QgsAttributeTableView::selectRow( int row )
{
  selectRow( row, true );
}
 
void QgsAttributeTableView::_q_selectRow( int row )
{
  selectRow( row, false );
}
 
void QgsAttributeTableView::modelDeleted()
{
  mFilterModel = nullptr;
  mFeatureSelectionManager = nullptr;
  mFeatureSelectionModel = nullptr;
}
 
void QgsAttributeTableView::selectRow( int row, bool anchor )
{
  if ( selectionBehavior() == QTableView::SelectColumns || ( selectionMode() == QTableView::SingleSelection && selectionBehavior() == QTableView::SelectItems ) )
    return;
 
  if ( row >= 0 && row < model()->rowCount() )
  {
    const int column = horizontalHeader()->logicalIndexAt( isRightToLeft() ? viewport()->width() : 0 );
    const QModelIndex index = model()->index( row, column );
    QItemSelectionModel::SelectionFlags command = selectionCommand( index );
    selectionModel()->setCurrentIndex( index, QItemSelectionModel::NoUpdate );
    if ( ( anchor && !( command & QItemSelectionModel::Current ) ) || ( selectionMode() == QTableView::SingleSelection ) )
      mRowSectionAnchor = row;
 
    if ( selectionMode() != QTableView::SingleSelection && command.testFlag( QItemSelectionModel::Toggle ) )
    {
      if ( anchor )
        mCtrlDragSelectionFlag = mFeatureSelectionModel->isSelected( index ) ? QItemSelectionModel::Deselect : QItemSelectionModel::Select;
      command &= ~QItemSelectionModel::Toggle;
      command |= mCtrlDragSelectionFlag;
      if ( !anchor )
        command |= QItemSelectionModel::Current;
    }
 
    const QModelIndex tl = model()->index( std::min( mRowSectionAnchor, row ), 0 );
    const QModelIndex br = model()->index( std::max( mRowSectionAnchor, row ), model()->columnCount() - 1 );
    if ( verticalHeader()->sectionsMoved() && tl.row() != br.row() )
      setSelection( visualRect( tl ) | visualRect( br ), command );
    else
      mFeatureSelectionModel->selectFeatures( QItemSelection( tl, br ), command );
  }
}
 
void QgsAttributeTableView::showHorizontalSortIndicator()
{
  horizontalHeader()->setSortIndicatorShown( true );
}
 
void QgsAttributeTableView::actionTriggered()
{
  QAction *action = qobject_cast<QAction *>( sender() );
  const QgsFeatureId fid = action->property( "fid" ).toLongLong();
 
  QgsFeature f;
  mFilterModel->layerCache()->getFeatures( QgsFeatureRequest( fid ) ).nextFeature( f );
 
  if ( action->data().toString() == "user_action"_L1 )
  {
    mFilterModel->layer()->actions()->doAction( action->property( "action_id" ).toUuid(), f );
  }
  else if ( action->data().toString() == "map_layer_action"_L1 )
  {
    QObject *object = action->property( "action" ).value<QObject *>();
    QgsMapLayerAction *layerAction = qobject_cast<QgsMapLayerAction *>( object );
    if ( layerAction )
    {
      QgsMapLayerActionContext context;
      Q_NOWARN_DEPRECATED_PUSH
      layerAction->triggerForFeature( mFilterModel->layer(), f );
      Q_NOWARN_DEPRECATED_POP
      layerAction->triggerForFeature( mFilterModel->layer(), f, context );
    }
  }
}
 
void QgsAttributeTableView::columnSizeChanged( int index, int oldWidth, int newWidth )
{
  Q_UNUSED( oldWidth )
  emit columnResized( index, newWidth );
}
 
void QgsAttributeTableView::onActionColumnItemPainted( const QModelIndex &index )
{
  if ( !indexWidget( index ) )
  {
    QWidget *widget = createActionWidget( mFilterModel->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FeatureId ) ).toLongLong() );
    mActionWidgets.insert( index, widget );
    setIndexWidget( index, widget );
  }
}
 
void QgsAttributeTableView::recreateActionWidgets()
{
  QMap<QModelIndex, QWidget *>::const_iterator it = mActionWidgets.constBegin();
  for ( ; it != mActionWidgets.constEnd(); ++it )
  {
    // ownership of widget was transferred by initial call to setIndexWidget - clearing
    // the index widget will delete the old widget safely
    // they should then be recreated by onActionColumnItemPainted
    setIndexWidget( it.key(), nullptr );
  }
  mActionWidgets.clear();
}
 
void QgsAttributeTableView::scrollToFeature( const QgsFeatureId &fid, int col )
{
  const QModelIndex index = mFilterModel->fidToIndex( fid );
 
  if ( !index.isValid() )
    return;
 
  scrollTo( index );
 
  const QModelIndex selectionIndex = index.sibling( index.row(), col );
 
  if ( !selectionIndex.isValid() )
    return;
 
  selectionModel()->setCurrentIndex( index, QItemSelectionModel::SelectCurrent );
}
 
void QgsAttributeTableView::closeCurrentEditor()
{
  QWidget *editor = indexWidget( currentIndex() );
  commitData( editor );
  closeEditor( editor, QAbstractItemDelegate::NoHint );
}