Changeset c4e5400 in sasview

Timestamp:

Dec 12, 2016 3:21:03 AM (8 years ago)

Author:

Piotr Rozyczko <rozyczko@…>

Branches:

ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc

Children:

27313b7

Parents:

3b7b218

Message:

Refactored context menu setup for plots

Location:

src/sas/qtgui

Files:

• Plotter.py (modified) (2 diffs)
• Plotter2D.py (modified) (2 diffs)
• PlotterBase.py (modified) (2 diffs)
• UnitTesting/PlotterBaseTest.py (modified) (5 diffs)

src/sas/qtgui/Plotter.py

@@ -73 +73 @@
         self.canvas.draw()
 
+    def contextMenu(self):
+        """
+        Define common context menu and associated actions for the MPL widget
+        """
+        self.defaultContextMenu()
+
+
     def contextMenuQuickPlot(self):
         """
         Define context menu and associated actions for the quickplot MPL widget
         """
-        # Actions
-        self.contextMenu = QtGui.QMenu(self)
-        self.actionSaveImage = self.contextMenu.addAction("Save Image")
-        self.actionPrintImage = self.contextMenu.addAction("Print Image")
-        self.actionCopyToClipboard = self.contextMenu.addAction("Copy to Clipboard")
-        self.contextMenu.addSeparator()
+        # Default actions
+        self.defaultContextMenu()
+
+        # Additional actions
         self.actionToggleGrid = self.contextMenu.addAction("Toggle Grid On/Off")
         self.contextMenu.addSeparator()
@@ -88 +93 @@
 
         # Define the callbacks
-        self.actionSaveImage.triggered.connect(self.onImageSave)
-        self.actionPrintImage.triggered.connect(self.onImagePrint)
-        self.actionCopyToClipboard.triggered.connect(self.onClipboardCopy)
         self.actionToggleGrid.triggered.connect(self.onGridToggle)
         self.actionChangeScale.triggered.connect(self.onScaleChange)

src/sas/qtgui/Plotter2D.py

@@ -78 +78 @@
                       zmax=zmax_2D_temp)
 
+    def contextMenu(self):
+        """
+        Define common context menu and associated actions for the MPL widget
+        """
+        self.defaultContextMenu()
+
     def contextMenuQuickPlot(self):
         """
         Define context menu and associated actions for the quickplot MPL widget
         """
-        # Actions
-        self.contextMenu = QtGui.QMenu(self)
-        self.actionSaveImage = self.contextMenu.addAction("Save Image")
-        self.actionPrintImage = self.contextMenu.addAction("Print Image")
-        self.actionCopyToClipboard = self.contextMenu.addAction("Copy to Clipboard")
-        self.contextMenu.addSeparator()
+        self.defaultContextMenu()
+
         if self.dimension == 2:
             self.actionToggleGrid = self.contextMenu.addAction("Toggle Grid On/Off")
@@ -94 +96 @@
 
         # Define the callbacks
-        self.actionSaveImage.triggered.connect(self.onImageSave)
-        self.actionPrintImage.triggered.connect(self.onImagePrint)
-        self.actionCopyToClipboard.triggered.connect(self.onClipboardCopy)
+        self.actionChangeScale.triggered.connect(self.onToggleScale)
         if self.dimension == 2:
             self.actionToggleGrid.triggered.connect(self.onGridToggle)
-        self.actionChangeScale.triggered.connect(self.onToggleScale)
 
     def onToggleScale(self, event):

src/sas/qtgui/PlotterBase.py

@@ -145 +145 @@
         self.manager.communicator.activeGraphsSignal.emit(PlotHelper.currentPlots())
 
-    def contextMenu(self):
-        """
-        Define common context menu and associated actions for the MPL widget
-        TODO: move to plotter1d/plotter2d
+    def defaultContextMenu(self):
+        """
+        Content of the dialog-universal context menu:
+        Save, Print and Copy
         """
         # Actions
@@ -162 +162 @@
         self.actionCopyToClipboard.triggered.connect(self.onClipboardCopy)
 
+    def contextMenu(self):
+        """
+        Define common context menu and associated actions for the MPL widget
+        TODO: move to plotter1d/plotter2d
+        """
+        raise NotImplementedError("Context menu method must be implemented in derived class.")
+
     def contextMenuQuickPlot(self):
         """

src/sas/qtgui/UnitTesting/PlotterBaseTest.py

@@ -1 +1 @@
 import sys
 import unittest
-from mock import MagicMock
+from mock import patch, MagicMock
 
 from PyQt4 import QtGui
@@ -15 +15 @@
 #import sas.qtgui.GuiUtils as GuiUtils
 from sas.qtgui.GuiUtils import *
