Changeset c1694f8 in sasview for src/sas/perspectives

Timestamp:

Feb 18, 2015 3:45:37 PM (10 years ago)

Author:

butler

Branches:

master, 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, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

7d32aaf

Parents:

ac85c4b

Message:

Moved the rest of basepage help to the new method. Basically
MODELS
1) Added a button to separate description help from function details
help
2) Make function details help go to new documentation
3) Converted polydispersity help (hitting question mark) and mag angle
description help (question mark again) to use new documentation.

File:

• src/sas/perspectives/fitting/basepage.py (modified) (7 diffs)

src/sas/perspectives/fitting/basepage.py

@@ -26 +26 @@
 from sas.perspectives.fitting.pagestate import PageState
 from sas.guiframe.CategoryInstaller import CategoryInstaller
+from sas.guiframe.documentation_window import DocumentationWindow
+
 
 (PageInfoEvent, EVT_PAGE_INFO) = wx.lib.newevent.NewEvent()
@@ -2916 +2918 @@
         return graphs, canvases
 
-    def on_model_help_clicked(self, event):
-        """
-        Function called when 'Details' button is pressed next to model
-        of interest.  As of Feb 2015 this function follows two paths:
-        For regular models that ship with the release, it calls the Sphinx
-        generated html documentation.  For plugin models it still uses the
-        old pop up window reading the description provided in the model.
-        
-        This will presumably be deprecated when the sas mdels team decides
-        on how to discover new models and grab their documentation from the
-        file.
-        
-        PDB 18 Feb 2015
-        
-        :param evt: on Details Button pressed event
-        """
-        from sas.perspectives.fitting.help_panel import  HelpWindow
-        from sas.models import get_data_path
-        
-        # Get models help model_function path
-        path = get_data_path(media='media')
-        model_path = os.path.join(path, "model_functions.html")
+    def on_function_help_clicked(self, event):
+        """
+        Function called when 'Help' button is pressed next to model
+        of interest.  This calls DocumentationWindow from 
+        documentation_window.py. It will load the top level of the model
+        help documenation sphinx generated html if no model is presented.
+        If a model IS present then if documention for that model exists
+        it will load to that  point otherwise again it will go to the top.
+        For Wx2.8 and below is used (i.e. non-released through installer)
+        a browser is loaded and the top of the model documentation only is
+        accessible because webbrowser module does not pass anything after
+        the # to the browser.
+        
+        :param evt: on Help Button pressed event
+        """
+
         if self.model == None:
             name = 'index.html'
         else:
             name = self.formfactorbox.GetValue()
-        frame = HelpWindow(None, -1, pageToOpen=model_path)
-        #If model name exists and model is not a custom model
-        #mod_cat = self.categorybox.GetStringSelection()
-        if frame.rhelp.HasAnchor(name):
-            frame.Show(True)
-            frame.rhelp.ScrollToAnchor(name)
+
+        if self.model != None:  
+            _docspath='user/models/model_functions.html#' + name
+            _doc_viewer = DocumentationWindow(self, -1, _docspath, name + "Help")
         else:
-            if self.model != None:
-                frame.Destroy()
-                msg = 'Model description:\n'
-                if str(self.model.description).rstrip().lstrip() == '':
-                    msg += "Sorry, no information is available for this model."
-                else:
-                    msg += self.model.description + '\n'
-                info = "Info"
-                wx.MessageBox(msg, info)
+            _doc_viewer = DocumentationWindow(self, -1, "index.html", \
+                                                "General Help")
+
+
+    def on_model_help_clicked(self, event):
+        """
+        Function called when 'Description' button is pressed next to model
+        of interest.  This calls the Description embedded in the model. This
+        should work with either Wx2.8 and lower or higher. If no model is
+        selected it will give the message that a model must be chosen first
+        in the box that would normally contain the description.  If a badly
+        behaved model is encountered which has no description then it will
+        give the message that none is available.
+        
+        :param evt: on Description Button pressed event
+        """
+
+        if self.model == None:
+            name = 'index.html'
+        else:
+            name = self.formfactorbox.GetValue()
+
+        msg = 'Model description:\n'
+        info = "Info"
+        if self.model != None:
+#                frame.Destroy()
+            if str(self.model.description).rstrip().lstrip() == '':
+                msg += "Sorry, no information is available for this model."
             else:
-                frame.Show(True)
+                msg += self.model.description + '\n'
+            wx.MessageBox(msg, info)
+        else:
+            msg += "You must select a model to get information on this"
+            wx.MessageBox(msg, info)
 
     def _on_mag_help(self, event):    
@@ -2966 +2983 @@
         is clicked. Calls DocumentationWindow with the path of the location 
         within the documentation tree (after /doc/ ....". When using old 
-        versions of Wx When (i.e. before 2.9 and therefore not part of release
+        versions of Wx (i.e. before 2.9 and therefore not part of release
         versions distributed via installer) it brings up an image viewer
         box which allows the user to click through the rest of the images in 
@@ -2976 +2993 @@
         :param evt: Triggers on clicking ? in Magnetic Angles? box
         """
-        
-        from sas.guiframe.documentation_window import DocumentationWindow
         
         _TreeLocation = "_images/M_angles_pic.bmp"
@@ -3024 +3039 @@
         :param evt: Triggers on clicking ? in polydispersity box
         """
-        
-        from sas.guiframe.documentation_window import DocumentationWindow
-        
+                
         _TreeLocation = "user/perspectives/fitting/fitting_help.html"
         _TreeLocation += "#polydispersity-distributions"
@@ -3592 +3605 @@
         self.mbox_description.SetForegroundColour(wx.RED)
         id = wx.NewId()
-        self.model_help = wx.Button(self, id, 'Details', size=(80, 23))
+        self.model_func = wx.Button(self, id, 'Help', size=(80, 23))
+        self.model_func.Bind(wx.EVT_BUTTON, self.on_function_help_clicked, id=id)
+        self.model_func.SetToolTipString("Full Model Function Help")
+        id = wx.NewId()
+        self.model_help = wx.Button(self, id, 'Description', size=(80, 23))
         self.model_help.Bind(wx.EVT_BUTTON, self.on_model_help_clicked, id=id)
-        self.model_help.SetToolTipString("Model Function Help")
+        self.model_help.SetToolTipString("Short Model Function Description")
         id = wx.NewId()
         self.model_view = wx.Button(self, id, "Show 2D", size=(80, 23))
@@ -3636 +3653 @@
       
         sizer_radiobutton = wx.GridSizer(2, 2, 5, 5)
+        
 
         #sizer_radiobutton.Add(self.shape_rbutton)
         #sizer_radiobutton.Add(self.shape_indep_rbutton)
         sizer_radiobutton.Add((5,5))
-        sizer_radiobutton.Add(self.model_view, 1, wx.RIGHT, 15)
+        sizer_radiobutton.Add(self.model_view, 1, wx.RIGHT, 5)
         #sizer_radiobutton.Add(self.plugin_rbutton)
         #sizer_radiobutton.Add(self.struct_rbutton)
-        sizer_radiobutton.Add((5,5))
-        sizer_radiobutton.Add(self.model_help, 1, wx.RIGHT, 15)
+#        sizer_radiobutton.Add((5,5))
+        sizer_radiobutton.Add(self.model_help, 1, wx.RIGHT|wx.LEFT, 5)
+#        sizer_radiobutton.Add((5,5))
+        sizer_radiobutton.Add(self.model_func, 1, wx.RIGHT, 5)
         sizer_cat.Add(sizer_cat_box, 1, wx.LEFT, 2.5)
         sizer_cat.Add(sizer_radiobutton)