Changeset 3977 for trunk/GSASIIctrlGUI.py

Timestamp:

May 13, 2019 3:23:40 PM (3 years ago)

Author:

toby

Message:

Update help info for Sample Parms & add help button

File:

• trunk/GSASIIctrlGUI.py (modified) (4 diffs)

trunk/GSASIIctrlGUI.py

@@ -39 +39 @@
                                    a filter to help search through choices.
 :class:`HelpButton`                Creates a button labeled with a "?" that when pressed
-                                   displays help text in a modal message window.
+                                   displays help text in a modal message window
+                                   or web browser. 
 :class:`MultiColumnSelection`      A dialog that builds a multicolumn table, word wrapping
                                    is used for the 2nd, 3rd,... columns. 
@@ -4459 +4460 @@
 class HelpButton(wx.Button):
     '''Create a help button that displays help information.
-    The text is displayed in a modal message window.
+    The text can be displayed in a modal message window or it can be 
+    a reference to a location in the gsasII.html help web page, in which 
+    case that page is opened in a web browser. 
 
     TODO: it might be nice if it were non-modal: e.g. it stays around until
@@ -4465 +4468 @@
     me. 
 
-    :param parent: the panel which will be the parent of the button
+    :param parent: the panel/frame where the button will be placed
     :param str msg: the help text to be displayed
+    :param str helpIndex: location of the help information in the gsasII.html
+      help file in the form of an anchor string. The URL will be 
+      constructed from: location + gsasII.html + "#" + helpIndex
     '''
-    def __init__(self,parent,msg):
+    def __init__(self,parent,msg='',helpIndex=''):
         if sys.platform == "darwin": 
             wx.Button.__init__(self,parent,wx.ID_HELP)
@@ -4476 +4482 @@
         self.msg=StripIndents(msg)
         self.parent = parent
+        self.helpIndex = helpIndex
     def _onClose(self,event):
         self.dlg.EndModal(wx.ID_CANCEL)
     def _onPress(self,event):
         'Respond to a button press by displaying the requested text'
+        if self.helpIndex:
+            ShowHelp(self.helpIndex,self.parent)
+            return
         #dlg = wx.MessageDialog(self.parent,self.msg,'Help info',wx.OK)
         self.dlg = wx.Dialog(self.parent,wx.ID_ANY,'Help information',