Expose 'Search Selection in PyQGIS docs' action for all python code e…

…ditors
qgis · Apr 5, 2023 · 895a68f · 895a68f
1 parent ca6df18
commit 895a68f
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 10 deletions.
diff --git a/python/console/console_editor.py b/python/console/console_editor.py
@@ -112,7 +112,7 @@ def contextMenuEvent(self, e):
                                      QCoreApplication.translate("PythonConsole", "Run Selected"),
                                      self.runSelectedCode, 'Ctrl+E')  # spellok
         pyQGISHelpAction = menu.addAction(QgsApplication.getThemeIcon("console/iconHelpConsole.svg"),
-                                          QCoreApplication.translate("PythonConsole", "Search Selected in PyQGIS docs"),
+                                          QCoreApplication.translate("PythonConsole", "Search Selection in PyQGIS Documentation"),
                                           self.searchSelectedTextInPyQGISDocs)
         menu.addAction(QgsApplication.getThemeIcon("mActionStart.svg"),
                        QCoreApplication.translate("PythonConsole", "Run Script"),

diff --git a/python/console/console_output.py b/python/console/console_output.py
@@ -179,7 +179,7 @@ def contextMenuEvent(self, e):
                                      QCoreApplication.translate("PythonConsole", "Clear Console"),
                                      self.clearConsole)
         pyQGISHelpAction = menu.addAction(QgsApplication.getThemeIcon("console/iconHelpConsole.svg"),
-                                          QCoreApplication.translate("PythonConsole", "Search Selected in PyQGIS docs"),
+                                          QCoreApplication.translate("PythonConsole", "Search Selection in PyQGIS Documentation"),
                                           self.searchSelectedTextInPyQGISDocs)
         menu.addSeparator()
         copyAction = menu.addAction(

diff --git a/python/console/console_sci.py b/python/console/console_sci.py
@@ -213,14 +213,6 @@ def keyPressEvent(self, e):
         QgsCodeEditorPython.keyPressEvent(self, e)
         self.updatePrompt()
 
-    def populateContextMenu(self, menu):
-        pyQGISHelpAction = menu.addAction(
-            QgsApplication.getThemeIcon("console/iconHelpConsole.svg"),
-            QCoreApplication.translate("PythonConsole", "Search Selected in PyQGIS docs"),
-            self.searchSelectedTextInPyQGISDocs
-        )
-        pyQGISHelpAction.setEnabled(self.hasSelectedText())
-
     def mousePressEvent(self, e):
         """
         Re-implemented to handle the mouse press event.

diff --git a/python/gui/auto_generated/codeeditors/qgscodeeditorpython.sip.in b/python/gui/auto_generated/codeeditors/qgscodeeditorpython.sip.in
@@ -115,6 +115,8 @@ Toggle comment for the selected text.
     virtual void keyPressEvent( QKeyEvent *event );
     virtual QString reformatCodeString( const QString &string );
 
+    virtual void populateContextMenu( QMenu *menu );
+
 
   protected slots:
 

diff --git a/src/gui/codeeditors/qgscodeeditorpython.cpp b/src/gui/codeeditors/qgscodeeditorpython.cpp
@@ -32,6 +32,8 @@
 #include <Qsci/qscilexerpython.h>
 #include <QDesktopServices>
 #include <QKeyEvent>
+#include <QAction>
+#include <QMenu>
 
 const QMap<QString, QString> QgsCodeEditorPython::sCompletionPairs
 {
@@ -516,6 +518,21 @@ QString QgsCodeEditorPython::reformatCodeString( const QString &string )
   return newText;
 }
 
+void QgsCodeEditorPython::populateContextMenu( QMenu *menu )
+{
+  QgsCodeEditor::populateContextMenu( menu );
+
+  QAction *pyQgisHelpAction = new QAction(
+    QgsApplication::getThemeIcon( QStringLiteral( "console/iconHelpConsole.svg" ) ),
+    tr( "Search Selection in PyQGIS Documentation" ),
+    menu );
+  pyQgisHelpAction->setEnabled( hasSelectedText() );
+  connect( pyQgisHelpAction, &QAction::triggered, this, &QgsCodeEditorPython::searchSelectedTextInPyQGISDocs );
+
+  menu->addSeparator();
+  menu->addAction( pyQgisHelpAction );
+}
+
 void QgsCodeEditorPython::autoComplete()
 {
   switch ( autoCompletionSource() )

diff --git a/src/gui/codeeditors/qgscodeeditorpython.h b/src/gui/codeeditors/qgscodeeditorpython.h
@@ -142,6 +142,7 @@ class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor
     void initializeLexer() override;
     virtual void keyPressEvent( QKeyEvent *event ) override;
     QString reformatCodeString( const QString &string ) override;
+    void populateContextMenu( QMenu *menu ) override;
 
   protected slots: