Edit tools (edit data, parameters, ...): excluding read-only items

Author: PierreRaybaut

CHANGELOG.md

@@ -22,6 +22,9 @@
   * 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)
   * The signal is emitted with the item as argument
   * The `ItemListWidget` now listens to this signal and refreshes the item list accordingly
+* Edit tools (Edit data, parameters, etc.):
+  * Exclude read-only items from the list of editable items
+  * It is no longer possible to edit parameters or data of read-only items
 
 Other changes:
 

plotpy/plot/base.py

@@ -1812,7 +1812,8 @@ def get_plot_parameters_status(self, key: str) -> bool:
             bool: True if the plot parameters are available
         """
         if key == "item":
-            return self.get_active_item() is not None
+            item = self.get_active_item()
+            return item is not None and not item.is_readonly()
         else:
             return True
 

plotpy/tools/item.py

@@ -131,6 +131,20 @@ def __init__(self, manager, toolbar_id: str | type[DefaultToolbarID] | None = No
             manager, toolbar_id, curve_func=edit_curve_data, image_func=edit_image_data
         )
 
+    def get_supported_items(self, plot: BasePlot) -> list:
+        """
+        Get supported items from the plot.
+
+        Args:
+            plot: Plot instance
+
+        Returns:
+            List of supported plot items
+        """
+        items = super().get_supported_items(plot)
+        # Read-only items are not editable, obviously
+        return [item for item in items if not item.is_readonly()]
+
 
 class ExportItemDataTool(ItemManipulationBaseTool):
     """Tool for exporting item data."""
@@ -189,10 +203,11 @@ def get_supported_items(self, plot: BasePlot) -> list:
             AnnotatedCircle,
             AnnotatedPolygon,
         )
+        # Read-only items are not editable, obviously
         return [
             item
             for item in plot.get_selected_items(z_sorted=True)
-            if isinstance(item, item_types)
+            if isinstance(item, item_types) and not item.is_readonly()
         ]
 
     def update_status(self, plot: BasePlot) -> None:
@@ -233,15 +248,15 @@ def __init__(self, manager, toolbar_id: str | type[DefaultToolbarID] | None = No
         """
         super().__init__(manager, _("Remove"), "trash.png", toolbar_id=toolbar_id)
 
-    def get_removable_items(self, plot: BasePlot) -> list:
+    def get_supported_items(self, plot: BasePlot) -> list:
         """
-        Get removable items from the plot.
+        Get supported items from the plot.
 
         Args:
             plot: Plot instance
 
         Returns:
-            List of removable plot items
+            List of supported plot items
         """
         return [item for item in plot.get_selected_items() if not item.is_readonly()]
 
@@ -252,7 +267,7 @@ def update_status(self, plot: BasePlot) -> None:
         Args:
             plot: Plot instance
         """
-        self.action.setEnabled(len(self.get_removable_items(plot)) > 0)
+        self.action.setEnabled(len(self.get_supported_items(plot)) > 0)
 
     def activate_command(self, plot: BasePlot, checked: bool) -> None:
         """
@@ -262,7 +277,7 @@ def activate_command(self, plot: BasePlot, checked: bool) -> None:
             plot: Plot instance
             checked: Whether the tool is checked
         """
-        items = self.get_removable_items(plot)
+        items = self.get_supported_items(plot)
         if len(items) == 1:
             message = _("Do you really want to remove this item?")
         else: