work on ValidatedTxtCtrl & GSASIIimgGUI for Linux (see #114); start process of replacing TextCtrl.SetValue to .ChangeValue in callbacks

Author: briantoby

GSASII/GSASIIctrlGUI.py

@@ -271,9 +271,12 @@ class ValidatedTxtCtrl(wx.TextCtrl):
     came from. The type of the initial value must be int,
     float or str or None (see :obj:`key` and :obj:`typeHint`);
     this type (or the one in :obj:`typeHint`) is preserved.
+    Values are processed and saved when Enter is pressed, when the 
+    mouse is moved to another control (leave window or focus is lost) 
+    or after a change and a delay of two seconds.
 
     Float values can be entered in the TextCtrl as numbers or also
-    as algebraic expressions using operators + - / \\* () and \\*\\*,
+    as algebraic expressions using operators (+ - / \\* () and \\*\\*),
     in addition pi, sind(), cosd(), tand(), and sqrt() can be used,
     as well as appreviations s, sin, c, cos, t, tan and sq. 
 
@@ -364,7 +367,6 @@ class ValidatedTxtCtrl(wx.TextCtrl):
     def __init__(self,parent,loc,key,nDig=None,notBlank=True,xmin=None,xmax=None,
         OKcontrol=None,OnLeave=None,typeHint=None,CIFinput=False,exclLim=[False,False],
         OnLeaveArgs={}, ASCIIonly=False,
-                     min=None, max=None, # patch: remove this eventually
                      **kw):
         # save passed values needed outside __init__
         self.result = loc
@@ -376,25 +378,12 @@ def __init__(self,parent,loc,key,nDig=None,notBlank=True,xmin=None,xmax=None,
         self.CIFinput = CIFinput
         self.notBlank = notBlank
         self.ASCIIonly = ASCIIonly
-        
-        # patch: remove this when min & max are no longer used to call this
-        if min is not None:
-            xmin=min
-            if GSASIIpath.GetConfigValue('debug'):
-                print('Call to ValidatedTxtCtrl using min (change to xmin) here:')
-                G2obj.HowDidIgetHere(True)
-        if max is not None:
-            xmax=max
-            if GSASIIpath.GetConfigValue('debug'):
-                print('Call to ValidatedTxtCtrl using max (change to xmax) here:')
-                G2obj.HowDidIgetHere(True)
-        # end patch
-        
+
         # initialization
         self.invalid = False   # indicates if the control has invalid contents
         self.evaluated = False # set to True when the validator recognizes an expression
         self.timer = None      # tracks pending updates for expressions in float textctrls
-        self.delay = 5000      # delay for timer update (5 sec)
+        self.delay = 2000      # delay for timer update (2 sec)
         self.type = str
 
         val = loc[key]
@@ -447,7 +436,7 @@ def __init__(self,parent,loc,key,nDig=None,notBlank=True,xmin=None,xmax=None,
             else:
                 wx.TextCtrl.__init__(self,parent,wx.ID_ANY,**kw)
             if val is not None:
-                self.SetValue(val)
+                self.ChangeValue(val)
             if notBlank:
                 self.Bind(wx.EVT_CHAR,self._onStringKey)
                 self.ShowStringValidity() # test if valid input
@@ -460,15 +449,42 @@ def __init__(self,parent,loc,key,nDig=None,notBlank=True,xmin=None,xmax=None,
         self.Bind(wx.EVT_LEAVE_WINDOW, self._onLeaveWindow)
         self.Bind(wx.EVT_KILL_FOCUS, self._onLoseFocus)
         self.Bind(wx.EVT_TEXT_ENTER, self._onLoseFocus)
-        # patch for wx 2.9 on Mac
-        i,j= wx.__version__.split('.')[0:2]
-        if int(i)+int(j)/10. > 2.8 and 'wxOSX' in wx.PlatformInfo:
-            self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
 
-    def SetValue(self,val):
-        if self.result is not None: # note that this bypasses formatting
+    def SetValue(self,val,warn=True):
+        '''Place a value into the text widget and save it into the 
+        associated array element. Note that, unlike the stock wx.TextCtrl,
+        val is expected to be in the form expected by the widget 
+        (float/int/str) rather than only str's. 
+        For float val values, the value is formatted when placed in the
+        TextCtrl, but the supplied value is what is actually saved.
+
+        This routine triggers a wx.EVT_TEXT event
+        '''
+        # GSAS-II callback routines should call ChangeValue not SetValue
+        # for debugging flag calls. Set warn to False for calls that are not in callbacks
+        # and thus are OK
+        #if GSASIIpath.GetConfigValue('debug') and warn:
+        #    G2obj.HowDidIgetHere(True)
+        if self.result is not None:
             self.result[self.key] = val
         self._setValue(val)
+        # Direct calls to SetValue should trigger an event
+        wx.TextCtrl.SetValue(self,wx.TextCtrl.GetValue(self))
+
+    def ChangeValue(self,val):
+        '''Place a value into the text widget and save it into the 
+        associated array element. Note that, unlike the stock wx.TextCtrl,
+        val is expected to be in the form expected by the widget 
+        (float/int/str) rather than only str's. 
+        For float val values, the value is formatted when placed in the
+        TextCtrl, but the supplied value is what is actually saved.
+
+        This routine does not trigger a wx.EVT_TEXT event. This is what
+        should be used inside event callbacks, not :meth:`SetValue`.
+        '''
+        if self.result is not None:
+            self.result[self.key] = val
+        self._setValue(val)        
 
     def _setValue(self,val,show=True):
         '''Check the validity of an int or float value and convert to a str.
@@ -487,7 +503,7 @@ def _setValue(self,val,show=True):
                     pass
                 else:
                     self.invalid = True
-            if show and not self.invalid: wx.TextCtrl.SetValue(self,str(val))
+            if show and not self.invalid: wx.TextCtrl.ChangeValue(self,str(val))
         elif self.type is float:
             try:
                 if type(val) is str: val = val.replace(',','.')
@@ -498,10 +514,10 @@ def _setValue(self,val,show=True):
                 else:
                     self.invalid = True
             if self.nDig and show and not self.invalid:
-                wx.TextCtrl.SetValue(self,str(G2fil.FormatValue(val,self.nDig)))
+                wx.TextCtrl.ChangeValue(self,str(G2fil.FormatValue(val,self.nDig)))
                 self.evaluated = False # expression has been recast as value, reset flag
             elif show and not self.invalid:
-                wx.TextCtrl.SetValue(self,str(G2fil.FormatSigFigs(val)).rstrip('0'))
+                wx.TextCtrl.ChangeValue(self,str(G2fil.FormatSigFigs(val)).rstrip('0'))
                 self.evaluated = False # expression has been recast as value, reset flag
         else:
             if self.ASCIIonly:
@@ -516,9 +532,9 @@ def _setValue(self,val,show=True):
                     show = True
             if show:
                 try:
-                    wx.TextCtrl.SetValue(self,str(val))
+                    wx.TextCtrl.ChangeValue(self,str(val))
                 except:
-                    wx.TextCtrl.SetValue(self,val)
+                    wx.TextCtrl.ChangeValue(self,val)
             self.ShowStringValidity() # test if valid input
             return
 
@@ -550,15 +566,17 @@ def _IndicateValidity(self):
             ins = self.GetInsertionPoint()
             self.SetForegroundColour("red")
             self.SetBackgroundColour("yellow")
-            self.SetFocus()
+            if not sys.platform.startswith("linux"):
+                self.SetFocus()
             self.Refresh() # this selects text on some Linuxes
             self.SetSelection(0,0)   # unselect
             self.SetInsertionPoint(ins) # put insertion point back 
         else: # valid input
             self.SetBackgroundColour(wx.SystemSettings.GetColour(wx.SYS_COLOUR_WINDOW))
             self.SetForegroundColour(wx.SystemSettings.GetColour(wx.SYS_COLOUR_BTNTEXT))
             self.Refresh()
-            self.SetFocus() # seems needed, at least on MacOS to get color change
+            if not sys.platform.startswith("linux"):
+                self.SetFocus() # seems needed, at least on MacOS to get color change
 
     def _GetNumValue(self):
         'Get and where needed convert string from GetValue into int or float'
@@ -605,7 +623,10 @@ def _GetStringValue(self,event):
         wx.CallAfter(self._SaveStringValue)
 
     def _SaveStringValue(self):
-        val = self.GetValue().strip()
+        try:
+            val = self.GetValue().strip()
+        except RuntimeError:  # ignore if control has been deleted
+            return
         # always store the result
         if self.CIFinput and '2' in platform.python_version_tuple()[0]: # Py2/CIF make results ASCII
             self.result[self.key] = val.encode('ascii','replace') 
@@ -5787,8 +5808,20 @@ class HelpButton(wx.Button):
     def __init__(self,parent,msg='',helpIndex='',wrap=None):
         if sys.platform == "darwin": 
             wx.Button.__init__(self,parent,wx.ID_HELP)
-        else:
+        elif sys.platform.startswith("linux"):
             wx.Button.__init__(self,parent,wx.ID_ANY,'?',style=wx.BU_EXACTFIT)
+            self.SetBackgroundColour('yellow')
+            self.SetForegroundColour('black')
+            f = wx.Font(self.GetFont()).Bold()
+            f.SetPointSize(f.PointSize+1)
+            self.SetFont(f)
+        else:  # button needs to be exaggerated in Windows
+            wx.Button.__init__(self,parent,wx.ID_ANY,' ? ',style=wx.BU_EXACTFIT)
+            self.SetBackgroundColour('yellow')
+            self.SetForegroundColour('black')
+            f = wx.Font(self.GetFont()).Bold()
+            f.SetPointSize(f.PointSize+4)
+            self.SetFont(f)
         self.Bind(wx.EVT_BUTTON,self._onPress)
         if wrap:
             self.msg=StripIndents(msg,True)

GSASII/GSASIIimgGUI.py

@@ -933,11 +933,11 @@ def OnNewVal(invalid,value,tc):
             r11 = min(max(Range[1][1],Range[1][0]+1),Range[0][1]) # keep values in range
             if r11 != Range[1][1]:
                 Range[1][1] = r11
-                maxVal.SetValue(int(Range[1][1]))
+                maxVal.ChangeValue(int(Range[1][1]))
             r10 = max(min(Range[1][0],Range[1][1]-1),Range[0][0])
             if r10 != Range[1][0]:
                 Range[1][0] = r10
-                minVal.SetValue(int(Range[1][0]))
+                minVal.ChangeValue(int(Range[1][0]))
             sqrtDeltZero = math.sqrt(max(1.0,Range[0][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax0-Imin-1)
             sqrtDeltOne  = math.sqrt(max(1.0,Range[1][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax-Imin-1)
             sv1 = min(100,max(0,int(0.5+100.*sqrtDeltOne/sqrtDeltZero)))
@@ -960,7 +960,7 @@ def OnMaxSlider(event):
             G2frame.prevMaxValue = val
             sqrtDeltZero = math.sqrt(max(1.0,Range[0][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax0-Imin-1)
             Range[1][1] = int(0.5 + (val * sqrtDeltZero / 100.)**2 + Range[1][0] + 1)
-            maxVal.SetValue(int(0.5+Range[1][1]))
+            maxVal.ChangeValue(int(0.5+Range[1][1]))
             DeltOne  = max(1.0,Range[1][1]-max(0.0,Range[0][0])-1)
             minSel.SetValue(int(0.5 + 100*(Range[1][0]/DeltOne)))
             sv0 = min(100,max(0,int(0.5+100.*(Range[1][0]-Range[0][0])/DeltOne)))
@@ -980,7 +980,7 @@ def OnMinSlider(event):
             G2frame.prevMinValue = val
             DeltOne  = max(1.0,Range[1][1]-max(0.0,Range[0][0])-1) # Imax-Imin0-1
             Range[1][0] = max(0,int(0.5 + val * DeltOne / 100 + Range[0][0]))
-            minVal.SetValue(int(Range[1][0]))
+            minVal.ChangeValue(int(Range[1][0]))
             sqrtDeltZero = math.sqrt(max(1.0,Range[0][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax0-Imin-1)
             sqrtDeltOne  = math.sqrt(max(1.0,Range[1][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax-Imin-1)
             sv1 = min(100,max(0,int(0.5+100.*sqrtDeltOne/sqrtDeltZero)))
@@ -1016,8 +1016,8 @@ def OnAutoSet(event):
             DeltOne  = max(1.0,Range[1][1]-max(0.0,Range[0][0])-1)
             sv0 = min(100,max(0,int(0.5+100.*(Range[1][0]-Range[0][0])/DeltOne)))
             minSel.SetValue(sv0)
-            minVal.SetValue(int(Range[1][0]))
-            maxVal.SetValue(int(Range[1][1]))
+            minVal.ChangeValue(int(Range[1][0]))
+            maxVal.ChangeValue(int(Range[1][1]))
             new,plotNum,Page,Plot,lim = G2frame.G2plotNB.FindPlotTab('2D Powder Image','mpl',newImage=False)
             Page.ImgObj.set_clim([Range[1][0],Range[1][1]])
             if mplOld:
@@ -1148,36 +1148,41 @@ def OnNewBinType(event):
             wx.CallLater(100,UpdateImageControls,G2frame,data,masks)
 
         def OnIOtth(invalid,value,tc):
-            Ltth = float(G2frame.InnerTth.GetValue())
-            Utth = float(G2frame.OuterTth.GetValue())
+            '''Respond to a change in integration 2theta range
+            '''
+            Ltth,Utth = IOtth
             if Ltth > Utth:
                 Ltth,Utth = Utth,Ltth
+                G2frame.InnerTth.ChangeValue(Ltth)
+                G2frame.OuterTth.ChangeValue(Utth)
             if 'q' in data['binType'].lower():
                 data['IOtth'] = [2.*asind(Ltth*wave/(4.*math.pi)),2.*asind(Utth*wave/(4.*math.pi))]
             else:
                 data['IOtth'] = [Ltth,Utth]
-            G2frame.InnerTth.SetValue(Ltth)
-            G2frame.OuterTth.SetValue(Utth)
             wx.CallAfter(G2plt.PlotExposedImage,G2frame,event=tc.event)
 
         def OnLRazim(invalid,value,tc):
-            Lazm = float(G2frame.Lazim.GetValue())%360.
-            Razm = float(G2frame.Razim.GetValue())%360.
+            '''Respond to a change in integration azimuth range
+            '''
+            Lazm = data['LRazimuth'][0] % 360.
+            Razm = data['LRazimuth'][1] % 360.
             if Lazm > Razm:
                 Razm += 360.
             if data['fullIntegrate']:
                 Razm = Lazm+360.
-            G2frame.Lazim.SetValue(Lazm)
-            G2frame.Razim.SetValue(Razm)
-            data['LRazimuth'] = [Lazm,Razm]
+            if data['LRazimuth'][0] != Lazm or data['LRazimuth'][1] != Razm:
+                G2frame.Lazim.ChangeValue(Lazm)
+                G2frame.Razim.ChangeValue(Razm)
+                data['LRazimuth'] = [Lazm,Razm]
             wx.CallAfter(G2plt.PlotExposedImage,G2frame,event=tc.event)
 
         def OnNumOutAzms(invalid,value,tc):
             wx.CallAfter(G2plt.PlotExposedImage,G2frame,event=tc.event)
 
         def OnNumOutBins(invalid,value,tc):
+            # make sure # channels is divisible by 4
             data['outChannels'] = (data['outChannels']//4)*4
-            outChan.SetValue(data['outChannels'])
+            outChan.ChangeValue(data['outChannels'])
 
         def OnOblique(event):
             data['Oblique'][1] = not data['Oblique'][1]
@@ -1199,7 +1204,7 @@ def OnShowLines(event):
             G2plt.PlotExposedImage(G2frame,event=event)
 
         def OnFullIntegrate(event):
-            Lazm = float(G2frame.Lazim.GetValue())
+            Lazm = data['LRazimuth'][0]
             if data['fullIntegrate']:
                 data['fullIntegrate'] = False
                 data['LRazimuth'] = [Lazm,Lazm+20.]
@@ -1271,9 +1276,9 @@ def OnOchoice(event):
         littleSizer.Add(G2frame.Lazim,0,WACV)
         G2frame.Razim = G2G.ValidatedTxtCtrl(G2frame.dataWindow,LRazim,1,nDig=(6,1,'f'),typeHint=float,OnLeave=OnLRazim)
         if data['fullIntegrate']:
+            G2frame.Razim.ChangeValue(LRazim[0]+360.)
             G2frame.Razim.Enable(False)
-            G2frame.Razim.SetBackgroundColour(VERY_LIGHT_GREY)
-            G2frame.Razim.SetValue(LRazim[0]+360.)
+            #G2frame.Razim.SetBackgroundColour(VERY_LIGHT_GREY)
         littleSizer.Add(G2frame.Razim,0,WACV)
         dataSizer.Add(littleSizer,0,)
         dataSizer.Add(wx.StaticText(parent=G2frame.dataWindow,label=' No. 2-theta/azimuth bins'),0,WACV)
@@ -2028,11 +2033,11 @@ def OnNewVal(invalid,value,tc):
             r11 = min(max(Range[1][1],Range[1][0]+1),Range[0][1]) # keep values in range
             if r11 != Range[1][1]:
                 Range[1][1] = r11
-                maxVal.SetValue(int(Range[1][1]))
+                maxVal.ChangeValue(int(Range[1][1]))
             r10 = max(min(Range[1][0],Range[1][1]-1),Range[0][0])
             if r10 != Range[1][0]:
                 Range[1][0] = r10
-                minVal.SetValue(int(Range[1][0]))
+                minVal.ChangeValue(int(Range[1][0]))
             sqrtDeltZero = math.sqrt(max(1.0,Range[0][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax0-Imin-1)
             sqrtDeltOne  = math.sqrt(max(1.0,Range[1][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax-Imin-1)
             sv1 = min(100,max(0,int(0.5+100.*sqrtDeltOne/sqrtDeltZero)))
@@ -2055,7 +2060,7 @@ def OnMaxSlider(event):
             G2frame.prevMaxValue = val
             sqrtDeltZero = math.sqrt(max(1.0,Range[0][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax0-Imin-1)
             Range[1][1] = int(0.5 + (val * sqrtDeltZero / 100.)**2 + Range[1][0] + 1)
-            maxVal.SetValue(int(0.5+Range[1][1]))
+            maxVal.ChangeValue(int(0.5+Range[1][1]))
             DeltOne  = max(1.0,Range[1][1]-max(0.0,Range[0][0])-1)
             minSel.SetValue(int(0.5 + 100*(Range[1][0]/DeltOne)))
             sv0 = min(100,max(0,int(0.5+100.*(Range[1][0]-Range[0][0])/DeltOne)))
@@ -2075,7 +2080,7 @@ def OnMinSlider(event):
             G2frame.prevMinValue = val
             DeltOne  = max(1.0,Range[1][1]-max(0.0,Range[0][0])-1) # Imax-Imin0-1
             Range[1][0] = max(0,int(0.5 + val * DeltOne / 100 + Range[0][0]))
-            minVal.SetValue(int(Range[1][0]))
+            minVal.ChangeValue(int(Range[1][0]))
             sqrtDeltZero = math.sqrt(max(1.0,Range[0][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax0-Imin-1)
             sqrtDeltOne  = math.sqrt(max(1.0,Range[1][1]-max(0.0,Range[1][0])-1)) # sqrt(Imax-Imin-1)
             sv1 = min(100,max(0,int(0.5+100.*sqrtDeltOne/sqrtDeltZero)))
@@ -2111,8 +2116,8 @@ def OnAutoSet(event):
             DeltOne  = max(1.0,Range[1][1]-max(0.0,Range[0][0])-1)
             sv0 = min(100,max(0,int(0.5+100.*(Range[1][0]-Range[0][0])/DeltOne)))
             minSel.SetValue(sv0)
-            minVal.SetValue(int(Range[1][0]))
-            maxVal.SetValue(int(Range[1][1]))
+            minVal.ChangeValue(int(Range[1][0]))
+            maxVal.ChangeValue(int(Range[1][1]))
             new,plotNum,Page,Plot,lim = G2frame.G2plotNB.FindPlotTab('2D Powder Image','mpl',newImage=False)
             Page.ImgObj.set_clim([Range[1][0],Range[1][1]])
             if mplOld: