enhance sorting capabilities in attribute table list/form view (#36199)

qgis · May 6, 2020 · 7e0c438 · 7e0c438
1 parent 3474934
commit 7e0c438
Show file tree

Hide file tree

Showing 7 changed files with 121 additions and 25 deletions.
diff --git a/images/images.qrc b/images/images.qrc
@@ -675,6 +675,7 @@
         <file>themes/default/multieditSameValues.svg</file>
         <file>themes/default/locked_repeating.svg</file>
         <file>themes/default/sort.svg</file>
+        <file>themes/default/sort-reverse.svg</file>
         <file>themes/default/styleicons/multibandcolor.svg</file>
         <file>themes/default/styleicons/paletted.svg</file>
         <file>themes/default/styleicons/singlebandgray.svg</file>

diff --git a/images/themes/default/sort-reverse.svg b/images/themes/default/sort-reverse.svg
diff --git a/python/gui/auto_generated/attributetable/qgsfeaturelistmodel.sip.in b/python/gui/auto_generated/attributetable/qgsfeaturelistmodel.sip.in
@@ -62,6 +62,10 @@ If ``True`` is specified, a NULL value will be injected
 
 :param injectNull: state of null value injection
 
+.. note::
+
+   If set to ``True``, the sort by display expression cannot be used
+
 .. versionadded:: 2.9
 %End
 
@@ -139,7 +143,7 @@ Sort this model by its display expression.
 .. versionadded:: 3.2
 %End
 
-    void setSortByDisplayExpression( bool sortByDisplayExpression );
+    void setSortByDisplayExpression( bool sortByDisplayExpression, Qt::SortOrder order = Qt::AscendingOrder );
 %Docstring
 Sort this model by its display expression.
 

diff --git a/src/gui/attributetable/qgsdualview.cpp b/src/gui/attributetable/qgsdualview.cpp
@@ -209,9 +209,31 @@ void QgsDualView::columnBoxInit()
     }
   }
 
-  QAction *sortByPreviewExpression = new QAction( QgsApplication::getThemeIcon( QStringLiteral( "sort.svg" ) ), tr( "Sort by preview expression" ), this );
-  connect( sortByPreviewExpression, &QAction::triggered, this, &QgsDualView::sortByPreviewExpression );
-  mFeatureListPreviewButton->addAction( sortByPreviewExpression );
+  QMenu *sortMenu = new QMenu( this );
+  QAction *sortMenuAction = new QAction( QgsApplication::getThemeIcon( QStringLiteral( "sort.svg" ) ), tr( "Sort…" ), this );
+  sortMenuAction->setMenu( sortMenu );
+
+  QAction *sortByPreviewExpressionAsc = new QAction( QgsApplication::getThemeIcon( QStringLiteral( "sort.svg" ) ), tr( "By Preview Expression (ascending)" ), this );
+  connect( sortByPreviewExpressionAsc, &QAction::triggered, this, [ = ]()
+  {
+    mFeatureListModel->setSortByDisplayExpression( true, Qt::AscendingOrder );
+  } );
+  sortMenu->addAction( sortByPreviewExpressionAsc );
+  QAction *sortByPreviewExpressionDesc = new QAction( QgsApplication::getThemeIcon( QStringLiteral( "sort-reverse.svg" ) ), tr( "By Preview Expression (descending)" ), this );
+  connect( sortByPreviewExpressionDesc, &QAction::triggered, this, [ = ]()
+  {
+    mFeatureListModel->setSortByDisplayExpression( true, Qt::DescendingOrder );
+  } );
+  sortMenu->addAction( sortByPreviewExpressionDesc );
+  QAction *sortByPreviewExpressionCustom = new QAction( QgsApplication::getThemeIcon( QStringLiteral( "mIconExpressionPreview.svg" ) ), tr( "By Custom Expression" ), this );
+  connect( sortByPreviewExpressionCustom, &QAction::triggered, this, [ = ]()
+  {
+    if ( modifySort() )
+      mFeatureListModel->setSortByDisplayExpression( false );
+  } );
+  sortMenu->addAction( sortByPreviewExpressionCustom );
+
+  mFeatureListPreviewButton->addAction( sortMenuAction );
 
   QAction *separator = new QAction( mFeatureListPreviewButton );
   separator->setSeparator( true );
@@ -820,7 +842,7 @@ void QgsDualView::showViewHeaderMenu( QPoint point )
   connect( organize, &QAction::triggered, this, &QgsDualView::organizeColumns );
   mHorizontalHeaderMenu->addAction( organize );
   QAction *sort = new QAction( tr( "&Sort…" ), mHorizontalHeaderMenu );
