New ActionTool (+ associated test)

Author: PierreRaybaut

doc/features/tools/reference.rst

@@ -1,11 +1,13 @@
 Reference
 ---------
 
-.. autoclass:: plotpy.tools.base.GuiTool
+.. autoclass:: plotpy.tools.GuiTool
    :members:
-.. autoclass:: plotpy.tools.base.InteractiveTool
+.. autoclass:: plotpy.tools.InteractiveTool
    :members:
-.. autoclass:: plotpy.tools.base.CommandTool
+.. autoclass:: plotpy.tools.CommandTool
+   :members:
+.. autoclass:: plotpy.tools.ActionTool
    :members:
 .. autoclass:: plotpy.tools.RectZoomTool
    :members:

plotpy/tests/gui/test_actiontool.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+#
+# Licensed under the terms of the BSD 3-Clause
+# (see plotpy/LICENSE for details)
+
+"""ActionTool test"""
+
+# guitest: show
+
+from guidata.qthelpers import create_action, qt_app_context
+from qtpy import QtWidgets as QW
+
+from plotpy.builder import make
+from plotpy.items import ImageItem
+from plotpy.plot import PlotDialog, PlotOptions
+from plotpy.tests.data import gen_image4
+from plotpy.tools import ActionTool
+
+
+class MyPlotDialog(PlotDialog):
+    def __init__(self):
+        """Reimplement PlotDialog method"""
+        super().__init__(
+            title="ActionTool test", toolbar=True, options=PlotOptions(type="image")
+        )
+        self.info_action = create_action(self, "Show infos", triggered=self.show_info)
+        self.manager.add_tool(ActionTool, self.info_action, item_types=(ImageItem,))
+
+    def show_info(self):
+        """Show infos on selected item(s)"""
+        # This is just a demo of what can be done with ActionTool
+        plot = self.get_plot()
+        for item in plot.get_selected_items():
+            QW.QMessageBox.information(self, "Item infos", str(item))
+
+
+def test_image_plot_tools():
+    """Test"""
+    with qt_app_context(exec_loop=True):
+        win = MyPlotDialog()
+        win.show()
+        image = make.image(gen_image4(500, 500), colormap="Spectral")
+        plot = win.manager.get_plot()
+        plot.add_item(image)
+
+
+if __name__ == "__main__":
+    test_image_plot_tools()

plotpy/tools/__init__.py

@@ -12,8 +12,10 @@
 )
 from .axes import AxisScaleTool, PlaceAxesTool
 from .base import (
+    ActionTool,
     CommandTool,
     DefaultToolbarID,
+    GuiTool,
     InteractiveTool,
     PanelTool,
     RectangularActionTool,

plotpy/tools/base.py

@@ -255,6 +255,41 @@ def set_status_active_item(self, plot):
             self.action.setEnabled(False)
 
 
+class ActionTool(CommandTool):
+    """Tool that simply associate an action to a tool"""
+
+    def __init__(
+        self,
+        manager,
+        action,
+        item_types=None,
+        toolbar_id=DefaultToolbarID,
+    ):
+        self.associated_action = action
+        self.item_types = item_types
+        super().__init__(
+            manager,
+            action.text(),
+            action.icon(),
+            action.toolTip(),
+            toolbar_id=toolbar_id,
+        )
+
+    def update_status(self, plot):
+        """Update tool status"""
+        if self.item_types is None:
+            self.action.setEnabled(True)
+        else:
+            items = plot.get_selected_items()
+            self.action.setEnabled(
+                any(isinstance(item, self.item_types) for item in items)
+            )
+
+    def create_action(self, manager):
+        """Create and return tool's action"""
+        return self.associated_action
+
+
 class ToggleTool(CommandTool):
     """ """