Changeset cce0ad3 in sasview for src/sas

Timestamp:

Mar 29, 2015 5:09:35 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:

60dca65c

Parents:

5ce7f17

Message:

added help button to invariant panel. Removed long text explaining
details button and enhanced the tooltip on the button.

File:

• src/sas/perspectives/invariant/invariant_panel.py (modified) (5 diffs)

src/sas/perspectives/invariant/invariant_panel.py

@@ -1 +1 @@
 """
-This module provide GUI for the neutron scattering length density calculator
+This module provides the GUI for the invariant perspective panel
 
 """
@@ -21 +21 @@
 from sas.perspectives.invariant.invariant_state import InvariantState as IState
 from sas.guiframe.panel_base import PanelBase
+from sas.guiframe.documentation_window import DocumentationWindow
+
 # The minimum q-value to be used when extrapolating
 Q_MINIMUM = 1e-5
@@ -55 +57 @@
 class InvariantPanel(ScrolledPanel, PanelBase):
     """
-    Provides the Invariant GUI.
+    Main class defining the sizers (wx "panels") used to draw the
+    Invariant GUI.
     """
     ## Internal nickname for the window, used by the AUI manager
@@ -1839 +1842 @@
         id = wx.NewId()
         self.button_details = wx.Button(self, id, "Details?")
-        hint_msg = "Details about the results of the computation"
+        hint_msg = "Get more details of computation such as fraction from extrapolation"
         self.button_details.SetToolTipString(hint_msg)
         self.Bind(wx.EVT_BUTTON, self.display_details, id=id)
-        details = "Details on Invariant Total Calculations"
-        details_txt = wx.StaticText(self, -1, details)
-        self.button_sizer.AddMany([(details_txt, 0,
-                                    wx.RIGHT | wx.BOTTOM | wx.TOP, 10),
+        #help button
+        id = wx.NewId()
+        self.button_help = wx.Button(self, id, "HELP")
+        self.button_help.SetToolTipString("Invariant Documentation")
+        self.Bind(wx.EVT_BUTTON, self.on_help, id=id)
+        self.button_sizer.AddMany([((20, 20), 1, wx.EXPAND | wx.ADJUST_MINSIZE, 0),
                                    (self.button_details, 0, wx.ALL, 10),
                                    (self.button_calculate, 0,
-                                    wx.RIGHT | wx.TOP | wx.BOTTOM, 10)])
+                                    wx.RIGHT | wx.TOP | wx.BOTTOM, 10),
+                                   (self.button_help, 0, 
+                                    wx.RIGHT | wx.TOP | wx.BOTTOM, 10),])
     def _do_layout(self):
         """
@@ -1869 +1876 @@
         self.SetSizer(self.main_sizer)
         self.SetAutoLayout(True)
+        
+    def on_help(self, event):
+        """
+        Bring up the Invariant Documentation whenever the HELP button is 
+        clicked.
+
+        Calls DocumentationWindow with the path of the location within the
+        documentation tree (after /doc/ ....".  Note that when using old
+        versions of Wx (before 2.9) and thus not the release version of
+        installers, the help comes up at the top level of the file as
+        webbrowser does not pass anything past the # to the browser when it is
+        running "file:///...."
+
+    :param evt: Triggers on clicking the help button
+    """
+
+        _TreeLocation = "user/perspectives/invariant/invariant_help.html"
+        _doc_viewer = DocumentationWindow(self, -1, \
+             _TreeLocation, "Invariant Help")