-  connect( sort, &QAction::triggered, this, &QgsDualView::modifySort );
+  connect( sort, &QAction::triggered, this, [ = ]() {modifySort();} );
   mHorizontalHeaderMenu->addAction( sort );
 
   mHorizontalHeaderMenu->popup( mTableView->horizontalHeader()->mapToGlobal( point ) );
@@ -895,10 +917,10 @@ void QgsDualView::autosizeColumn()
   mTableView->resizeColumnToContents( col );
 }
 
-void QgsDualView::modifySort()
+bool QgsDualView::modifySort()
 {
   if ( !mLayer )
-    return;
+    return false;
 
   QgsAttributeTableConfig config = mConfig;
 
@@ -946,7 +968,13 @@ void QgsDualView::modifySort()
     }
 
     setAttributeTableConfig( config );
+    return true;
   }
+  else
+  {
+    return false;
+  }
+
 }
 
 void QgsDualView::zoomToCurrentFeature()
@@ -1025,16 +1053,6 @@ void QgsDualView::onSortColumnChanged()
   }
 }
 
-void QgsDualView::sortByPreviewExpression()
-{
-  Qt::SortOrder sortOrder = Qt::AscendingOrder;
-  if ( mFeatureListView->displayExpression() == sortExpression() )
-  {
-    sortOrder = mConfig.sortOrder() == Qt::AscendingOrder ? Qt::DescendingOrder : Qt::AscendingOrder;
-  }
-  setSortExpression( mFeatureListView->displayExpression(), sortOrder );
-}
-
 void QgsDualView::updateSelectedFeatures()
 {
   QgsFeatureRequest r = mMasterModel->request();

diff --git a/src/gui/attributetable/qgsdualview.h b/src/gui/attributetable/qgsdualview.h
@@ -346,14 +346,10 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas
 
     void autosizeColumn();
 
-    void modifySort();
-
     void previewExpressionChanged( const QString &expression );
 
     void onSortColumnChanged();
 
-    void sortByPreviewExpression();
-
     void updateSelectedFeatures();
 
     void extentChanged();
@@ -409,6 +405,10 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas
     //! disable/enable the buttons of the browsing toolbar (feature list view)
     void setBrowsingAutoPanScaleAllowed( bool allowed );
 
+    //! Returns TRUE if the expression dialog has been accepted
+    bool modifySort();
+
+
     QgsFieldConditionalFormatWidget *mConditionalFormatWidget = nullptr;
     QgsAttributeEditorContext mEditorContext;
     QgsAttributeTableModel *mMasterModel = nullptr;

diff --git a/src/gui/attributetable/qgsfeaturelistmodel.cpp b/src/gui/attributetable/qgsfeaturelistmodel.cpp
@@ -281,17 +281,17 @@ bool QgsFeatureListModel::sortByDisplayExpression() const
   return mSortByDisplayExpression;
 }
 
-void QgsFeatureListModel::setSortByDisplayExpression( bool sortByDisplayExpression )
+void QgsFeatureListModel::setSortByDisplayExpression( bool sortByDisplayExpression, Qt::SortOrder order )
 {
   mSortByDisplayExpression = sortByDisplayExpression;
 
   // If we are sorting by display expression, we do not support injected null
-  if ( sortByDisplayExpression )
+  if ( mSortByDisplayExpression )
     setInjectNull( false );
 
   setSortRole( QgsAttributeTableModel::SortRole + 1 );
   setDynamicSortFilter( mSortByDisplayExpression );
-  sort( 0 );
+  sort( 0, order );
 }
 
 QModelIndex QgsFeatureListModel::mapToMaster( const QModelIndex &proxyIndex ) const

diff --git a/src/gui/attributetable/qgsfeaturelistmodel.h b/src/gui/attributetable/qgsfeaturelistmodel.h
@@ -80,6 +80,7 @@ class GUI_EXPORT QgsFeatureListModel : public QSortFilterProxyModel, public QgsF
     /**
      * \brief If TRUE is specified, a NULL value will be injected
      * \param injectNull state of null value injection
+     * \note If set to TRUE, the sort by display expression cannot be used
      * \since QGIS 2.9
      */
     void setInjectNull( bool injectNull );
@@ -153,7 +154,7 @@ class GUI_EXPORT QgsFeatureListModel : public QSortFilterProxyModel, public QgsF
      *
      * \since QGIS 3.2
      */
-    void setSortByDisplayExpression( bool sortByDisplayExpression );
+    void setSortByDisplayExpression( bool sortByDisplayExpression, Qt::SortOrder order = Qt::AscendingOrder );
 
   public slots: