Add a "contextMenuAboutToShow" signal to QgsLayerTreeView

Allows plugins to hook into this menu and add custom entries and customise the standard entries (cherry picked from commit a79adfc)
qgis · Mar 16, 2023 · 2f48b1e · 2f48b1e
1 parent 73ecf0c
commit 2f48b1e
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/python/gui/auto_generated/layertree/qgslayertreeview.sip.in b/python/gui/auto_generated/layertree/qgslayertreeview.sip.in
@@ -351,6 +351,15 @@ Returns the show private layers status
     void currentLayerChanged( QgsMapLayer *layer );
 %Docstring
 Emitted when a current layer is changed
+%End
+
+    void contextMenuAboutToShow( QMenu *menu );
+%Docstring
+Emitted when the context menu is about to show.
+
+Allows customisation of the menu.
+
+.. versionadded:: 3.32
 %End
 
   protected:

diff --git a/src/gui/layertree/qgslayertreeview.cpp b/src/gui/layertree/qgslayertreeview.cpp
@@ -178,9 +178,14 @@ void QgsLayerTreeView::contextMenuEvent( QContextMenuEvent *event )
     setCurrentIndex( QModelIndex() );
 
   QMenu *menu = mMenuProvider->createContextMenu();
-  if ( menu && menu->actions().count() != 0 )
-    menu->exec( mapToGlobal( event->pos() ) );
-  delete menu;
+  if ( menu )
+  {
+    emit contextMenuAboutToShow( menu );
+
+    if ( menu->actions().count() != 0 )
+      menu->exec( mapToGlobal( event->pos() ) );
+    delete menu;
+  }
 }
 
 

diff --git a/src/gui/layertree/qgslayertreeview.h b/src/gui/layertree/qgslayertreeview.h
@@ -350,6 +350,15 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView
     //! Emitted when a current layer is changed
     void currentLayerChanged( QgsMapLayer *layer );
 
+    /**
+     * Emitted when the context menu is about to show.
+     *
+     * Allows customisation of the menu.
+     *
+     * \since QGIS 3.32
+     */
+    void contextMenuAboutToShow( QMenu *menu );
+
   protected:
     void contextMenuEvent( QContextMenuEvent *event ) override;