Makes messaging and clipboard logic into its own mixin

Author: marcosfrenkel

plottr/plot/base.py

@@ -13,7 +13,7 @@
 
 import numpy as np
 
-from .. import Signal, Flowchart, QtWidgets
+from .. import Signal, Flowchart, QtCore, QtWidgets
 from ..data.datadict import DataDictBase, DataDict, MeshgridDataDict
 from ..node import Node, linearFlowchart
 from ..utils import LabeledOptions
@@ -22,6 +22,37 @@
 __license__ = 'MIT'
 
 
+class ClipboardMessageMixin:
+    """
+    Mixin for widgets that show a transient clipboard-feedback message
+    and revert to a hint message after a short timeout.
+
+    Subclasses must inherit from a ``QObject``, implement ``_displayMessage``
+    to render the text, and call ``_initClipboardMessage`` once in ``__init__``.
+    """
+
+    CLIPBOARD_MESSAGE_DURATION_MS = 1500
+    CLIPBOARD_HINT_MESSAGE = "Click on plot to copy coordinates"
+
+    def _initClipboardMessage(self) -> None:
+        self.clipboardMessageActive = False
+        self.clipboardResetTimer = QtCore.QTimer(self)
+        self.clipboardResetTimer.setSingleShot(True)
+        self.clipboardResetTimer.timeout.connect(self.clearClipboardMessage)
+
+    def _displayMessage(self, message: str) -> None:
+        raise NotImplementedError
+
+    def showClipboardMessage(self, message: str) -> None:
+        self.clipboardMessageActive = True
+        self._displayMessage(message)
+        self.clipboardResetTimer.start(self.CLIPBOARD_MESSAGE_DURATION_MS)
+
+    def clearClipboardMessage(self) -> None:
+        self.clipboardMessageActive = False
+        self._displayMessage(self.CLIPBOARD_HINT_MESSAGE)
+
+
 class PlotNode(Node):
     """
     Basic Plot Node, derived from :class:`plottr.node.node.Node`.

plottr/plot/mpl/widgets.py

@@ -8,7 +8,7 @@
 from matplotlib import rcParams
 from matplotlib.axes import Axes
 from matplotlib.figure import Figure
-from matplotlib.backend_bases import LocationEvent, Event
+from matplotlib.backend_bases import LocationEvent, MouseButton, Event
 from matplotlib.backends.backend_qt5agg import (
     FigureCanvasQTAgg as FCanvas,
     NavigationToolbar2QT as NavBar,
@@ -18,37 +18,27 @@
 from plottr import QtWidgets, QtGui, QtCore, Signal, config as plottrconfig
 from plottr.data.datadict import DataDictBase
 from plottr.gui.tools import widgetDialog, dpiScalingFactor
-from ..base import PlotWidget, PlotWidgetContainer
+from ..base import PlotWidget, PlotWidgetContainer, ClipboardMessageMixin
 
 
-class MPLNavBar(NavBar):
+class MPLNavBar(ClipboardMessageMixin, NavBar):
     """
     Toolbar subclass that shows a hint when the mouse is outside the axes
     and can pin a clipboard confirmation message, so hovering won't overwrite it
     for a few seconds to make the message visible.
     """
 
     def __init__(self, canvas: FCanvas, parent: QtWidgets.QWidget):
-        self.clipboardMessageActive = False
-        self.hintMessage = "Click on plot to copy coordinates"
         super().__init__(canvas, parent)
-        self.clipboardResetTimer = QtCore.QTimer(self)
-        self.clipboardResetTimer.setSingleShot(True)
-        self.clipboardResetTimer.timeout.connect(self.clearClipboardMessage)
+        self._initClipboardMessage()
 
     def set_message(self, s: str) -> None:
         if self.clipboardMessageActive:
             return
-        super().set_message(s if s else self.hintMessage)
+        NavBar.set_message(self, s if s else self.CLIPBOARD_HINT_MESSAGE)
 
-    def showClipboardMessage(self, message: str) -> None:
-        self.clipboardMessageActive = True
-        super().set_message(message)
-        self.clipboardResetTimer.start(1500)
-
-    def clearClipboardMessage(self) -> None:
-        self.clipboardMessageActive = False
-        super().set_message(self.hintMessage)
+    def _displayMessage(self, message: str) -> None:
+        NavBar.set_message(self, message)
 
 
 class MPLPlot(FCanvas):
@@ -161,6 +151,8 @@ def metaToClipboard(self) -> None:
 
     def coordinateToClipboard(self, event: Event) -> None:
         if isinstance(event, LocationEvent):
+            if getattr(event, 'button', None) != MouseButton.LEFT:
+                return
             clipboard = QtWidgets.QApplication.clipboard()
             if event.xdata is not None and event.ydata is not None:
                 coord_info_string = '({:.8g}, {:.8g})'.format(event.xdata, event.ydata)
@@ -255,4 +247,4 @@ def figureDialog() -> Tuple[Figure, QtWidgets.QDialog]:
     :return: The figure object of the plot, and the dialog window object.
     """
     widget = MPLPlotWidget()
