Add a "contextMenuAboutToShow" signal to QgsLayerTreeView

nyalldawson · github-actions[bot] · commit ddbf5ade195c · 2023-03-15T05:00:00.000Z
Allows plugins to hook into this menu and add custom entries
and customise the standard entries
diff --git a/python/gui/auto_generated/layertree/qgslayertreeview.sip.in b/python/gui/auto_generated/layertree/qgslayertreeview.sip.in
@@ -357,6 +357,15 @@ Emitted when a current layer is changed
     void datasetsDropped( QDropEvent *event );
 %Docstring
 Emitted when datasets are dropped onto the layer tree view
+%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
@@ -179,9 +179,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
@@ -354,6 +354,15 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView
     //! Emitted when datasets are dropped onto the layer tree view
     void datasetsDropped( QDropEvent *event );
 
+    /**
+     * 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;
 