+import sas.qtgui.PlotHelper as PlotHelper
 
 # Tested module
@@ -30 +31 @@
             def perspective(self):
                 return MyPerspective()
-
-        #PlotterBase.PlotterBase.updatePlotHelper = MagicMock()
-        #self.plotter = PlotterBase.PlotterBase(None, manager=dummy_manager())
 
         PlotterBase.PlotterBase.contextMenuQuickPlot = MagicMock()
@@ -64 +62 @@
     def testContextMenu(self):
         ''' Test the default context menu '''
-        pass
-
-    def testContextMenuQuickPlot(self):
-        ''' Test the default quick context menu '''
-        pass
+        with self.assertRaises(NotImplementedError):
+            self.plotter.contextMenu()
 
     def testClean(self):
         ''' test the graph cleanup '''
-        pass
+        self.plotter.figure.delaxes = MagicMock()
+        self.plotter.clean()
+        self.assertTrue(self.plotter.figure.delaxes.called)
 
     def testPlot(self):
@@ -79 +76 @@
             self.plotter.plot()
 
-    def testOnCloseEvent(self):
+    def notestOnCloseEvent(self):
         ''' test the plotter close behaviour '''
-        pass
+        PlotHelper.deletePlot = MagicMock()
+        self.plotter.closeEvent(None)
+        self.assertTrue(PlotHelper.deletePlot.called)
 
     def testOnImageSave(self):
         ''' test the workspace save '''
-        pass
+        self.plotter.toolbar.save_figure = MagicMock()
+        self.plotter.onImageSave()
+        self.assertTrue(self.plotter.toolbar.save_figure.called)
 
     def testOnImagePrint(self):
         ''' test the workspace print '''
-        pass
+        QtGui.QPainter.end = MagicMock()
+        QtGui.QLabel.render = MagicMock()
 
-    def tesOonClipboardCopy(self):
-        ''' test the workspace copy '''
-        pass
+        # First, let's cancel printing
+        QtGui.QPrintDialog.exec_ = MagicMock(return_value=QtGui.QDialog.Rejected)
+        self.plotter.onImagePrint()
+        self.assertFalse(QtGui.QPainter.end.called)
+        self.assertFalse(QtGui.QLabel.render.called)
+
+        # Let's print now
+        QtGui.QPrintDialog.exec_ = MagicMock(return_value=QtGui.QDialog.Accepted)
+        self.plotter.onImagePrint()
+        self.assertTrue(QtGui.QPainter.end.called)
+        self.assertTrue(QtGui.QLabel.render.called)
+
+    def testOnClipboardCopy(self):
+        ''' test the workspace screen copy '''
+        QtGui.QClipboard.setPixmap = MagicMock()
+        self.plotter.onClipboardCopy()
+        self.assertTrue(QtGui.QClipboard.setPixmap.called)
 
     def testOnGridToggle(self):
         ''' test toggling the grid lines '''
-        pass
+        # Check the toggle
+        orig_toggle = self.plotter.grid_on
+        
+        FigureCanvas.draw_idle = MagicMock()
+        self.plotter.onGridToggle()
+
+        self.assertTrue(FigureCanvas.draw_idle.called)
+        self.assertTrue(self.plotter.grid_on != orig_toggle)
+
+    def testDefaultContextMenu(self):
+        """ Test the right click default menu """
+
+        self.plotter.defaultContextMenu()
+
+        actions = self.plotter.contextMenu.actions()
+        self.assertEqual(len(actions), 4)
+
+        # Trigger Save Image and make sure the method is called
+        self.assertEqual(actions[0].text(), "Save Image")
+        self.plotter.toolbar.save_figure = MagicMock()
+        actions[0].trigger()
+        self.assertTrue(self.plotter.toolbar.save_figure.called)
+
+        # Trigger Print Image and make sure the method is called
+        self.assertEqual(actions[1].text(), "Print Image")
+        QtGui.QPrintDialog.exec_ = MagicMock(return_value=QtGui.QDialog.Rejected)
+        actions[1].trigger()
+        self.assertTrue(QtGui.QPrintDialog.exec_.called)
+
+        # Trigger Copy to Clipboard and make sure the method is called
+        self.assertEqual(actions[2].text(), "Copy to Clipboard")
+
+        # Spy on cliboard's dataChanged() signal
+        self.clipboard_called = False
+        def done():
+            self.clipboard_called = True
+        QtCore.QObject.connect(app.clipboard(), QtCore.SIGNAL("dataChanged()"), done)
+        actions[2].trigger()
+        QtGui.qApp.processEvents()
+        # Make sure clipboard got updated.
+        self.assertTrue(self.clipboard_called)