-    return widget.plot.fig, widgetDialog(widget)
+    return widget.plot.fig, widgetDialog(widget)

plottr/plot/pyqtgraph/autoplot.py

@@ -23,7 +23,7 @@
 from .plots import Plot, PlotWithColorbar, PlotBase
 from ..base import AutoFigureMaker as BaseFM, PlotDataType, \
     PlotItem, ComplexRepresentation, determinePlotDataType, \
-    PlotWidgetContainer, PlotWidget
+    PlotWidgetContainer, PlotWidget, ClipboardMessageMixin
 
 logger = logging.getLogger(__name__)
 
@@ -249,7 +249,7 @@ def _scatterPlot2d(self, plotItem: PlotItem) -> None:
         subPlot.setScatter2d(*plotItem.data)
 
 
-class AutoPlot(PlotWidget):
+class AutoPlot(ClipboardMessageMixin, PlotWidget):
     """Widget for automatic plotting with pyqtgraph.
 
     Uses :class:`.FigureMaker` to produce subplots.
@@ -271,16 +271,11 @@ def __init__(self, parent: Optional[PlotWidgetContainer]) -> None:
         layout.setContentsMargins(0, 0, 0, 0)
         layout.setSpacing(0)
 
-        self.statusLabel = QtWidgets.QLabel("Click on plot to copy coordinates")
+        self._initClipboardMessage()
+        self.statusLabel = QtWidgets.QLabel(self.CLIPBOARD_HINT_MESSAGE)
         self.statusLabel.setAlignment(QtCore.Qt.AlignCenter)
         self.statusLabel.setStyleSheet("color: gray;")
 
-        self.clipboardMessageActive = False
-        self.hintMessage = "Click on plot to copy coordinates"
-        self.clipboardResetTimer = QtCore.QTimer(self)
-        self.clipboardResetTimer.setSingleShot(True)
-        self.clipboardResetTimer.timeout.connect(self.clearClipboardMessage)
-
         self.setLayout(layout)
         self.setMinimumSize(*getcfg('main', 'pyqtgraph', 'minimum_plot_size',
                                     default=(400, 400)))
@@ -371,18 +366,12 @@ def _plotData(self, **kwargs: Any) -> None:
     def _refreshPlot(self) -> None:
         self._plotData()
 
-    def showClipboardMessage(self, message: str) -> None:
-        self.clipboardMessageActive = True
+    def _displayMessage(self, message: str) -> None:
         self.statusLabel.setText(message)
-        self.clipboardResetTimer.start(1500)
-
-    def clearClipboardMessage(self) -> None:
-        self.clipboardMessageActive = False
-        self.statusLabel.setText(self.hintMessage)
 
     def setStatusMessage(self, message: str) -> None:
         if not self.clipboardMessageActive:
-            self.statusLabel.setText(message if message else self.hintMessage)
+            self.statusLabel.setText(message if message else self.CLIPBOARD_HINT_MESSAGE)
 
     def _connectPlotEvents(self, subplot: PlotBase) -> None:
         subplot.plot.scene().sigMouseMoved.connect(
@@ -402,6 +391,8 @@ def _onMouseMoved(self, subplot: PlotBase, pos: Any) -> None:
             self.setStatusMessage('')
 
     def _onPlotClicked(self, subplot: PlotBase, event: Any) -> None:
+        if event.button() != QtCore.Qt.LeftButton:
+            return
         vb = subplot.plot.getViewBox()
         local = vb.mapFromScene(event.scenePos())
         if vb.boundingRect().contains(local):