Changeset 4604

Timestamp:

Oct 17, 2020 5:49:37 PM (12 months ago)

Author:

toby

Message:

add help to Orientation reference controls; improve helpbutton formatting

Location:

trunk

Files:

• GSASIIconstrGUI.py (modified) (2 diffs)
• GSASIIctrlGUI.py (modified) (4 diffs)

trunk/GSASIIconstrGUI.py

@@ -3018 +3018 @@
                     Indx[refSel.GetId()] = i
                     refAtmSizer.Add(refSel,0,WACV)
+                    refHelpInfo = '''
+The Orientation reference control is used to tranform 
+the Cartesian
+axes for rigid bodies with three atoms, A, B and C. 
+The vector from A to B defines the x-axis and the z axis is placed 
+in the plane defined by A to B and A to C.
+'''
+                hlp = G2G.HelpButton(VectorRBDisplay,refHelpInfo,wrap=400)
+                refAtmSizer.Add(hlp,0,wx.LEFT|wx.RIGHT|wx.ALIGN_CENTER_VERTICAL,2)
             return refAtmSizer
                         
@@ -3372 +3381 @@
                 RefObjs.append(refObj)
                 if 'molCent' not in rbData: rbData['molCent'] = False           #patch
-                molcent = wx.Button(ResidueRBDisplay,label=' Use RB center?')
+                molcent = wx.Button(ResidueRBDisplay,label=' Center RB?')
                 molcent.Bind(wx.EVT_BUTTON,OnMolCent)
                 Indx[molcent.GetId()] = resGrid
                 refAtmSizer.Add(molcent,0,WACV)
+                refHelpInfo = '''
+* The "Orientation Reference" control is used to tranform 
+the Cartesian
+axes for rigid bodies with three atoms, A, B and C. 
+The vector from A to B defines the x-axis and the z axis is placed 
+in the plane defined by A to B and A to C.
+
+%%* The "Center RB?" button will redefine the origin of the 
+rigid body to the midpoint of all atoms in the body (not mass weighted)
+'''
+                hlp = G2G.HelpButton(ResidueRBDisplay,refHelpInfo,wrap=400)
+                refAtmSizer.Add(hlp,0,wx.LEFT|wx.RIGHT|wx.ALIGN_CENTER_VERTICAL,2)
             
             mainSizer = wx.BoxSizer(wx.VERTICAL)

trunk/GSASIIctrlGUI.py

@@ -5166 +5166 @@
 
     :param parent: the panel/frame where the button will be placed
-    :param str msg: the help text to be displayed
+    :param str msg: the help text to be displayed. Indentation on 
+       multiline help text is stripped (see :func:`StripIndents`). If wrap
+       is set as non-zero, all new lines are 
     :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
+    :param int wrap: if specified, the text displayed is reformatted by
+      wrapping it to fit in wrap pixels. Default is None which prevents 
+      wrapping.
     '''
-    def __init__(self,parent,msg='',helpIndex=''):
+    def __init__(self,parent,msg='',helpIndex='',wrap=None):
         if sys.platform == "darwin": 
             wx.Button.__init__(self,parent,wx.ID_HELP)
@@ -5177 +5182 @@
             wx.Button.__init__(self,parent,wx.ID_ANY,'?',style=wx.BU_EXACTFIT)
         self.Bind(wx.EVT_BUTTON,self._onPress)
-        self.msg=StripIndents(msg)
+        if wrap:
+            self.msg=StripIndents(msg,True)
+        else:
+            self.msg=StripIndents(msg)
         self.parent = parent
         self.helpIndex = helpIndex
+        self.wrap = wrap
     def _onClose(self,event):
         self.dlg.EndModal(wx.ID_CANCEL)
@@ -5193 +5202 @@
         mainSizer = wx.BoxSizer(wx.VERTICAL)
         txt = wx.StaticText(self.dlg,wx.ID_ANY,self.msg)
+        if self.wrap:
+            txt.Wrap(self.wrap)
         mainSizer.Add(txt,1,wx.ALL|wx.EXPAND,10)
         txt.SetBackgroundColour(wx.WHITE)
@@ -5268 +5279 @@
 ################################################################################
 def StripIndents(msg,singleLine=False):
-    'Strip indentation from multiline strings'
+    '''Strip unintended indentation from multiline strings. 
+    When singleLine is True, all newline are removed, but inserting "%%"
+    into the string will cause a blank line to be inserted at that point
+
+    :param str msg: a string containing one or more lines of text. 
+      spaces or tabs following a newline are removed.
+    :returns: the string but reformatted
+    '''
     msg1 = msg.replace('\n ','\n')
     while msg != msg1:
         msg = msg1
         msg1 = msg.replace('\n ','\n')
-    msg = msg.replace('\n\t','\n')
+        msg1 = msg1.replace('  ',' ')
+    msg1 = msg.replace('\n\t','\n')
+    while msg != msg1:
+        msg = msg1
+        msg1 = msg.replace('\n\t','\n')
     if singleLine:
-        return msg.replace('\n',' ')
+        msg = msg.replace('\n',' ')
+        msg1 = msg.replace('  ',' ')
+        while msg != msg1:
+            msg = msg1
+            msg1 = msg1.replace('  ',' ')
+        msg = msg.replace('%%','\n\n')
     return msg