Changeset e90988c in sasview for src/sas/qtgui/Perspectives

Timestamp:

Dec 14, 2017 9:51:02 AM (7 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:

7fd20fc, 626c7c5

Parents:

8353d90

Message:

Show help pages in default browser. Fixed some help links and modified unit tests. SASVIEW-800

Location:

src/sas/qtgui/Perspectives

Files:

• Corfunc/CorfuncPerspective.py (modified) (4 diffs)
• Fitting/FittingOptions.py (modified) (4 diffs)
• Fitting/FittingPerspective.py (modified) (1 diff)
• Fitting/FittingWidget.py (modified) (4 diffs)
• Fitting/GPUOptions.py (modified) (2 diffs)
• Invariant/InvariantPerspective.py (modified) (3 diffs)
• Inversion/InversionPerspective.py (modified) (2 diffs)

src/sas/qtgui/Perspectives/Corfunc/CorfuncPerspective.py

@@ -5 +5 @@
 
 # global
+from matplotlib.backends.backend_qt5agg import FigureCanvasQTAgg \
+    as FigureCanvas
+from matplotlib.figure import Figure
+from numpy.linalg.linalg import LinAlgError
+
 from PyQt5 import QtCore
 from PyQt5 import QtGui, QtWidgets
@@ -17 +22 @@
 from .UI.CorfuncPanel import Ui_CorfuncDialog
 from .CorfuncUtils import WIDGETS as W
-
-from matplotlib.backends.backend_qt5agg import FigureCanvasQTAgg \
-    as FigureCanvas
-from matplotlib.figure import Figure
-from numpy.linalg.linalg import LinAlgError
 
 
@@ -136 +136 @@
         self.cmdCalculateBg.clicked.connect(self.calculate_background)
         self.cmdCalculateBg.setEnabled(False)
+        self.cmdHelp.clicked.connect(self.showHelp)
 
         self.model.itemChanged.connect(self.model_changed)
@@ -306 +307 @@
 
     # pylint: disable=invalid-name
+    def showHelp(self):
+        """
+        Opens a webpage with help on the perspective
+        """
+        """ Display help when clicking on Help button """
+        treeLocation = "/user/sasgui/perspectives/corfunc/corfunc_help.html"
+        self.parent.showHelp(treeLocation)
+
     @staticmethod
     def allowBatch():

src/sas/qtgui/Perspectives/Fitting/FittingOptions.py

@@ -3 +3 @@
 import os
 import types
+import webbrowser
 
 from PyQt5 import QtCore
 from PyQt5 import QtGui
 from PyQt5 import QtWidgets
-from PyQt5 import QtWebKitWidgets
 
 from sas.qtgui.UI import images_rc
@@ -73 +73 @@
         # OK has to be initialized to True, after initial validator setup
         self.buttonBox.button(QtWidgets.QDialogButtonBox.Ok).setEnabled(True)
-
-        # Display HTML content
-        self.helpView = QtWebKitWidgets.QWebView()
 
     def assignValidators(self):
@@ -160 +157 @@
         Show the "Fitting options" section of help
         """
-        tree_location = GuiUtils.HELP_DIRECTORY_LOCATION + "/user/sasgui/perspectives/fitting/"
+        tree_location = GuiUtils.HELP_DIRECTORY_LOCATION
+        tree_location += "/user/sasgui/perspectives/fitting/"
 
         # Actual file anchor will depend on the combo box index
@@ -167 +165 @@
         helpfile = "optimizer.html#fit-" + self.current_fitter_id 
         help_location = tree_location + helpfile
-        self.helpView.load(QtCore.QUrl(help_location))
-        self.helpView.show()
+        webbrowser.open('file://' + os.path.realpath(help_location))
 
     def widgetFromOption(self, option_id, current_fitter=None):

src/sas/qtgui/Perspectives/Fitting/FittingPerspective.py

@@ -13 +13 @@
 from sas.qtgui.Perspectives.Fitting.FittingOptions import FittingOptions
 from sas.qtgui.Perspectives.Fitting.GPUOptions import GPUOptions
-#from sas.qtgui.Perspectives.Fitting import ModelUtilities
 
 class FittingWindow(QtWidgets.QTabWidget):

src/sas/qtgui/Perspectives/Fitting/FittingWidget.py

@@ -8 +8 @@
 from twisted.internet import threads
 import numpy as np
+import webbrowser
 
 from PyQt5 import QtCore
 from PyQt5 import QtGui
 from PyQt5 import QtWidgets
-from PyQt5 import QtWebKitWidgets
-# Officially QtWebEngineWidgets are the way to display HTML in Qt5,
-# but this module isn't ported to PyQt5 yet...
-# let's wait. In the meantime no Help.
-#from PyQt5 import QtWebEngineWidgets
 
 from sasmodels import product
@@ -127 +123 @@
 
         # Display HTML content
-        self.helpView = QtWebKitWidgets.QWebView()
+        #self.setupHelp()
 
         # New font to display angstrom symbol
@@ -662 +658 @@
         Show the "Fitting" section of help
         """
-        tree_location = GuiUtils.HELP_DIRECTORY_LOCATION + "/user/sasgui/perspectives/fitting/"
+        tree_location = "/user/sasgui/perspectives/fitting/"
 
         # Actual file will depend on the current tab
@@ -672 +668 @@
             helpfile = "residuals_help.html"
         elif tab_id == 2:
-            helpfile = "sm_help.html"
+            helpfile = "resolution.html"
         elif tab_id == 3:
-            helpfile = "pd_help.html"
+            helpfile = "pd/polydispersity.html"
         elif tab_id == 4:
-            helpfile = "mag_help.html"
+            helpfile = "magnetism/magnetism.html"
         help_location = tree_location + helpfile
 
-        content = QtCore.QUrl(help_location)
-        self.helpView.load(QtCore.QUrl(help_location))
-        self.helpView.show()
+        self.showHelp(help_location)
+
+    def showHelp(self, url):
+        """
+        Calls parent's method for opening an HTML page
+        """
+        self.parent.showHelp(url)
 
     def onDisplayMagneticAngles(self):

src/sas/qtgui/Perspectives/Fitting/GPUOptions.py

@@ -8 +8 @@
 
 import sas.qtgui.Utilities.GuiUtils as GuiUtils
-from PyQt5 import QtGui, QtCore, QtWebKit, QtWidgets
+from PyQt5 import QtGui, QtCore, QtWidgets
 from sas.qtgui.Perspectives.Fitting.UI.GPUOptionsUI import Ui_GPUOptions
 from sas.qtgui.Perspectives.Fitting.UI.GPUTestResultsUI import Ui_GPUTestResults
@@ -172 +172 @@
         help_location += "/user/sasgui/perspectives/fitting/gpu_setup.html"
         help_location += "#device-selection"
-        # Test the system browser solution
+        # Display the page in default browser
         webbrowser.open('file://' + os.path.realpath(help_location))
 

src/sas/qtgui/Perspectives/Invariant/InvariantPerspective.py

@@ -8 +8 @@
 from PyQt5 import QtCore
 from PyQt5 import QtGui, QtWidgets
-from PyQt5 import QtWebKit
 
 from twisted.internet import threads
@@ -63 +62 @@
         self._model_item = QtGui.QStandardItem()
 
-        #self._helpView = QtWebKit.QWebView()
         self.detailsDialog = DetailsDialog(self)
         self.detailsDialog.cmdOK.clicked.connect(self.enabling)
@@ -431 +429 @@
     def onHelp(self):
         """ Display help when clicking on Help button """
-        treeLocation = GuiUtils.HELP_DIRECTORY_LOCATION + \
-            "/user/sasgui/perspectives/invariant/invariant_help.html"
-        webbrowser.open('file://' + treeLocation)
+        treeLocation = "/user/sasgui/perspectives/invariant/invariant_help.html"
+        self.parent.showHelp(treeLocation)
 
     def setupSlots(self):

src/sas/qtgui/Perspectives/Inversion/InversionPerspective.py

@@ -51 +51 @@
         self._manager = parent
         self._model_item = QtGui.QStandardItem()
-        #self._helpView = QtWebKit.QWebView()
-
         self.communicate = GuiUtils.Communicate()
 
@@ -374 +372 @@
         Open the P(r) Inversion help browser
         """
-        tree_location = (GuiUtils.HELP_DIRECTORY_LOCATION +
-                         "user/sasgui/perspectives/pr/pr_help.html")
+        tree_location = "/user/sasgui/perspectives/pr/pr_help.html"
 
         # Actual file anchor will depend on the combo box index
         # Note that we can be clusmy here, since bad current_fitter_id
         # will just make the page displayed from the top
-        #self._helpView.load(QtCore.QUrl(tree_location))
-        #self._helpView.show()
+        self._manager.showHelp(tree_location)
 
     def toggleBgd(self):