Add SIG_ITEM_PARAMETERS_CHANGED signal to BasePlot class

Author: PierreRaybaut

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog #
 
+## Version 2.2.0 ##
+
+New features:
+
+* Added `SIG_ITEM_PARAMETERS_CHANGED` signal to `BasePlot` class:
+  * This signal is emitted when the parameters of an item are changed using the
+    parameters dialog, or a specific tool (e.g. the colormap selection tool,
+    or the lock/unlock tool for image items)
+  * This signal is emitted with the item as argument
+  * It is often emitted before the `SIG_ITEMS_CHANGED` signal, which is global to all
+    items, but not necessarily. For example, when the colormap of an image is changed,
+    the `SIG_ITEM_PARAMETERS_CHANGED` signal is emitted for the image item, but the
+    `SIG_ITEMS_CHANGED` signal is not emitted.
+
 ## Version 2.1.2 ##
 
 New features:

doc/features/signals.rst

@@ -24,6 +24,7 @@ Signals emitted by :py:class:`.BasePlot` objects:
 - :py:attr:`.BasePlot.SIG_ANNOTATION_CHANGED`
 - :py:attr:`.BasePlot.SIG_RANGE_CHANGED`
 - :py:attr:`.BasePlot.SIG_ITEMS_CHANGED`
+- :py:attr:`.BasePlot.SIG_ITEM_PARAMETERS_CHANGED`
 - :py:attr:`.BasePlot.SIG_ACTIVE_ITEM_CHANGED`
 - :py:attr:`.BasePlot.SIG_ITEM_REMOVED`
 - :py:attr:`.BasePlot.SIG_ITEM_SELECTION_CHANGED`

plotpy/__init__.py

@@ -20,7 +20,7 @@
 .. _GitHub: https://github.com/PierreRaybaut/plotpy
 """
 
-__version__ = "2.1.2"
+__version__ = "2.2.0"
 __VERSION__ = tuple([int(number) for number in __version__.split(".")])
 
 # --- Important note: DATAPATH and LOCALEPATH are used by guidata.configtools

plotpy/plot/base.py

@@ -229,6 +229,13 @@ class BasePlot(qwt.QwtPlot):
     #:     plot: the plot
     SIG_ITEMS_CHANGED = QC.Signal(object)
 
+    #: Signal emitted by plot when item parameters have changed (through the item's
+    #: parameters dialog, or when setting colormap using the dedicated tool)
+    #:
+    #: Args:
+    #:     item: the item
+    SIG_ITEM_PARAMETERS_CHANGED = QC.Signal(object)
+
     #: Signal emitted by plot when selected item has changed
     #:
     #: Args:

plotpy/styles/base.py

@@ -274,6 +274,7 @@ def update(self, plot: BasePlot) -> None:
         """
         for item in self.items:
             item.set_item_parameters(self)
+            plot.SIG_ITEM_PARAMETERS_CHANGED.emit(item)
         plot.replot()
         plot.SIG_ITEMS_CHANGED.emit(plot)
 

plotpy/tools/image.py

@@ -285,7 +285,7 @@ class ReverseYAxisTool(ToggleTool):
     def __init__(self, manager: PlotManager) -> None:
         super().__init__(manager, _("Reverse Y axis"))
 
-    def activate_command(self, plot: PlotManager, checked: bool) -> None:
+    def activate_command(self, plot: BasePlot, checked: bool) -> None:
         """Triggers tool action.
 
         Args:
@@ -295,7 +295,7 @@ def activate_command(self, plot: PlotManager, checked: bool) -> None:
         plot.set_axis_direction("left", checked)
         plot.replot()
 
-    def update_status(self, plot: PlotManager) -> None:
+    def update_status(self, plot: BasePlot) -> None:
         """Update tool status if the plot type is not PlotType.CURVE.
 
         Args:
@@ -346,7 +346,7 @@ def set_aspect_ratio_1_1(self) -> None:
             plot.set_aspect_ratio(ratio=1)
             plot.replot()
 
-    def activate_command(self, plot: PlotManager, checked: bool) -> None:
+    def activate_command(self, plot: BasePlot, checked: bool) -> None:
         """Triggers tool action.
 
         Args:
@@ -499,16 +499,16 @@ def activate_cmap(self, cmap: str | EditableColormap) -> None:
             self._active_colormap = get_cmap(cmap)
         else:
             self._active_colormap = cmap
-        plot = self.get_active_plot()
+        plot: BasePlot = self.get_active_plot()
         if self._active_colormap is not None and plot is not None:
             items = self.get_selected_images(plot)
             for item in items:
                 item.param.colormap = self._active_colormap.name
                 item.param.update_item(item)
+                plot.SIG_ITEM_PARAMETERS_CHANGED.emit(item)
             self.action.setText(_("Colormap: %s") % self._active_colormap.name)
             plot.invalidate()
             self.update_status(plot)
-            plot.SIG_ITEMS_CHANGED.emit(plot)
 
     def update_status(self, plot: BasePlot) -> None:
         """Update tool status if the plot type is not PlotType.CURVE.
@@ -825,7 +825,7 @@ def __init__(self, manager: PlotManager, toolbar_id=None) -> None:
             manager, title=_("Lock"), icon=get_icon("lock.png"), toolbar_id=None
         )
 
-    def activate_command(self, plot: PlotManager, checked: bool) -> None:
+    def activate_command(self, plot: BasePlot, checked: bool) -> None:
         """Trigger tool action.
 
         Args:
@@ -840,6 +840,7 @@ def activate_command(self, plot: PlotManager, checked: bool) -> None:
                     item.setIcon(get_icon("trimage_lock.png"))
                 else:
                     item.setIcon(get_icon("image.png"))
+                plot.SIG_ITEM_PARAMETERS_CHANGED.emit(item)
             plot.SIG_ITEMS_CHANGED.emit(plot)
 
     def get_supported_items(self, plot: BasePlot) -> list[IBasePlotItem | TrImageItem]: