Add help button to plugin selection dialogs

gramps-project · Feb 1, 2025 · d8949f4 · d8949f4
1 parent fce30f2
commit d8949f4
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/gramps/gui/glade/plugins.glade b/gramps/gui/glade/plugins.glade
@@ -17,6 +17,21 @@
             <property name="can-focus">False</property>
             <property name="spacing">6</property>
             <property name="layout-style">end</property>
+            <child>
+              <object class="GtkButton" id="help">
+                <property name="label" translatable="yes">_Help</property>
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+                <property name="receives-default">True</property>
+                <property name="use-underline">True</property>
+                <signal name="clicked" handler="on_report_help_clicked" object="report" swapped="yes"/>
+              </object>
+              <packing>
+                <property name="expand">False</property>
+                <property name="fill">False</property>
+                <property name="position">0</property>
+              </packing>
+            </child>
             <child>
               <object class="GtkButton" id="button108">
                 <property name="label" translatable="yes">_Close</property>
@@ -30,7 +45,8 @@
               <packing>
                 <property name="expand">False</property>
                 <property name="fill">False</property>
-                <property name="position">0</property>
+                <property name="pack-type">end</property>
+                <property name="position">1</property>
               </packing>
             </child>
             <child>
@@ -51,7 +67,8 @@
               <packing>
                 <property name="expand">False</property>
                 <property name="fill">False</property>
-                <property name="position">1</property>
+                <property name="pack-type">end</property>
+                <property name="position">2</property>
               </packing>
             </child>
           </object>

diff --git a/gramps/gui/plug/_dialogs.py b/gramps/gui/plug/_dialogs.py
@@ -49,6 +49,7 @@
 from .report import report
 from ..pluginmanager import GuiPluginManager
 from ..managedwindow import ManagedWindow
+from ..display import display_help
 
 # -------------------------------------------------------------------------
 #
@@ -105,6 +106,7 @@ def __init__(
         self.dialog.connect_signals(
             {
                 "on_report_apply_clicked": self.on_apply_clicked,
+                "on_report_help_clicked": self.on_help_clicked,
                 "destroy_passed_object": self.close,
                 "on_delete_event": self.close,
             }
@@ -170,6 +172,13 @@ def on_apply_clicked(self, obj):
             return
         self.run_plugin(self.item)
 
+    def on_help_clicked(self, obj):
+        """Display help page for the selected report"""
+        if not self.item:
+            return
+        if self.item.help_url:
+            display_help(self.item.help_url)
+
     def on_node_selected(self, obj):
         """Updates the informational display on the right hand side of
         the dialog box with the description of the selected report"""