Changeset fc8f132 in sasview

Timestamp:

Mar 1, 2015 12:38:10 AM (9 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:

de69095

Parents:

c558b47

Message:

Add Help button to SLD panel and change default placement.

File:

• src/sas/perspectives/calculator/sld_panel.py (modified) (4 diffs)

src/sas/perspectives/calculator/sld_panel.py

@@ -21 +21 @@
 from periodictable.nsf import neutron_scattering
 from sas.perspectives.calculator import calculator_widgets as widget   
+from sas.guiframe.documentation_window import DocumentationWindow
        
 WAVELENGTH = 6.0
@@ -284 +285 @@
         self.Bind(wx.EVT_BUTTON, self.calculateSld, id=id)   
         
-        sizer_button.Add((250, 20), 1, wx.EXPAND|wx.ADJUST_MINSIZE, 0)
+        self.button_help = wx.Button(self, id, "HELP")
+        self.button_help.SetToolTipString("help on SLD calculator.")
+        self.Bind(wx.EVT_BUTTON, self.on_help, id=id)   
+        
+        sizer_button.Add((150, 20), 1, wx.EXPAND|wx.ADJUST_MINSIZE, 0)
         sizer_button.Add(self.button_calculate, 0, wx.RIGHT|wx.ADJUST_MINSIZE, 20)
+        sizer_button.Add(self.button_help, 0, wx.RIGHT|wx.ADJUST_MINSIZE, 20)
         sizer3.Add(sizer_button)
         #---------layout----------------
@@ -295 +301 @@
         self.SetSizer(vbox)
         
+    def on_help(self, event):    
+        """
+        Bring up the SLD 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/calculator/sld_calculator_help.html"
+        _doc_viewer = DocumentationWindow(self, -1, \
+             _TreeLocation,"General Scattering Calculator Help")
+
     def calculate_xray_sld(self, element):
         """
@@ -456 +481 @@
         self.panel = SldPanel(self, base=base)
         self.Bind(wx.EVT_CLOSE, self.on_close)
-        self.SetPosition((25, 150))
+        self.SetPosition((20, 10))
         self.Show(True)