Add api for creating context menus for history nodes

qgis · Apr 23, 2023 · 363bf0c · 363bf0c
1 parent 1806c6e
commit 363bf0c
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 13 deletions.
diff --git a/python/gui/auto_generated/history/qgshistoryentrynode.sip.in b/python/gui/auto_generated/history/qgshistoryentrynode.sip.in
@@ -70,6 +70,12 @@ create the node's content.
 Called when the node is double-clicked. The default implementation does nothing.
 %End
 
+    virtual void populateContextMenu( QMenu *menu, const QgsHistoryWidgetContext &context );
+%Docstring
+Allows the node to populate a context ``menu`` before display to the user.
+
+Actions should be parented to the specified ``menu``.
+%End
 
     virtual bool matchesString( const QString &searchString ) const;
 %Docstring

diff --git a/src/gui/history/qgshistoryentrynode.cpp b/src/gui/history/qgshistoryentrynode.cpp
@@ -41,12 +41,10 @@ void QgsHistoryEntryNode::doubleClicked( const QgsHistoryWidgetContext & )
 
 }
 
-#if 0
-QList<QAction *> QgsHistoryEntryNode::actions( QWidget * )
+void QgsHistoryEntryNode::populateContextMenu( QMenu *, const QgsHistoryWidgetContext & )
 {
-  return {};
+
 }
-#endif
 
 bool QgsHistoryEntryNode::matchesString( const QString &string ) const
 {

diff --git a/src/gui/history/qgshistoryentrynode.h b/src/gui/history/qgshistoryentrynode.h
@@ -26,6 +26,7 @@
 
 class QWidget;
 class QAction;
+class QMenu;
 class QgsHistoryEntryGroup;
 class QgsHistoryWidgetContext;
 
@@ -92,18 +93,12 @@ class GUI_EXPORT QgsHistoryEntryNode
      */
     virtual void doubleClicked( const QgsHistoryWidgetContext &context );
 
-#if 0  // currently unused
-
     /**
-     * Returns a list of actions which users can trigger to interact with the history
-     * entry. Buttons corresponding to each action will be automatically created and
-     * shown to users.
+     * Allows the node to populate a context \a menu before display to the user.
      *
-     * Actions should be parented to the specified \a parent widget.
+     * Actions should be parented to the specified \a menu.
      */
-    virtual QList< QAction * > actions( const QgsHistoryWidgetContext &context, QWidget *parent );
-
-#endif
+    virtual void populateContextMenu( QMenu *menu, const QgsHistoryWidgetContext &context );
 
     /**
      * Returns true if the node matches the specified \a searchString, and

diff --git a/src/gui/history/qgshistorywidget.cpp b/src/gui/history/qgshistorywidget.cpp
@@ -19,6 +19,8 @@
 #include "qgshistoryentrynode.h"
 
 #include <QTextBrowser>
+#include <QtGlobal>
+#include <QMenu>
 
 QgsHistoryWidget::QgsHistoryWidget( const QString &providerId, Qgis::HistoryProviderBackends backends, QgsHistoryProviderRegistry *registry, const QgsHistoryWidgetContext &context, QWidget *parent )
   : QgsPanelWidget( parent )
@@ -38,6 +40,9 @@ QgsHistoryWidget::QgsHistoryWidget( const QString &providerId, Qgis::HistoryProv
   connect( mTreeView->selectionModel(), &QItemSelectionModel::currentChanged, this, &QgsHistoryWidget::currentItemChanged );
   connect( mTreeView, &QTreeView::doubleClicked, this, &QgsHistoryWidget::nodeDoubleClicked );
 
+  mTreeView->setContextMenuPolicy( Qt::CustomContextMenu );
+  connect( mTreeView, &QWidget::customContextMenuRequested, this, &QgsHistoryWidget::showNodeContextMenu );
+
   // expand first group (usually most recent date group)
   const QModelIndex firstGroup = mProxyModel->index( 0, 0, QModelIndex() );
   mTreeView->expand( firstGroup );
@@ -86,6 +91,21 @@ void QgsHistoryWidget::nodeDoubleClicked( const QModelIndex &index )
   }
 }
 
+void QgsHistoryWidget::showNodeContextMenu( const QPoint &pos )
+{
+  if ( QgsHistoryEntryNode *node = mModel->index2node( mProxyModel->mapToSource( mTreeView->currentIndex() ) ) )
+  {
+    QMenu *menu = new QMenu();
+
+    node->populateContextMenu( menu, mContext );
+    if ( !menu->isEmpty() )
+    {
+      menu->exec( mTreeView->mapToGlobal( pos ) );
+    }
+    delete menu;
+  }
+}
+
 //
 // QgsHistoryEntryProxyModel
 //

diff --git a/src/gui/history/qgshistorywidget.h b/src/gui/history/qgshistorywidget.h
@@ -80,6 +80,7 @@ class GUI_EXPORT QgsHistoryWidget : public QgsPanelWidget, private Ui::QgsHistor
 
     void currentItemChanged( const QModelIndex &selected, const QModelIndex &previous );
     void nodeDoubleClicked( const QModelIndex &index );
+    void showNodeContextMenu( const QPoint &pos );
 
   private: