source: trunk/GSASIIctrls.py @ 1801

Last change on this file since 1801 was 1801, checked in by toby, 7 years ago

fix selection problem in G2MultiChoiceDialog; range selection broken -- at least on Mac

  • Property svn:eol-style set to native
File size: 112.3 KB
Line 
1# -*- coding: utf-8 -*-
2#GSASIIctrls - Custom GSAS-II GUI controls
3########### SVN repository information ###################
4# $Date: $
5# $Author: $
6# $Revision: $
7# $URL: $
8# $Id: $
9########### SVN repository information ###################
10'''
11*GSASIIctrls: Custom GUI controls*
12-------------------------------------------
13
14A library of GUI controls for reuse throughout GSAS-II
15
16(at present many are still in GSASIIgrid, but with time will be moved here)
17
18'''
19import wx
20# import wx.grid as wg
21# import wx.wizard as wz
22# import wx.aui
23import wx.lib.scrolledpanel as wxscroll
24import time
25import copy
26# import cPickle
27import sys
28import os
29# import numpy as np
30# import numpy.ma as ma
31# import scipy.optimize as so
32import wx.html        # could postpone this for quicker startup
33import webbrowser     # could postpone this for quicker startup
34
35import GSASIIpath
36GSASIIpath.SetVersionNumber("$Revision: 1614 $")
37# import GSASIImath as G2mth
38# import GSASIIIO as G2IO
39# import GSASIIstrIO as G2stIO
40# import GSASIIlattice as G2lat
41# import GSASIIplot as G2plt
42import GSASIIpwdGUI as G2pdG
43# import GSASIIimgGUI as G2imG
44# import GSASIIphsGUI as G2phG
45# import GSASIIspc as G2spc
46# import GSASIImapvars as G2mv
47# import GSASIIconstrGUI as G2cnstG
48# import GSASIIrestrGUI as G2restG
49import GSASIIpy3 as G2py3
50# import GSASIIobj as G2obj
51# import GSASIIexprGUI as G2exG
52import GSASIIlog as log
53
54# Define a short names for convenience
55WHITE = (255,255,255)
56DULL_YELLOW = (230,230,190)
57VERY_LIGHT_GREY = wx.Colour(235,235,235)
58WACV = wx.ALIGN_CENTER_VERTICAL
59
60################################################################################
61#### Tree Control
62################################################################################
63class G2TreeCtrl(wx.TreeCtrl):
64    '''Create a wrapper around the standard TreeCtrl so we can "wrap"
65    various events.
66   
67    This logs when a tree item is selected (in :meth:`onSelectionChanged`)
68
69    This also wraps lists and dicts pulled out of the tree to track where
70    they were retrieved from.
71    '''
72    def __init__(self,parent=None,*args,**kwargs):
73        super(self.__class__,self).__init__(parent=parent,*args,**kwargs)
74        self.G2frame = parent.GetParent()
75        self.root = self.AddRoot('Loaded Data: ')
76        self.SelectionChanged = None
77        log.LogInfo['Tree'] = self
78
79    def _getTreeItemsList(self,item):
80        '''Get the full tree hierarchy from a reference to a tree item.
81        Note that this effectively hard-codes phase and histogram names in the
82        returned list. We may want to make these names relative in the future.
83        '''
84        textlist = [self.GetItemText(item)]
85        parent = self.GetItemParent(item)
86        while parent:
87            if parent == self.root: break
88            textlist.insert(0,self.GetItemText(parent))
89            parent = self.GetItemParent(parent)
90        return textlist
91
92    def onSelectionChanged(self,event):
93        '''Log each press on a tree item here.
94        '''
95        if self.SelectionChanged:
96            textlist = self._getTreeItemsList(event.GetItem())
97            if log.LogInfo['Logging'] and event.GetItem() != self.root:
98                textlist[0] = self.GetRelativeHistNum(textlist[0])
99                if textlist[0] == "Phases" and len(textlist) > 1:
100                    textlist[1] = self.GetRelativePhaseNum(textlist[1])
101                log.MakeTreeLog(textlist)
102            self.SelectionChanged(event)
103
104    def Bind(self,eventtype,handler,*args,**kwargs):
105        '''Override the Bind() function so that page change events can be trapped
106        '''
107        if eventtype == wx.EVT_TREE_SEL_CHANGED:
108            self.SelectionChanged = handler
109            wx.TreeCtrl.Bind(self,eventtype,self.onSelectionChanged)
110            return
111        wx.TreeCtrl.Bind(self,eventtype,handler,*args,**kwargs)
112
113    # commented out, disables Logging
114    # def GetItemPyData(self,*args,**kwargs):
115    #    '''Override the standard method to wrap the contents
116    #    so that the source can be logged when changed
117    #    '''
118    #    data = super(self.__class__,self).GetItemPyData(*args,**kwargs)
119    #    textlist = self._getTreeItemsList(args[0])
120    #    if type(data) is dict:
121    #        return log.dictLogged(data,textlist)
122    #    if type(data) is list:
123    #        return log.listLogged(data,textlist)
124    #    if type(data) is tuple: #N.B. tuples get converted to lists
125    #        return log.listLogged(list(data),textlist)
126    #    return data
127
128    def GetRelativeHistNum(self,histname):
129        '''Returns list with a histogram type and a relative number for that
130        histogram, or the original string if not a histogram
131        '''
132        histtype = histname.split()[0]
133        if histtype != histtype.upper(): # histograms (only) have a keyword all in caps
134            return histname
135        item, cookie = self.GetFirstChild(self.root)
136        i = 0
137        while item:
138            itemtext = self.GetItemText(item)
139            if itemtext == histname:
140                return histtype,i
141            elif itemtext.split()[0] == histtype:
142                i += 1
143            item, cookie = self.GetNextChild(self.root, cookie)
144        else:
145            raise Exception("Histogram not found: "+histname)
146
147    def ConvertRelativeHistNum(self,histtype,histnum):
148        '''Converts a histogram type and relative histogram number to a
149        histogram name in the current project
150        '''
151        item, cookie = self.GetFirstChild(self.root)
152        i = 0
153        while item:
154            itemtext = self.GetItemText(item)
155            if itemtext.split()[0] == histtype:
156                if i == histnum: return itemtext
157                i += 1
158            item, cookie = self.GetNextChild(self.root, cookie)
159        else:
160            raise Exception("Histogram #'+str(histnum)+' of type "+histtype+' not found')
161       
162    def GetRelativePhaseNum(self,phasename):
163        '''Returns a phase number if the string matches a phase name
164        or else returns the original string
165        '''
166        item, cookie = self.GetFirstChild(self.root)
167        while item:
168            itemtext = self.GetItemText(item)
169            if itemtext == "Phases":
170                parent = item
171                item, cookie = self.GetFirstChild(parent)
172                i = 0
173                while item:
174                    itemtext = self.GetItemText(item)
175                    if itemtext == phasename:
176                        return i
177                    item, cookie = self.GetNextChild(parent, cookie)
178                    i += 1
179                else:
180                    return phasename # not a phase name
181            item, cookie = self.GetNextChild(self.root, cookie)
182        else:
183            raise Exception("No phases found ")
184
185    def ConvertRelativePhaseNum(self,phasenum):
186        '''Converts relative phase number to a phase name in
187        the current project
188        '''
189        item, cookie = self.GetFirstChild(self.root)
190        while item:
191            itemtext = self.GetItemText(item)
192            if itemtext == "Phases":
193                parent = item
194                item, cookie = self.GetFirstChild(parent)
195                i = 0
196                while item:
197                    if i == phasenum:
198                        return self.GetItemText(item)
199                    item, cookie = self.GetNextChild(parent, cookie)
200                    i += 1
201                else:
202                    raise Exception("Phase "+str(phasenum)+" not found")
203            item, cookie = self.GetNextChild(self.root, cookie)
204        else:
205            raise Exception("No phases found ")
206
207################################################################################
208#### TextCtrl that stores input as entered with optional validation
209################################################################################
210class ValidatedTxtCtrl(wx.TextCtrl):
211    '''Create a TextCtrl widget that uses a validator to prevent the
212    entry of inappropriate characters and changes color to highlight
213    when invalid input is supplied. As valid values are typed,
214    they are placed into the dict or list where the initial value
215    came from. The type of the initial value must be int,
216    float or str or None (see :obj:`key` and :obj:`typeHint`);
217    this type (or the one in :obj:`typeHint`) is preserved.
218
219    Float values can be entered in the TextCtrl as numbers or also
220    as algebraic expressions using operators + - / \* () and \*\*,
221    in addition pi, sind(), cosd(), tand(), and sqrt() can be used,
222    as well as appreviations s, sin, c, cos, t, tan and sq.
223
224    :param wx.Panel parent: name of panel or frame that will be
225      the parent to the TextCtrl. Can be None.
226
227    :param dict/list loc: the dict or list with the initial value to be
228      placed in the TextCtrl.
229
230    :param int/str key: the dict key or the list index for the value to be
231      edited by the TextCtrl. The ``loc[key]`` element must exist, but may
232      have value None. If None, the type for the element is taken from
233      :obj:`typeHint` and the value for the control is set initially
234      blank (and thus invalid.) This is a way to specify a field without a
235      default value: a user must set a valid value.
236      If the value is not None, it must have a base
237      type of int, float, str or unicode; the TextCrtl will be initialized
238      from this value.
239     
240    :param list nDig: number of digits & places ([nDig,nPlc]) after decimal to use
241      for display of float. Alternately, None can be specified which causes
242      numbers to be displayed with approximately 5 significant figures
243      (Default=None).
244
245    :param bool notBlank: if True (default) blank values are invalid
246      for str inputs.
247     
248    :param number min: minimum allowed valid value. If None (default) the
249      lower limit is unbounded.
250
251    :param number max: maximum allowed valid value. If None (default) the
252      upper limit is unbounded
253
254    :param function OKcontrol: specifies a function or method that will be
255      called when the input is validated. The called function is supplied
256      with one argument which is False if the TextCtrl contains an invalid
257      value and True if the value is valid.
258      Note that this function should check all values
259      in the dialog when True, since other entries might be invalid.
260      The default for this is None, which indicates no function should
261      be called.
262
263    :param function OnLeave: specifies a function or method that will be
264      called when the focus for the control is lost.
265      The called function is supplied with (at present) three keyword arguments:
266
267         * invalid: (*bool*) True if the value for the TextCtrl is invalid
268         * value:   (*int/float/str*)  the value contained in the TextCtrl
269         * tc:      (*wx.TextCtrl*)  the TextCtrl name
270
271      The number of keyword arguments may be increased in the future should needs arise,
272      so it is best to code these functions with a \*\*kwargs argument so they will
273      continue to run without errors
274
275      The default for OnLeave is None, which indicates no function should
276      be called.
277
278    :param type typeHint: the value of typeHint is overrides the initial value
279      for the dict/list element ``loc[key]``, if set to
280      int or float, which specifies the type for input to the TextCtrl.
281      Defaults as None, which is ignored.
282
283    :param bool CIFinput: for str input, indicates that only printable
284      ASCII characters may be entered into the TextCtrl. Forces output
285      to be ASCII rather than Unicode. For float and int input, allows
286      use of a single '?' or '.' character as valid input.
287
288    :param dict OnLeaveArgs: a dict with keyword args that are passed to
289      the :attr:`OnLeave` function. Defaults to ``{}``
290
291    :param (other): other optional keyword parameters for the
292      wx.TextCtrl widget such as size or style may be specified.
293
294    '''
295    def __init__(self,parent,loc,key,nDig=None,notBlank=True,min=None,max=None,
296                 OKcontrol=None,OnLeave=None,typeHint=None,
297                 CIFinput=False, OnLeaveArgs={}, **kw):
298        # save passed values needed outside __init__
299        self.result = loc
300        self.key = key
301        self.nDig = nDig
302        self.OKcontrol=OKcontrol
303        self.OnLeave = OnLeave
304        self.OnLeaveArgs = OnLeaveArgs
305        self.CIFinput = CIFinput
306        self.type = str
307        # initialization
308        self.invalid = False   # indicates if the control has invalid contents
309        self.evaluated = False # set to True when the validator recognizes an expression
310        val = loc[key]
311        if isinstance(val,int) or typeHint is int:
312            self.type = int
313            wx.TextCtrl.__init__(
314                self,parent,wx.ID_ANY,
315                validator=NumberValidator(int,result=loc,key=key,
316                                          min=min,max=max,
317                                          OKcontrol=OKcontrol,
318                                          CIFinput=CIFinput),
319                **kw)
320            if val is not None:
321                self._setValue(val)
322            else: # no default is invalid for a number
323                self.invalid = True
324                self._IndicateValidity()
325
326        elif isinstance(val,float) or typeHint is float:
327            self.type = float
328            wx.TextCtrl.__init__(
329                self,parent,wx.ID_ANY,
330                validator=NumberValidator(float,result=loc,key=key,
331                                          min=min,max=max,
332                                          OKcontrol=OKcontrol,
333                                          CIFinput=CIFinput),
334                **kw)
335            if val is not None:
336                self._setValue(val)
337            else:
338                self.invalid = True
339                self._IndicateValidity()
340
341        elif isinstance(val,str) or isinstance(val,unicode):
342            if self.CIFinput:
343                wx.TextCtrl.__init__(
344                    self,parent,wx.ID_ANY,val,
345                    validator=ASCIIValidator(result=loc,key=key),
346                    **kw)
347            else:
348                wx.TextCtrl.__init__(self,parent,wx.ID_ANY,val,**kw)
349            if notBlank:
350                self.Bind(wx.EVT_CHAR,self._onStringKey)
351                self.ShowStringValidity() # test if valid input
352            else:
353                self.invalid = False
354                self.Bind(wx.EVT_CHAR,self._GetStringValue)
355        elif val is None:
356            raise Exception,("ValidatedTxtCtrl error: value of "+str(key)+
357                             " element is None and typeHint not defined as int or float")
358        else:
359            raise Exception,("ValidatedTxtCtrl error: Unknown element ("+str(key)+
360                             ") type: "+str(type(val)))
361        # When the mouse is moved away or the widget loses focus,
362        # display the last saved value, if an expression
363        #self.Bind(wx.EVT_LEAVE_WINDOW, self._onLeaveWindow)
364        self.Bind(wx.EVT_TEXT_ENTER, self._onLoseFocus)
365        self.Bind(wx.EVT_KILL_FOCUS, self._onLoseFocus)
366        # patch for wx 2.9 on Mac
367        i,j= wx.__version__.split('.')[0:2]
368        if int(i)+int(j)/10. > 2.8 and 'wxOSX' in wx.PlatformInfo:
369            self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
370
371    def SetValue(self,val):
372        if self.result is not None: # note that this bypasses formatting
373            self.result[self.key] = val
374            log.LogVarChange(self.result,self.key)
375        self._setValue(val)
376
377    def _setValue(self,val):
378        self.invalid = False
379        if self.type is int:
380            try:
381                if int(val) != val:
382                    self.invalid = True
383                else:
384                    val = int(val)
385            except:
386                if self.CIFinput and (val == '?' or val == '.'):
387                    pass
388                else:
389                    self.invalid = True
390            wx.TextCtrl.SetValue(self,str(val))
391        elif self.type is float:
392            try:
393                val = float(val) # convert strings, if needed
394            except:
395                if self.CIFinput and (val == '?' or val == '.'):
396                    pass
397                else:
398                    self.invalid = True
399            if self.nDig:
400                wx.TextCtrl.SetValue(self,str(G2py3.FormatValue(val,self.nDig)))
401            else:
402                wx.TextCtrl.SetValue(self,str(G2py3.FormatSigFigs(val)).rstrip('0'))
403        else:
404            wx.TextCtrl.SetValue(self,str(val))
405            self.ShowStringValidity() # test if valid input
406            return
407       
408        self._IndicateValidity()
409        if self.OKcontrol:
410            self.OKcontrol(not self.invalid)
411
412    def OnKeyDown(self,event):
413        'Special callback for wx 2.9+ on Mac where backspace is not processed by validator'
414        key = event.GetKeyCode()
415        if key in [wx.WXK_BACK, wx.WXK_DELETE]:
416            if self.Validator: wx.CallAfter(self.Validator.TestValid,self)
417        if key == wx.WXK_RETURN:
418            self._onLoseFocus(None)
419        event.Skip()
420                   
421    def _onStringKey(self,event):
422        event.Skip()
423        if self.invalid: # check for validity after processing the keystroke
424            wx.CallAfter(self.ShowStringValidity,True) # was invalid
425        else:
426            wx.CallAfter(self.ShowStringValidity,False) # was valid
427
428    def _IndicateValidity(self):
429        'Set the control colors to show invalid input'
430        if self.invalid:
431            self.SetForegroundColour("red")
432            self.SetBackgroundColour("yellow")
433            self.SetFocus()
434            self.Refresh()
435        else: # valid input
436            self.SetBackgroundColour(
437                wx.SystemSettings_GetColour(wx.SYS_COLOUR_WINDOW))
438            self.SetForegroundColour("black")
439            self.Refresh()
440
441    def ShowStringValidity(self,previousInvalid=True):
442        '''Check if input is valid. Anytime the input is
443        invalid, call self.OKcontrol (if defined) because it is fast.
444        If valid, check for any other invalid entries only when
445        changing from invalid to valid, since that is slower.
446       
447        :param bool previousInvalid: True if the TextCtrl contents were
448          invalid prior to the current change.
449         
450        '''
451        val = self.GetValue().strip()
452        self.invalid = not val
453        self._IndicateValidity()
454        if self.invalid:
455            if self.OKcontrol:
456                self.OKcontrol(False)
457        elif self.OKcontrol and previousInvalid:
458            self.OKcontrol(True)
459        # always store the result
460        if self.CIFinput: # for CIF make results ASCII
461            self.result[self.key] = val.encode('ascii','replace') 
462        else:
463            self.result[self.key] = val
464        log.LogVarChange(self.result,self.key)
465
466    def _GetStringValue(self,event):
467        '''Get string input and store.
468        '''
469        event.Skip() # process keystroke
470        wx.CallAfter(self._SaveStringValue)
471       
472    def _SaveStringValue(self):
473        val = self.GetValue().strip()
474        # always store the result
475        if self.CIFinput: # for CIF make results ASCII
476            self.result[self.key] = val.encode('ascii','replace') 
477        else:
478            self.result[self.key] = val
479        log.LogVarChange(self.result,self.key)
480
481    def _onLoseFocus(self,event):
482        if self.evaluated:
483            self.EvaluateExpression()
484        elif self.result is not None: # show formatted result, as Bob wants
485            self._setValue(self.result[self.key])
486        if self.OnLeave: self.OnLeave(invalid=self.invalid,
487                                      value=self.result[self.key],
488                                      tc=self,
489                                      **self.OnLeaveArgs)
490        if event: event.Skip()
491
492    def EvaluateExpression(self):
493        '''Show the computed value when an expression is entered to the TextCtrl
494        Make sure that the number fits by truncating decimal places and switching
495        to scientific notation, as needed.
496        Called on loss of focus, enter, etc..
497        '''
498        if self.invalid: return # don't substitute for an invalid expression
499        if not self.evaluated: return # true when an expression is evaluated
500        if self.result is not None: # retrieve the stored result
501            self._setValue(self.result[self.key])
502        self.evaluated = False # expression has been recast as value, reset flag
503       
504class NumberValidator(wx.PyValidator):
505    '''A validator to be used with a TextCtrl to prevent
506    entering characters other than digits, signs, and for float
507    input, a period and exponents.
508   
509    The value is checked for validity after every keystroke
510      If an invalid number is entered, the box is highlighted.
511      If the number is valid, it is saved in result[key]
512
513    :param type typ: the base data type. Must be int or float.
514
515    :param bool positiveonly: If True, negative integers are not allowed
516      (default False). This prevents the + or - keys from being pressed.
517      Used with typ=int; ignored for typ=float.
518
519    :param number min: Minimum allowed value. If None (default) the
520      lower limit is unbounded
521
522    :param number max: Maximum allowed value. If None (default) the
523      upper limit is unbounded
524     
525    :param dict/list result: List or dict where value should be placed when valid
526
527    :param any key: key to use for result (int for list)
528
529    :param function OKcontrol: function or class method to control
530      an OK button for a window.
531      Ignored if None (default)
532
533    :param bool CIFinput: allows use of a single '?' or '.' character
534      as valid input.
535     
536    '''
537    def __init__(self, typ, positiveonly=False, min=None, max=None,
538                 result=None, key=None, OKcontrol=None, CIFinput=False):
539        'Create the validator'
540        wx.PyValidator.__init__(self)
541        # save passed parameters
542        self.typ = typ
543        self.positiveonly = positiveonly
544        self.min = min
545        self.max = max
546        self.result = result
547        self.key = key
548        self.OKcontrol = OKcontrol
549        self.CIFinput = CIFinput
550        # set allowed keys by data type
551        self.Bind(wx.EVT_CHAR, self.OnChar)
552        if self.typ == int and self.positiveonly:
553            self.validchars = '0123456789'
554        elif self.typ == int:
555            self.validchars = '0123456789+-'
556        elif self.typ == float:
557            # allow for above and sind, cosd, sqrt, tand, pi, and abbreviations
558            # also addition, subtraction, division, multiplication, exponentiation
559            self.validchars = '0123456789.-+eE/cosindcqrtap()*'
560        else:
561            self.validchars = None
562            return
563        if self.CIFinput:
564            self.validchars += '?.'
565    def Clone(self):
566        'Create a copy of the validator, a strange, but required component'
567        return NumberValidator(typ=self.typ, 
568                               positiveonly=self.positiveonly,
569                               min=self.min, max=self.max,
570                               result=self.result, key=self.key,
571                               OKcontrol=self.OKcontrol,
572                               CIFinput=self.CIFinput)
573    def TransferToWindow(self):
574        'Needed by validator, strange, but required component'
575        return True # Prevent wxDialog from complaining.
576    def TransferFromWindow(self):
577        'Needed by validator, strange, but required component'
578        return True # Prevent wxDialog from complaining.
579    def TestValid(self,tc):
580        '''Check if the value is valid by casting the input string
581        into the current type.
582
583        Set the invalid variable in the TextCtrl object accordingly.
584
585        If the value is valid, save it in the dict/list where
586        the initial value was stored, if appropriate.
587
588        :param wx.TextCtrl tc: A reference to the TextCtrl that the validator
589          is associated with.
590        '''
591        tc.invalid = False # assume valid
592        if self.CIFinput:
593            val = tc.GetValue().strip()
594            if val == '?' or val == '.':
595                self.result[self.key] = val
596                log.LogVarChange(self.result,self.key)
597                return
598        try:
599            val = self.typ(tc.GetValue())
600        except (ValueError, SyntaxError) as e:
601            if self.typ is float: # for float values, see if an expression can be evaluated
602                val = G2py3.FormulaEval(tc.GetValue())
603                if val is None:
604                    tc.invalid = True
605                    return
606                else:
607                    tc.evaluated = True
608            else: 
609                tc.invalid = True
610                return
611        # if self.max != None and self.typ == int:
612        #     if val > self.max:
613        #         tc.invalid = True
614        # if self.min != None and self.typ == int:
615        #     if val < self.min:
616        #         tc.invalid = True  # invalid
617        if self.max != None:
618            if val > self.max:
619                tc.invalid = True
620        if self.min != None:
621            if val < self.min:
622                tc.invalid = True  # invalid
623        if self.key is not None and self.result is not None and not tc.invalid:
624            self.result[self.key] = val
625            log.LogVarChange(self.result,self.key)
626
627    def ShowValidity(self,tc):
628        '''Set the control colors to show invalid input
629
630        :param wx.TextCtrl tc: A reference to the TextCtrl that the validator
631          is associated with.
632
633        '''
634        if tc.invalid:
635            tc.SetForegroundColour("red")
636            tc.SetBackgroundColour("yellow")
637            tc.SetFocus()
638            tc.Refresh()
639            return False
640        else: # valid input
641            tc.SetBackgroundColour(
642                wx.SystemSettings_GetColour(wx.SYS_COLOUR_WINDOW))
643            tc.SetForegroundColour("black")
644            tc.Refresh()
645            return True
646
647    def CheckInput(self,previousInvalid):
648        '''called to test every change to the TextCtrl for validity and
649        to change the appearance of the TextCtrl
650
651        Anytime the input is invalid, call self.OKcontrol
652        (if defined) because it is fast.
653        If valid, check for any other invalid entries only when
654        changing from invalid to valid, since that is slower.
655
656        :param bool previousInvalid: True if the TextCtrl contents were
657          invalid prior to the current change.
658        '''
659        tc = self.GetWindow()
660        self.TestValid(tc)
661        self.ShowValidity(tc)
662        # if invalid
663        if tc.invalid and self.OKcontrol:
664            self.OKcontrol(False)
665        if not tc.invalid and self.OKcontrol and previousInvalid:
666            self.OKcontrol(True)
667
668    def OnChar(self, event):
669        '''Called each type a key is pressed
670        ignores keys that are not allowed for int and float types
671        '''
672        key = event.GetKeyCode()
673        tc = self.GetWindow()
674        if key == wx.WXK_RETURN:
675            if tc.invalid:
676                self.CheckInput(True) 
677            else:
678                self.CheckInput(False) 
679            return
680        if key < wx.WXK_SPACE or key == wx.WXK_DELETE or key > 255: # control characters get processed
681            event.Skip()
682            if tc.invalid:
683                wx.CallAfter(self.CheckInput,True) 
684            else:
685                wx.CallAfter(self.CheckInput,False) 
686            return
687        elif chr(key) in self.validchars: # valid char pressed?
688            event.Skip()
689            if tc.invalid:
690                wx.CallAfter(self.CheckInput,True) 
691            else:
692                wx.CallAfter(self.CheckInput,False) 
693            return
694        if not wx.Validator_IsSilent(): wx.Bell()
695        return  # Returning without calling event.Skip, which eats the keystroke
696
697class ASCIIValidator(wx.PyValidator):
698    '''A validator to be used with a TextCtrl to prevent
699    entering characters other than ASCII characters.
700   
701    The value is checked for validity after every keystroke
702      If an invalid number is entered, the box is highlighted.
703      If the number is valid, it is saved in result[key]
704
705    :param dict/list result: List or dict where value should be placed when valid
706
707    :param any key: key to use for result (int for list)
708
709    '''
710    def __init__(self, result=None, key=None):
711        'Create the validator'
712        import string
713        wx.PyValidator.__init__(self)
714        # save passed parameters
715        self.result = result
716        self.key = key
717        self.validchars = string.ascii_letters + string.digits + string.punctuation + string.whitespace
718        self.Bind(wx.EVT_CHAR, self.OnChar)
719    def Clone(self):
720        'Create a copy of the validator, a strange, but required component'
721        return ASCIIValidator(result=self.result, key=self.key)
722        tc = self.GetWindow()
723        tc.invalid = False # make sure the validity flag is defined in parent
724    def TransferToWindow(self):
725        'Needed by validator, strange, but required component'
726        return True # Prevent wxDialog from complaining.
727    def TransferFromWindow(self):
728        'Needed by validator, strange, but required component'
729        return True # Prevent wxDialog from complaining.
730    def TestValid(self,tc):
731        '''Check if the value is valid by casting the input string
732        into ASCII.
733
734        Save it in the dict/list where the initial value was stored
735
736        :param wx.TextCtrl tc: A reference to the TextCtrl that the validator
737          is associated with.
738        '''
739        self.result[self.key] = tc.GetValue().encode('ascii','replace')
740        log.LogVarChange(self.result,self.key)
741
742    def OnChar(self, event):
743        '''Called each type a key is pressed
744        ignores keys that are not allowed for int and float types
745        '''
746        key = event.GetKeyCode()
747        tc = self.GetWindow()
748        if key == wx.WXK_RETURN:
749            self.TestValid(tc)
750            return
751        if key < wx.WXK_SPACE or key == wx.WXK_DELETE or key > 255: # control characters get processed
752            event.Skip()
753            self.TestValid(tc)
754            return
755        elif chr(key) in self.validchars: # valid char pressed?
756            event.Skip()
757            self.TestValid(tc)
758            return
759        if not wx.Validator_IsSilent():
760            wx.Bell()
761        return  # Returning without calling event.Skip, which eats the keystroke
762
763################################################################################
764#### Edit a large number of values
765################################################################################
766def CallScrolledMultiEditor(parent,dictlst,elemlst,prelbl=[],postlbl=[],
767                 title='Edit items',header='',size=(300,250),
768                             CopyButton=False, **kw):
769    '''Shell routine to call a ScrolledMultiEditor dialog. See
770    :class:`ScrolledMultiEditor` for parameter definitions.
771
772    :returns: True if the OK button is pressed; False if the window is closed
773      with the system menu or the Cancel button.
774
775    '''
776    dlg = ScrolledMultiEditor(parent,dictlst,elemlst,prelbl,postlbl,
777                              title,header,size,
778                              CopyButton, **kw)
779    if dlg.ShowModal() == wx.ID_OK:
780        dlg.Destroy()
781        return True
782    else:
783        dlg.Destroy()
784        return False
785
786class ScrolledMultiEditor(wx.Dialog):
787    '''Define a window for editing a potentially large number of dict- or
788    list-contained values with validation for each item. Edited values are
789    automatically placed in their source location. If invalid entries
790    are provided, the TextCtrl is turned yellow and the OK button is disabled.
791
792    The type for each TextCtrl validation is determined by the
793    initial value of the entry (int, float or string).
794    Float values can be entered in the TextCtrl as numbers or also
795    as algebraic expressions using operators + - / \* () and \*\*,
796    in addition pi, sind(), cosd(), tand(), and sqrt() can be used,
797    as well as appreviations s(), sin(), c(), cos(), t(), tan() and sq().
798
799    :param wx.Frame parent: name of parent window, or may be None
800
801    :param tuple dictlst: a list of dicts or lists containing values to edit
802
803    :param tuple elemlst: a list of keys for each item in a dictlst. Must have the
804      same length as dictlst.
805
806    :param wx.Frame parent: name of parent window, or may be None
807   
808    :param tuple prelbl: a list of labels placed before the TextCtrl for each
809      item (optional)
810   
811    :param tuple postlbl: a list of labels placed after the TextCtrl for each
812      item (optional)
813
814    :param str title: a title to place in the frame of the dialog
815
816    :param str header: text to place at the top of the window. May contain
817      new line characters.
818
819    :param wx.Size size: a size parameter that dictates the
820      size for the scrolled region of the dialog. The default is
821      (300,250).
822
823    :param bool CopyButton: if True adds a small button that copies the
824      value for the current row to all fields below (default is False)
825     
826    :param list minvals: optional list of minimum values for validation
827      of float or int values. Ignored if value is None.
828    :param list maxvals: optional list of maximum values for validation
829      of float or int values. Ignored if value is None.
830    :param list sizevals: optional list of wx.Size values for each input
831      widget. Ignored if value is None.
832     
833    :param tuple checkdictlst: an optional list of dicts or lists containing bool
834      values (similar to dictlst).
835    :param tuple checkelemlst: an optional list of dicts or lists containing bool
836      key values (similar to elemlst). Must be used with checkdictlst.
837    :param string checklabel: a string to use for each checkbutton
838     
839    :returns: the wx.Dialog created here. Use method .ShowModal() to display it.
840   
841    *Example for use of ScrolledMultiEditor:*
842
843    ::
844
845        dlg = <pkg>.ScrolledMultiEditor(frame,dictlst,elemlst,prelbl,postlbl,
846                                        header=header)
847        if dlg.ShowModal() == wx.ID_OK:
848             for d,k in zip(dictlst,elemlst):
849                 print d[k]
850
851    *Example definitions for dictlst and elemlst:*
852
853    ::
854     
855          dictlst = (dict1,list1,dict1,list1)
856          elemlst = ('a', 1, 2, 3)
857
858      This causes items dict1['a'], list1[1], dict1[2] and list1[3] to be edited.
859   
860    Note that these items must have int, float or str values assigned to
861    them. The dialog will force these types to be retained. String values
862    that are blank are marked as invalid.
863    '''
864   
865    def __init__(self,parent,dictlst,elemlst,prelbl=[],postlbl=[],
866                 title='Edit items',header='',size=(300,250),
867                 CopyButton=False,
868                 minvals=[],maxvals=[],sizevals=[],
869                 checkdictlst=[], checkelemlst=[], checklabel=""):
870        if len(dictlst) != len(elemlst):
871            raise Exception,"ScrolledMultiEditor error: len(dictlst) != len(elemlst) "+str(len(dictlst))+" != "+str(len(elemlst))
872        if len(checkdictlst) != len(checkelemlst):
873            raise Exception,"ScrolledMultiEditor error: len(checkdictlst) != len(checkelemlst) "+str(len(checkdictlst))+" != "+str(len(checkelemlst))
874        wx.Dialog.__init__( # create dialog & sizer
875            self,parent,wx.ID_ANY,title,
876            style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
877        mainSizer = wx.BoxSizer(wx.VERTICAL)
878        self.orig = []
879        self.dictlst = dictlst
880        self.elemlst = elemlst
881        self.checkdictlst = checkdictlst
882        self.checkelemlst = checkelemlst
883        self.StartCheckValues = [checkdictlst[i][checkelemlst[i]] for i in range(len(checkdictlst))]
884        self.ButtonIndex = {}
885        for d,i in zip(dictlst,elemlst):
886            self.orig.append(d[i])
887        # add a header if supplied
888        if header:
889            subSizer = wx.BoxSizer(wx.HORIZONTAL)
890            subSizer.Add((-1,-1),1,wx.EXPAND)
891            subSizer.Add(wx.StaticText(self,wx.ID_ANY,header))
892            subSizer.Add((-1,-1),1,wx.EXPAND)
893            mainSizer.Add(subSizer,0,wx.EXPAND,0)
894        # make OK button now, because we will need it for validation
895        self.OKbtn = wx.Button(self, wx.ID_OK)
896        self.OKbtn.SetDefault()
897        # create scrolled panel and sizer
898        panel = wxscroll.ScrolledPanel(self, wx.ID_ANY,size=size,
899            style = wx.TAB_TRAVERSAL|wx.SUNKEN_BORDER)
900        cols = 4
901        if CopyButton: cols += 1
902        subSizer = wx.FlexGridSizer(cols=cols,hgap=2,vgap=2)
903        self.ValidatedControlsList = [] # make list of TextCtrls
904        self.CheckControlsList = [] # make list of CheckBoxes
905        for i,(d,k) in enumerate(zip(dictlst,elemlst)):
906            if i >= len(prelbl): # label before TextCtrl, or put in a blank
907                subSizer.Add((-1,-1)) 
908            else:
909                subSizer.Add(wx.StaticText(panel,wx.ID_ANY,str(prelbl[i])))
910            kargs = {}
911            if i < len(minvals):
912                if minvals[i] is not None: kargs['min']=minvals[i]
913            if i < len(maxvals):
914                if maxvals[i] is not None: kargs['max']=maxvals[i]
915            if i < len(sizevals):
916                if sizevals[i]: kargs['size']=sizevals[i]
917            if CopyButton:
918                import wx.lib.colourselect as wscs
919                but = wscs.ColourSelect(label='v', # would like to use u'\u2193' or u'\u25BC' but not in WinXP
920                                        # is there a way to test?
921                                        parent=panel,
922                                        colour=(255,255,200),
923                                        size=wx.Size(30,23),
924                                        style=wx.RAISED_BORDER)
925                but.Bind(wx.EVT_BUTTON, self._OnCopyButton)
926                but.SetToolTipString('Press to copy adjacent value to all rows below')
927                self.ButtonIndex[but] = i
928                subSizer.Add(but)
929            # create the validated TextCrtl, store it and add it to the sizer
930            ctrl = ValidatedTxtCtrl(panel,d,k,OKcontrol=self.ControlOKButton,
931                                    **kargs)
932            self.ValidatedControlsList.append(ctrl)
933            subSizer.Add(ctrl)
934            if i < len(postlbl): # label after TextCtrl, or put in a blank
935                subSizer.Add(wx.StaticText(panel,wx.ID_ANY,str(postlbl[i])))
936            else:
937                subSizer.Add((-1,-1))
938            if i < len(checkdictlst):
939                ch = G2CheckBox(panel,checklabel,checkdictlst[i],checkelemlst[i])
940                self.CheckControlsList.append(ch)
941                subSizer.Add(ch)                   
942            else:
943                subSizer.Add((-1,-1))
944        # finish up ScrolledPanel
945        panel.SetSizer(subSizer)
946        panel.SetAutoLayout(1)
947        panel.SetupScrolling()
948        # patch for wx 2.9 on Mac
949        i,j= wx.__version__.split('.')[0:2]
950        if int(i)+int(j)/10. > 2.8 and 'wxOSX' in wx.PlatformInfo:
951            panel.SetMinSize((subSizer.GetSize()[0]+30,panel.GetSize()[1]))       
952        mainSizer.Add(panel,1, wx.ALL|wx.EXPAND,1)
953
954        # Sizer for OK/Close buttons. N.B. on Close changes are discarded
955        # by restoring the initial values
956        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
957        btnsizer.Add(self.OKbtn)
958        btn = wx.Button(self, wx.ID_CLOSE,"Cancel") 
959        btn.Bind(wx.EVT_BUTTON,self._onClose)
960        btnsizer.Add(btn)
961        mainSizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
962        # size out the window. Set it to be enlarged but not made smaller
963        self.SetSizer(mainSizer)
964        mainSizer.Fit(self)
965        self.SetMinSize(self.GetSize())
966
967    def _OnCopyButton(self,event):
968        'Implements the copy down functionality'
969        but = event.GetEventObject()
970        n = self.ButtonIndex.get(but)
971        if n is None: return
972        for i,(d,k,ctrl) in enumerate(zip(self.dictlst,self.elemlst,self.ValidatedControlsList)):
973            if i < n: continue
974            if i == n:
975                val = d[k]
976                continue
977            d[k] = val
978            ctrl.SetValue(val)
979        for i in range(len(self.checkdictlst)):
980            if i < n: continue
981            self.checkdictlst[i][self.checkelemlst[i]] = self.checkdictlst[n][self.checkelemlst[n]]
982            self.CheckControlsList[i].SetValue(self.checkdictlst[i][self.checkelemlst[i]])
983    def _onClose(self,event):
984        'Used on Cancel: Restore original values & close the window'
985        for d,i,v in zip(self.dictlst,self.elemlst,self.orig):
986            d[i] = v
987        for i in range(len(self.checkdictlst)):
988            self.checkdictlst[i][self.checkelemlst[i]] = self.StartCheckValues[i]
989        self.EndModal(wx.ID_CANCEL)
990       
991    def ControlOKButton(self,setvalue):
992        '''Enable or Disable the OK button for the dialog. Note that this is
993        passed into the ValidatedTxtCtrl for use by validators.
994
995        :param bool setvalue: if True, all entries in the dialog are
996          checked for validity. if False then the OK button is disabled.
997
998        '''
999        if setvalue: # turn button on, do only if all controls show as valid
1000            for ctrl in self.ValidatedControlsList:
1001                if ctrl.invalid:
1002                    self.OKbtn.Disable()
1003                    return
1004            else:
1005                self.OKbtn.Enable()
1006        else:
1007            self.OKbtn.Disable()
1008
1009################################################################################
1010#### Multichoice Dialog with set all, toggle & filter options
1011################################################################################
1012class G2MultiChoiceDialog(wx.Dialog):
1013    '''A dialog similar to MultiChoiceDialog except that buttons are
1014    added to set all choices and to toggle all choices.
1015
1016    :param wx.Frame ParentFrame: reference to parent frame
1017    :param str title: heading above list of choices
1018    :param str header: Title to place on window frame
1019    :param list ChoiceList: a list of choices where one will be selected
1020    :param bool toggle: If True (default) the toggle and select all buttons
1021      are displayed
1022    :param bool monoFont: If False (default), use a variable-spaced font;
1023      if True use a equally-spaced font.
1024    :param bool filterBox: If True (default) an input widget is placed on
1025      the window and only entries matching the entered text are shown.
1026    :param kw: optional keyword parameters for the wx.Dialog may
1027      be included such as size [which defaults to `(320,310)`] and
1028      style (which defaults to `wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL`);
1029      note that `wx.OK` and `wx.CANCEL` controls
1030      the presence of the eponymous buttons in the dialog.
1031    :returns: the name of the created dialog 
1032    '''
1033    def __init__(self,parent, title, header, ChoiceList, toggle=True,
1034                 monoFont=False, filterBox=True, **kw):
1035        # process keyword parameters, notably style
1036        options = {'size':(320,310), # default Frame keywords
1037                   'style':wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL,
1038                   }
1039        options.update(kw)
1040        self.ChoiceList = ChoiceList # list of choices (list of str values)
1041        self.Selections = len(self.ChoiceList) * [False,] # selection status for each choice (list of bools)
1042        self.filterlist = range(len(self.ChoiceList)) # list of the choice numbers that have been filtered (list of int indices)
1043        if options['style'] & wx.OK:
1044            useOK = True
1045            options['style'] ^= wx.OK
1046        else:
1047            useOK = False
1048        if options['style'] & wx.CANCEL:
1049            useCANCEL = True
1050            options['style'] ^= wx.CANCEL
1051        else:
1052            useCANCEL = False       
1053        # create the dialog frame
1054        wx.Dialog.__init__(self,parent,wx.ID_ANY,header,**options)
1055        # fill the dialog
1056        Sizer = wx.BoxSizer(wx.VERTICAL)
1057        topSizer = wx.BoxSizer(wx.HORIZONTAL)
1058        topSizer.Add(
1059            wx.StaticText(self,wx.ID_ANY,title,size=(-1,35)),
1060            1,wx.ALL|wx.EXPAND|WACV,1)
1061        if filterBox:
1062            self.timer = wx.Timer()
1063            self.timer.Bind(wx.EVT_TIMER,self.Filter)
1064            topSizer.Add(wx.StaticText(self,wx.ID_ANY,'Name \nFilter: '),0,wx.ALL|WACV,1)
1065            self.filterBox = wx.TextCtrl(self, wx.ID_ANY, size=(80,-1),style=wx.TE_PROCESS_ENTER)
1066            self.filterBox.Bind(wx.EVT_CHAR,self.onChar)
1067            self.filterBox.Bind(wx.EVT_TEXT_ENTER,self.Filter)
1068            topSizer.Add(self.filterBox,0,wx.ALL|WACV,0)
1069        Sizer.Add(topSizer,0,wx.ALL|wx.EXPAND,8)
1070        self.trigger = False
1071        self.clb = wx.CheckListBox(self, wx.ID_ANY, (30,30), wx.DefaultSize, ChoiceList)
1072        self.clb.Bind(wx.EVT_CHECKLISTBOX,self.OnCheck)
1073        if monoFont:
1074            font1 = wx.Font(self.clb.GetFont().GetPointSize(),
1075                            wx.MODERN, wx.NORMAL, wx.NORMAL, False)
1076            self.clb.SetFont(font1)
1077        Sizer.Add(self.clb,1,wx.LEFT|wx.RIGHT|wx.EXPAND,10)
1078        Sizer.Add((-1,10))
1079        # set/toggle buttons
1080        if toggle:
1081            bSizer = wx.BoxSizer(wx.VERTICAL)
1082            setBut = wx.Button(self,wx.ID_ANY,'Set All')
1083            setBut.Bind(wx.EVT_BUTTON,self._SetAll)
1084            bSizer.Add(setBut,0,wx.ALIGN_CENTER)
1085            bSizer.Add((-1,5))
1086            togBut = wx.Button(self,wx.ID_ANY,'Toggle All')
1087            togBut.Bind(wx.EVT_BUTTON,self._ToggleAll)
1088            bSizer.Add(togBut,0,wx.ALIGN_CENTER)
1089            Sizer.Add(bSizer,0,wx.LEFT,12)
1090        # OK/Cancel buttons
1091        btnsizer = wx.StdDialogButtonSizer()
1092        if useOK:
1093            self.OKbtn = wx.Button(self, wx.ID_OK)
1094            self.OKbtn.SetDefault()
1095            btnsizer.AddButton(self.OKbtn)
1096        if useCANCEL:
1097            btn = wx.Button(self, wx.ID_CANCEL)
1098            btnsizer.AddButton(btn)
1099        btnsizer.Realize()
1100        Sizer.Add((-1,5))
1101        Sizer.Add(btnsizer,0,wx.ALIGN_RIGHT,50)
1102        Sizer.Add((-1,20))
1103        # OK done, let's get outa here
1104        self.SetSizer(Sizer)
1105        self.CenterOnParent()
1106       
1107    def GetSelections(self):
1108        'Returns a list of the indices for the selected choices'
1109        # update self.Selections with settings for displayed items
1110        for i in range(len(self.filterlist)):
1111            self.Selections[self.filterlist[i]] = self.clb.IsChecked(i)
1112        # return all selections, shown or hidden
1113        return [i for i in range(len(self.Selections)) if self.Selections[i]]
1114       
1115    def SetSelections(self,selList):
1116        '''Sets the selection indices in selList as selected. Resets any previous
1117        selections for compatibility with wx.MultiChoiceDialog. Note that
1118        the state for only the filtered items is shown.
1119
1120        :param list selList: indices of items to be selected. These indices
1121          are referenced to the order in self.ChoiceList
1122        '''
1123        self.Selections = len(self.ChoiceList) * [False,] # reset selections
1124        for sel in selList:
1125            self.Selections[sel] = True
1126        self._ShowSelections()
1127
1128    def _ShowSelections(self):
1129        'Show the selection state for displayed items'
1130        self.clb.SetChecked(
1131            [i for i in range(len(self.filterlist)) if self.Selections[self.filterlist[i]]]
1132            ) # Note anything previously checked will be cleared.
1133           
1134    def _SetAll(self,event):
1135        'Set all viewed choices on'
1136        self.clb.SetChecked(range(len(self.filterlist)))
1137       
1138    def _ToggleAll(self,event):
1139        'flip the state of all viewed choices'
1140        for i in range(len(self.filterlist)):
1141            self.clb.Check(i,not self.clb.IsChecked(i))
1142           
1143    def onChar(self,event):
1144        'for keyboard events. self.trigger is used in self.OnCheck below'
1145        self.OKbtn.Enable(False)
1146        if event.GetKeyCode() == wx.WXK_SHIFT:
1147            self.trigger = True
1148            print 'debug: Shift pressed'
1149        if self.timer.IsRunning():
1150            self.timer.Stop()
1151        self.timer.Start(1000,oneShot=True)
1152        event.Skip()
1153       
1154    def OnCheck(self,event):
1155        '''for CheckListBox events; if Shift key down this sets all unset
1156            entries below the selected one'''
1157        if self.trigger:
1158            id = event.GetSelection()
1159            name = self.clb.GetString(id)           
1160            iB = id-1
1161            if iB < 0:
1162                return
1163            while not self.clb.IsChecked(iB):
1164                self.clb.Check(iB)
1165                iB -= 1
1166                if iB < 0:
1167                    break
1168            self.trigger = False
1169       
1170    def Filter(self,event):
1171        if self.timer.IsRunning():
1172            self.timer.Stop()
1173        self.GetSelections() # record current selections
1174        txt = self.filterBox.GetValue()
1175        self.clb.Clear()
1176       
1177        self.Update()
1178        self.filterlist = []
1179        if txt:
1180            txt = txt.lower()
1181            ChoiceList = []
1182            for i,item in enumerate(self.ChoiceList):
1183                if item.lower().find(txt) != -1:
1184                    ChoiceList.append(item)
1185                    self.filterlist.append(i)
1186        else:
1187            self.filterlist = range(len(self.ChoiceList))
1188            ChoiceList = self.ChoiceList
1189        self.clb.AppendItems(ChoiceList)
1190        self._ShowSelections()
1191        self.OKbtn.Enable(True)
1192
1193def SelectEdit1Var(G2frame,array,labelLst,elemKeysLst,dspLst,refFlgElem):
1194    '''Select a variable from a list, then edit it and select histograms
1195    to copy it to.
1196
1197    :param wx.Frame G2frame: main GSAS-II frame
1198    :param dict array: the array (dict or list) where values to be edited are kept
1199    :param list labelLst: labels for each data item
1200    :param list elemKeysLst: a list of lists of keys needed to be applied (see below)
1201      to obtain the value of each parameter
1202    :param list dspLst: list list of digits to be displayed (10,4) is 10 digits
1203      with 4 decimal places. Can be None.
1204    :param list refFlgElem: a list of lists of keys needed to be applied (see below)
1205      to obtain the refine flag for each parameter or None if the parameter
1206      does not have refine flag.
1207
1208    Example::
1209      array = data
1210      labelLst = ['v1','v2']
1211      elemKeysLst = [['v1'], ['v2',0]]
1212      refFlgElem = [None, ['v2',1]]
1213
1214     * The value for v1 will be in data['v1'] and this cannot be refined while,
1215     * The value for v2 will be in data['v2'][0] and its refinement flag is data['v2'][1]
1216    '''
1217    def unkey(dct,keylist):
1218        '''dive into a nested set of dicts/lists applying keys in keylist
1219        consecutively
1220        '''
1221        d = dct
1222        for k in keylist:
1223            d = d[k]
1224        return d
1225
1226    def OnChoice(event):
1227        'Respond when a parameter is selected in the Choice box'
1228        valSizer.DeleteWindows()
1229        lbl = event.GetString()
1230        copyopts['currentsel'] = lbl
1231        i = labelLst.index(lbl)
1232        OKbtn.Enable(True)
1233        ch.SetLabel(lbl)
1234        args = {}
1235        if dspLst[i]:
1236            args = {'nDig':dspLst[i]}
1237        Val = ValidatedTxtCtrl(
1238            dlg,
1239            unkey(array,elemKeysLst[i][:-1]),
1240            elemKeysLst[i][-1],
1241            **args)
1242        copyopts['startvalue'] = unkey(array,elemKeysLst[i])
1243        #unkey(array,elemKeysLst[i][:-1])[elemKeysLst[i][-1]] =
1244        valSizer.Add(Val,0,wx.LEFT,5)
1245        dlg.SendSizeEvent()
1246       
1247    # SelectEdit1Var execution begins here
1248    saveArray = copy.deepcopy(array) # keep original values
1249    TreeItemType = G2frame.PatternTree.GetItemText(G2frame.PickId)
1250    copyopts = {'InTable':False,"startvalue":None,'currentsel':None}       
1251    hst = G2frame.PatternTree.GetItemText(G2frame.PatternId)
1252    histList = G2pdG.GetHistsLikeSelected(G2frame)
1253    if not histList:
1254        G2frame.ErrorDialog('No match','No histograms match '+hst,G2frame.dataFrame)
1255        return
1256    dlg = wx.Dialog(G2frame.dataDisplay,wx.ID_ANY,'Set a parameter value',
1257        style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
1258    mainSizer = wx.BoxSizer(wx.VERTICAL)
1259    mainSizer.Add((5,5))
1260    subSizer = wx.BoxSizer(wx.HORIZONTAL)
1261    subSizer.Add((-1,-1),1,wx.EXPAND)
1262    subSizer.Add(wx.StaticText(dlg,wx.ID_ANY,'Select a parameter and set a new value'))
1263    subSizer.Add((-1,-1),1,wx.EXPAND)
1264    mainSizer.Add(subSizer,0,wx.EXPAND,0)
1265    mainSizer.Add((0,10))
1266
1267    subSizer = wx.FlexGridSizer(0,2,5,0)
1268    subSizer.Add(wx.StaticText(dlg,wx.ID_ANY,'Parameter: '))
1269    ch = wx.Choice(dlg, wx.ID_ANY, choices = sorted(labelLst))
1270    ch.SetSelection(-1)
1271    ch.Bind(wx.EVT_CHOICE, OnChoice)
1272    subSizer.Add(ch)
1273    subSizer.Add(wx.StaticText(dlg,wx.ID_ANY,'Value: '))
1274    valSizer = wx.BoxSizer(wx.HORIZONTAL)
1275    subSizer.Add(valSizer)
1276    mainSizer.Add(subSizer)
1277
1278    mainSizer.Add((-1,20))
1279    subSizer = wx.BoxSizer(wx.HORIZONTAL)
1280    subSizer.Add(G2CheckBox(dlg, 'Edit in table ', copyopts, 'InTable'))
1281    mainSizer.Add(subSizer)
1282
1283    btnsizer = wx.StdDialogButtonSizer()
1284    OKbtn = wx.Button(dlg, wx.ID_OK,'Continue')
1285    OKbtn.Enable(False)
1286    OKbtn.SetDefault()
1287    OKbtn.Bind(wx.EVT_BUTTON,lambda event: dlg.EndModal(wx.ID_OK))
1288    btnsizer.AddButton(OKbtn)
1289    btn = wx.Button(dlg, wx.ID_CANCEL)
1290    btnsizer.AddButton(btn)
1291    btnsizer.Realize()
1292    mainSizer.Add((-1,5),1,wx.EXPAND,1)
1293    mainSizer.Add(btnsizer,0,wx.ALIGN_CENTER,0)
1294    mainSizer.Add((-1,10))
1295
1296    dlg.SetSizer(mainSizer)
1297    dlg.CenterOnParent()
1298    if dlg.ShowModal() != wx.ID_OK:
1299        array.update(saveArray)
1300        dlg.Destroy()
1301        return
1302    dlg.Destroy()
1303
1304    copyList = []
1305    lbl = copyopts['currentsel']
1306    dlg = G2MultiChoiceDialog(
1307        G2frame.dataFrame, 
1308        'Copy parameter '+lbl+' from\n'+hst,
1309        'Copy parameters', histList)
1310    dlg.CenterOnParent()
1311    try:
1312        if dlg.ShowModal() == wx.ID_OK:
1313            for i in dlg.GetSelections(): 
1314                copyList.append(histList[i])
1315        else:
1316            # reset the parameter since cancel was pressed
1317            array.update(saveArray)
1318            return
1319    finally:
1320        dlg.Destroy()
1321
1322    prelbl = [hst]
1323    i = labelLst.index(lbl)
1324    keyLst = elemKeysLst[i]
1325    refkeys = refFlgElem[i]
1326    dictlst = [unkey(array,keyLst[:-1])]
1327    if refkeys is not None:
1328        refdictlst = [unkey(array,refkeys[:-1])]
1329    else:
1330        refdictlst = None
1331    Id = GetPatternTreeItemId(G2frame,G2frame.root,hst)
1332    hstData = G2frame.PatternTree.GetItemPyData(GetPatternTreeItemId(G2frame,Id,'Instrument Parameters'))[0]
1333    for h in copyList:
1334        Id = GetPatternTreeItemId(G2frame,G2frame.root,h)
1335        instData = G2frame.PatternTree.GetItemPyData(GetPatternTreeItemId(G2frame,Id,'Instrument Parameters'))[0]
1336        if len(hstData) != len(instData) or hstData['Type'][0] != instData['Type'][0]:  #don't mix data types or lam & lam1/lam2 parms!
1337            print h+' not copied - instrument parameters not commensurate'
1338            continue
1339        hData = G2frame.PatternTree.GetItemPyData(GetPatternTreeItemId(G2frame,Id,TreeItemType))
1340        if TreeItemType == 'Instrument Parameters':
1341            hData = hData[0]
1342        #copy the value if it is changed or we will not edit in a table
1343        valNow = unkey(array,keyLst)
1344        if copyopts['startvalue'] != valNow or not copyopts['InTable']:
1345            unkey(hData,keyLst[:-1])[keyLst[-1]] = valNow
1346        prelbl += [h]
1347        dictlst += [unkey(hData,keyLst[:-1])]
1348        if refdictlst is not None:
1349            refdictlst += [unkey(hData,refkeys[:-1])]
1350    if refdictlst is None:
1351        args = {}
1352    else:
1353        args = {'checkdictlst':refdictlst,
1354                'checkelemlst':len(dictlst)*[refkeys[-1]],
1355                'checklabel':'Refine?'}
1356    if copyopts['InTable']:
1357        dlg = ScrolledMultiEditor(
1358            G2frame.dataDisplay,dictlst,
1359            len(dictlst)*[keyLst[-1]],prelbl,
1360            header='Editing parameter '+lbl,
1361            CopyButton=True,**args)
1362        dlg.CenterOnParent()
1363        if dlg.ShowModal() != wx.ID_OK:
1364            array.update(saveArray)
1365        dlg.Destroy()
1366
1367################################################################################
1368#### Single choice Dialog with filter options
1369################################################################################
1370class G2SingleChoiceDialog(wx.Dialog):
1371    '''A dialog similar to wx.SingleChoiceDialog except that a filter can be
1372    added.
1373
1374    :param wx.Frame ParentFrame: reference to parent frame
1375    :param str title: heading above list of choices
1376    :param str header: Title to place on window frame
1377    :param list ChoiceList: a list of choices where one will be selected
1378    :param bool monoFont: If False (default), use a variable-spaced font;
1379      if True use a equally-spaced font.
1380    :param bool filterBox: If True (default) an input widget is placed on
1381      the window and only entries matching the entered text are shown.
1382    :param kw: optional keyword parameters for the wx.Dialog may
1383      be included such as size [which defaults to `(320,310)`] and
1384      style (which defaults to ``wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER | wx.CENTRE | wx.OK | wx.CANCEL``);
1385      note that ``wx.OK`` and ``wx.CANCEL`` controls
1386      the presence of the eponymous buttons in the dialog.
1387    :returns: the name of the created dialog
1388    '''
1389    def __init__(self,parent, title, header, ChoiceList, 
1390                 monoFont=False, filterBox=True, **kw):
1391        # process keyword parameters, notably style
1392        options = {'size':(320,310), # default Frame keywords
1393                   'style':wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL,
1394                   }
1395        options.update(kw)
1396        self.ChoiceList = ChoiceList
1397        self.filterlist = range(len(self.ChoiceList))
1398        if options['style'] & wx.OK:
1399            useOK = True
1400            options['style'] ^= wx.OK
1401        else:
1402            useOK = False
1403        if options['style'] & wx.CANCEL:
1404            useCANCEL = True
1405            options['style'] ^= wx.CANCEL
1406        else:
1407            useCANCEL = False       
1408        # create the dialog frame
1409        wx.Dialog.__init__(self,parent,wx.ID_ANY,header,**options)
1410        # fill the dialog
1411        Sizer = wx.BoxSizer(wx.VERTICAL)
1412        topSizer = wx.BoxSizer(wx.HORIZONTAL)
1413        topSizer.Add(
1414            wx.StaticText(self,wx.ID_ANY,title,size=(-1,35)),
1415            1,wx.ALL|wx.EXPAND|WACV,1)
1416        if filterBox:
1417            self.timer = wx.Timer()
1418            self.timer.Bind(wx.EVT_TIMER,self.Filter)
1419            topSizer.Add(wx.StaticText(self,wx.ID_ANY,'Filter: '),0,wx.ALL,1)
1420            self.filterBox = wx.TextCtrl(self, wx.ID_ANY, size=(80,-1),
1421                                         style=wx.TE_PROCESS_ENTER)
1422            self.filterBox.Bind(wx.EVT_CHAR,self.onChar)
1423            self.filterBox.Bind(wx.EVT_TEXT_ENTER,self.Filter)
1424        topSizer.Add(self.filterBox,0,wx.ALL,0)
1425        Sizer.Add(topSizer,0,wx.ALL|wx.EXPAND,8)
1426        self.clb = wx.ListBox(self, wx.ID_ANY, (30,30), wx.DefaultSize, ChoiceList)
1427        self.clb.Bind(wx.EVT_LEFT_DCLICK,self.onDoubleClick)
1428        if monoFont:
1429            font1 = wx.Font(self.clb.GetFont().GetPointSize(),
1430                            wx.MODERN, wx.NORMAL, wx.NORMAL, False)
1431            self.clb.SetFont(font1)
1432        Sizer.Add(self.clb,1,wx.LEFT|wx.RIGHT|wx.EXPAND,10)
1433        Sizer.Add((-1,10))
1434        # OK/Cancel buttons
1435        btnsizer = wx.StdDialogButtonSizer()
1436        if useOK:
1437            self.OKbtn = wx.Button(self, wx.ID_OK)
1438            self.OKbtn.SetDefault()
1439            btnsizer.AddButton(self.OKbtn)
1440        if useCANCEL:
1441            btn = wx.Button(self, wx.ID_CANCEL)
1442            btnsizer.AddButton(btn)
1443        btnsizer.Realize()
1444        Sizer.Add((-1,5))
1445        Sizer.Add(btnsizer,0,wx.ALIGN_RIGHT,50)
1446        Sizer.Add((-1,20))
1447        # OK done, let's get outa here
1448        self.SetSizer(Sizer)
1449    def GetSelection(self):
1450        'Returns the index of the selected choice'
1451        i = self.clb.GetSelection()
1452        if i < 0 or i >= len(self.filterlist):
1453            return wx.NOT_FOUND
1454        return self.filterlist[i]
1455    def onChar(self,event):
1456        self.OKbtn.Enable(False)
1457        if self.timer.IsRunning():
1458            self.timer.Stop()
1459        self.timer.Start(1000,oneShot=True)
1460        event.Skip()
1461    def Filter(self,event):
1462        if self.timer.IsRunning():
1463            self.timer.Stop()
1464        txt = self.filterBox.GetValue()
1465        self.clb.Clear()
1466        self.Update()
1467        self.filterlist = []
1468        if txt:
1469            txt = txt.lower()
1470            ChoiceList = []
1471            for i,item in enumerate(self.ChoiceList):
1472                if item.lower().find(txt) != -1:
1473                    ChoiceList.append(item)
1474                    self.filterlist.append(i)
1475        else:
1476            self.filterlist = range(len(self.ChoiceList))
1477            ChoiceList = self.ChoiceList
1478        self.clb.AppendItems(ChoiceList)
1479        self.OKbtn.Enable(True)
1480    def onDoubleClick(self,event):
1481        self.EndModal(wx.ID_OK)
1482
1483################################################################################
1484#### Custom checkbox that saves values into dict/list as used
1485################################################################################
1486class G2CheckBox(wx.CheckBox):
1487    '''A customized version of a CheckBox that automatically initializes
1488    the control to a supplied list or dict entry and updates that
1489    entry as the widget is used.
1490
1491    :param wx.Panel parent: name of panel or frame that will be
1492      the parent to the widget. Can be None.
1493    :param str label: text to put on check button
1494    :param dict/list loc: the dict or list with the initial value to be
1495      placed in the CheckBox.
1496    :param int/str key: the dict key or the list index for the value to be
1497      edited by the CheckBox. The ``loc[key]`` element must exist.
1498      The CheckBox will be initialized from this value.
1499      If the value is anything other that True (or 1), it will be taken as
1500      False.
1501    '''
1502    def __init__(self,parent,label,loc,key):
1503        wx.CheckBox.__init__(self,parent,id=wx.ID_ANY,label=label)
1504        self.loc = loc
1505        self.key = key
1506        self.SetValue(self.loc[self.key]==True)
1507        self.Bind(wx.EVT_CHECKBOX, self._OnCheckBox)
1508    def _OnCheckBox(self,event):
1509        self.loc[self.key] = self.GetValue()
1510        log.LogVarChange(self.loc,self.key)
1511
1512################################################################################
1513####
1514################################################################################
1515class PickTwoDialog(wx.Dialog):
1516    '''This does not seem to be in use
1517    '''
1518    def __init__(self,parent,title,prompt,names,choices):
1519        wx.Dialog.__init__(self,parent,-1,title, 
1520            pos=wx.DefaultPosition,style=wx.DEFAULT_DIALOG_STYLE)
1521        self.panel = wx.Panel(self)         #just a dummy - gets destroyed in Draw!
1522        self.prompt = prompt
1523        self.choices = choices
1524        self.names = names
1525        self.Draw()
1526
1527    def Draw(self):
1528        Indx = {}
1529       
1530        def OnSelection(event):
1531            Obj = event.GetEventObject()
1532            id = Indx[Obj.GetId()]
1533            self.choices[id] = Obj.GetValue().encode()  #to avoid Unicode versions
1534            self.Draw()
1535           
1536        self.panel.DestroyChildren()
1537        self.panel.Destroy()
1538        self.panel = wx.Panel(self)
1539        mainSizer = wx.BoxSizer(wx.VERTICAL)
1540        mainSizer.Add(wx.StaticText(self.panel,-1,self.prompt),0,wx.ALIGN_CENTER)
1541        for isel,name in enumerate(self.choices):
1542            lineSizer = wx.BoxSizer(wx.HORIZONTAL)
1543            lineSizer.Add(wx.StaticText(self.panel,-1,'Reference atom '+str(isel+1)),0,wx.ALIGN_CENTER)
1544            nameList = self.names[:]
1545            if isel:
1546                if self.choices[0] in nameList:
1547                    nameList.remove(self.choices[0])
1548            choice = wx.ComboBox(self.panel,-1,value=name,choices=nameList,
1549                style=wx.CB_READONLY|wx.CB_DROPDOWN)
1550            Indx[choice.GetId()] = isel
1551            choice.Bind(wx.EVT_COMBOBOX, OnSelection)
1552            lineSizer.Add(choice,0,WACV)
1553            mainSizer.Add(lineSizer)
1554        OkBtn = wx.Button(self.panel,-1,"Ok")
1555        OkBtn.Bind(wx.EVT_BUTTON, self.OnOk)
1556        CancelBtn = wx.Button(self.panel,-1,'Cancel')
1557        CancelBtn.Bind(wx.EVT_BUTTON, self.OnCancel)
1558        btnSizer = wx.BoxSizer(wx.HORIZONTAL)
1559        btnSizer.Add((20,20),1)
1560        btnSizer.Add(OkBtn)
1561        btnSizer.Add(CancelBtn)
1562        btnSizer.Add((20,20),1)
1563        mainSizer.Add(btnSizer,0,wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
1564        self.panel.SetSizer(mainSizer)
1565        self.panel.Fit()
1566        self.Fit()
1567       
1568    def GetSelection(self):
1569        return self.choices
1570
1571    def OnOk(self,event):
1572        parent = self.GetParent()
1573        parent.Raise()
1574        self.EndModal(wx.ID_OK)             
1575       
1576    def OnCancel(self,event):
1577        parent = self.GetParent()
1578        parent.Raise()
1579        self.EndModal(wx.ID_CANCEL)
1580
1581################################################################################
1582#### Column-order selection
1583################################################################################
1584
1585def GetItemOrder(parent,keylist,vallookup,posdict):
1586    '''Creates a panel where items can be ordered into columns
1587   
1588    :param list keylist: is a list of keys for column assignments
1589    :param dict vallookup: is a dict keyed by names in keylist where each item is a dict.
1590       Each inner dict contains variable names as keys and their associated values
1591    :param dict posdict: is a dict keyed by names in keylist where each item is a dict.
1592       Each inner dict contains column numbers as keys and their associated
1593       variable name as a value. This is used for both input and output.
1594       
1595    '''
1596    dlg = wx.Dialog(parent,style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
1597    sizer = wx.BoxSizer(wx.VERTICAL)
1598    spanel = OrderBox(dlg,keylist,vallookup,posdict)
1599    spanel.Fit()
1600    sizer.Add(spanel,1,wx.EXPAND)
1601    btnsizer = wx.StdDialogButtonSizer()
1602    btn = wx.Button(dlg, wx.ID_OK)
1603    btn.SetDefault()
1604    btnsizer.AddButton(btn)
1605    #btn = wx.Button(dlg, wx.ID_CANCEL)
1606    #btnsizer.AddButton(btn)
1607    btnsizer.Realize()
1608    sizer.Add(btnsizer, 0, wx.ALIGN_CENTER_VERTICAL|wx.EXPAND|wx.ALL, 5)
1609    dlg.SetSizer(sizer)
1610    sizer.Fit(dlg)
1611    val = dlg.ShowModal()
1612
1613################################################################################
1614####
1615################################################################################
1616class OrderBox(wxscroll.ScrolledPanel):
1617    '''Creates a panel with scrollbars where items can be ordered into columns
1618   
1619    :param list keylist: is a list of keys for column assignments
1620    :param dict vallookup: is a dict keyed by names in keylist where each item is a dict.
1621      Each inner dict contains variable names as keys and their associated values
1622    :param dict posdict: is a dict keyed by names in keylist where each item is a dict.
1623      Each inner dict contains column numbers as keys and their associated
1624      variable name as a value. This is used for both input and output.
1625     
1626    '''
1627    def __init__(self,parent,keylist,vallookup,posdict,*arg,**kw):
1628        self.keylist = keylist
1629        self.vallookup = vallookup
1630        self.posdict = posdict
1631        self.maxcol = 0
1632        for nam in keylist:
1633            posdict = self.posdict[nam]
1634            if posdict.keys():
1635                self.maxcol = max(self.maxcol, max(posdict))
1636        wxscroll.ScrolledPanel.__init__(self,parent,wx.ID_ANY,*arg,**kw)
1637        self.GBsizer = wx.GridBagSizer(4,4)
1638        self.SetBackgroundColour(WHITE)
1639        self.SetSizer(self.GBsizer)
1640        colList = [str(i) for i in range(self.maxcol+2)]
1641        for i in range(self.maxcol+1):
1642            wid = wx.StaticText(self,wx.ID_ANY,str(i),style=wx.ALIGN_CENTER)
1643            wid.SetBackgroundColour(DULL_YELLOW)
1644            wid.SetMinSize((50,-1))
1645            self.GBsizer.Add(wid,(0,i),flag=wx.ALIGN_CENTER|wx.EXPAND)
1646        self.chceDict = {}
1647        for row,nam in enumerate(self.keylist):
1648            posdict = self.posdict[nam]
1649            for col in posdict:
1650                lbl = posdict[col]
1651                pnl = wx.Panel(self,wx.ID_ANY)
1652                pnl.SetBackgroundColour(VERY_LIGHT_GREY)
1653                insize = wx.BoxSizer(wx.VERTICAL)
1654                wid = wx.Choice(pnl,wx.ID_ANY,choices=colList)
1655                insize.Add(wid,0,wx.EXPAND|wx.BOTTOM,3)
1656                wid.SetSelection(col)
1657                self.chceDict[wid] = (row,col)
1658                wid.Bind(wx.EVT_CHOICE,self.OnChoice)
1659                wid = wx.StaticText(pnl,wx.ID_ANY,lbl)
1660                insize.Add(wid,0,flag=wx.EXPAND)
1661                val = G2py3.FormatSigFigs(self.vallookup[nam][lbl],maxdigits=8)
1662                wid = wx.StaticText(pnl,wx.ID_ANY,'('+val+')')
1663                insize.Add(wid,0,flag=wx.EXPAND)
1664                pnl.SetSizer(insize)
1665                self.GBsizer.Add(pnl,(row+1,col),flag=wx.EXPAND)
1666        self.SetAutoLayout(1)
1667        self.SetupScrolling()
1668        self.SetMinSize((
1669            min(700,self.GBsizer.GetSize()[0]),
1670            self.GBsizer.GetSize()[1]+20))
1671    def OnChoice(self,event):
1672        '''Called when a column is assigned to a variable
1673        '''
1674        row,col = self.chceDict[event.EventObject] # which variable was this?
1675        newcol = event.Selection # where will it be moved?
1676        if newcol == col:
1677            return # no change: nothing to do!
1678        prevmaxcol = self.maxcol # save current table size
1679        key = self.keylist[row] # get the key for the current row
1680        lbl = self.posdict[key][col] # selected variable name
1681        lbl1 = self.posdict[key].get(col+1,'') # next variable name, if any
1682        # if a posXXX variable is selected, and the next variable is posXXX, move them together
1683        repeat = 1
1684        if lbl[:3] == 'pos' and lbl1[:3] == 'int' and lbl[3:] == lbl1[3:]:
1685            repeat = 2
1686        for i in range(repeat): # process the posXXX and then the intXXX (or a single variable)
1687            col += i
1688            newcol += i
1689            if newcol in self.posdict[key]:
1690                # find first non-blank after newcol
1691                for mtcol in range(newcol+1,self.maxcol+2):
1692                    if mtcol not in self.posdict[key]: break
1693                l1 = range(mtcol,newcol,-1)+[newcol]
1694                l = range(mtcol-1,newcol-1,-1)+[col]
1695            else:
1696                l1 = [newcol]
1697                l = [col]
1698            # move all of the items, starting from the last column
1699            for newcol,col in zip(l1,l):
1700                #print 'moving',col,'to',newcol
1701                self.posdict[key][newcol] = self.posdict[key][col]
1702                del self.posdict[key][col]
1703                self.maxcol = max(self.maxcol,newcol)
1704                obj = self.GBsizer.FindItemAtPosition((row+1,col))
1705                self.GBsizer.SetItemPosition(obj.GetWindow(),(row+1,newcol))
1706                for wid in obj.GetWindow().Children:
1707                    if wid in self.chceDict:
1708                        self.chceDict[wid] = (row,newcol)
1709                        wid.SetSelection(self.chceDict[wid][1])
1710        # has the table gotten larger? If so we need new column heading(s)
1711        if prevmaxcol != self.maxcol:
1712            for i in range(prevmaxcol+1,self.maxcol+1):
1713                wid = wx.StaticText(self,wx.ID_ANY,str(i),style=wx.ALIGN_CENTER)
1714                wid.SetBackgroundColour(DULL_YELLOW)
1715                wid.SetMinSize((50,-1))
1716                self.GBsizer.Add(wid,(0,i),flag=wx.ALIGN_CENTER|wx.EXPAND)
1717            colList = [str(i) for i in range(self.maxcol+2)]
1718            for wid in self.chceDict:
1719                wid.SetItems(colList)
1720                wid.SetSelection(self.chceDict[wid][1])
1721        self.GBsizer.Layout()
1722        self.FitInside()
1723
1724################################################################################
1725#### Help support routines
1726################################################################################
1727################################################################################
1728class MyHelp(wx.Menu):
1729    '''
1730    A class that creates the contents of a help menu.
1731    The menu will start with two entries:
1732
1733    * 'Help on <helpType>': where helpType is a reference to an HTML page to
1734      be opened
1735    * About: opens an About dialog using OnHelpAbout. N.B. on the Mac this
1736      gets moved to the App menu to be consistent with Apple style.
1737
1738    NOTE: for this to work properly with respect to system menus, the title
1739    for the menu must be &Help, or it will not be processed properly:
1740
1741    ::
1742
1743       menu.Append(menu=MyHelp(self,...),title="&Help")
1744
1745    '''
1746    def __init__(self,frame,helpType=None,helpLbl=None,morehelpitems=[],title=''):
1747        wx.Menu.__init__(self,title)
1748        self.HelpById = {}
1749        self.frame = frame
1750        self.Append(help='', id=wx.ID_ABOUT, kind=wx.ITEM_NORMAL,
1751            text='&About GSAS-II')
1752        frame.Bind(wx.EVT_MENU, self.OnHelpAbout, id=wx.ID_ABOUT)
1753        if GSASIIpath.whichsvn():
1754            helpobj = self.Append(
1755                help='', id=wx.ID_ANY, kind=wx.ITEM_NORMAL,
1756                text='&Check for updates')
1757            frame.Bind(wx.EVT_MENU, self.OnCheckUpdates, helpobj)
1758            helpobj = self.Append(
1759                help='', id=wx.ID_ANY, kind=wx.ITEM_NORMAL,
1760                text='&Regress to an old GSAS-II version')
1761            frame.Bind(wx.EVT_MENU, self.OnSelectVersion, helpobj)
1762        for lbl,indx in morehelpitems:
1763            helpobj = self.Append(text=lbl,
1764                id=wx.ID_ANY, kind=wx.ITEM_NORMAL)
1765            frame.Bind(wx.EVT_MENU, self.OnHelpById, helpobj)
1766            self.HelpById[helpobj.GetId()] = indx
1767        # add a help item only when helpType is specified
1768        if helpType is not None:
1769            self.AppendSeparator()
1770            if helpLbl is None: helpLbl = helpType
1771            helpobj = self.Append(text='Help on '+helpLbl,
1772                                  id=wx.ID_ANY, kind=wx.ITEM_NORMAL)
1773            frame.Bind(wx.EVT_MENU, self.OnHelpById, helpobj)
1774            self.HelpById[helpobj.GetId()] = helpType
1775       
1776    def OnHelpById(self,event):
1777        '''Called when Help on... is pressed in a menu. Brings up
1778        a web page for documentation.
1779        '''
1780        helpType = self.HelpById.get(event.GetId())
1781        if helpType is None:
1782            print 'Error: help lookup failed!',event.GetEventObject()
1783            print 'id=',event.GetId()
1784        elif helpType == 'Tutorials': 
1785            dlg = OpenTutorial(self.frame)
1786            dlg.ShowModal()
1787            dlg.Destroy()
1788            return
1789        else:
1790            ShowHelp(helpType,self.frame)
1791
1792    def OnHelpAbout(self, event):
1793        "Display an 'About GSAS-II' box"
1794        import GSASII
1795        info = wx.AboutDialogInfo()
1796        info.Name = 'GSAS-II'
1797        ver = GSASIIpath.svnGetRev()
1798        if ver: 
1799            info.Version = 'Revision '+str(ver)+' (svn), version '+GSASII.__version__
1800        else:
1801            info.Version = 'Revision '+str(GSASIIpath.GetVersionNumber())+' (.py files), version '+GSASII.__version__
1802        #info.Developers = ['Robert B. Von Dreele','Brian H. Toby']
1803        info.Copyright = ('(c) ' + time.strftime('%Y') +
1804''' Argonne National Laboratory
1805This product includes software developed
1806by the UChicago Argonne, LLC, as
1807Operator of Argonne National Laboratory.''')
1808        info.Description = '''General Structure Analysis System-II (GSAS-II)
1809Robert B. Von Dreele and Brian H. Toby
1810
1811Please cite as:
1812B.H. Toby & R.B. Von Dreele, J. Appl. Cryst. 46, 544-549 (2013) '''
1813
1814        info.WebSite = ("https://subversion.xray.aps.anl.gov/trac/pyGSAS","GSAS-II home page")
1815        wx.AboutBox(info)
1816
1817    def OnCheckUpdates(self,event):
1818        '''Check if the GSAS-II repository has an update for the current source files
1819        and perform that update if requested.
1820        '''
1821        if not GSASIIpath.whichsvn():
1822            dlg = wx.MessageDialog(self.frame,
1823                                   'No Subversion','Cannot update GSAS-II because subversion (svn) was not found.',
1824                                   wx.OK)
1825            dlg.ShowModal()
1826            dlg.Destroy()
1827            return
1828        wx.BeginBusyCursor()
1829        local = GSASIIpath.svnGetRev()
1830        if local is None: 
1831            wx.EndBusyCursor()
1832            dlg = wx.MessageDialog(self.frame,
1833                                   'Unable to run subversion on the GSAS-II current directory. Is GSAS-II installed correctly?',
1834                                   'Subversion error',
1835                                   wx.OK)
1836            dlg.ShowModal()
1837            dlg.Destroy()
1838            return
1839        print 'Installed GSAS-II version: '+local
1840        repos = GSASIIpath.svnGetRev(local=False)
1841        wx.EndBusyCursor()
1842        if repos is None: 
1843            dlg = wx.MessageDialog(self.frame,
1844                                   'Unable to access the GSAS-II server. Is this computer on the internet?',
1845                                   'Server unavailable',
1846                                   wx.OK)
1847            dlg.ShowModal()
1848            dlg.Destroy()
1849            return
1850        print 'GSAS-II version on server: '+repos
1851        if local == repos:
1852            dlg = wx.MessageDialog(self.frame,
1853                                   'GSAS-II is up-to-date. Version '+local+' is already loaded.',
1854                                   'GSAS-II Up-to-date',
1855                                   wx.OK)
1856            dlg.ShowModal()
1857            dlg.Destroy()
1858            return
1859        mods = GSASIIpath.svnFindLocalChanges()
1860        if mods:
1861            dlg = wx.MessageDialog(self.frame,
1862                                   'You have version '+local+
1863                                   ' of GSAS-II installed, but the current version is '+repos+
1864                                   '. However, '+str(len(mods))+
1865                                   ' file(s) on your local computer have been modified.'
1866                                   ' Updating will attempt to merge your local changes with '
1867                                   'the latest GSAS-II version, but if '
1868                                   'conflicts arise, local changes will be '
1869                                   'discarded. It is also possible that the '
1870                                   'local changes my prevent GSAS-II from running. '
1871                                   'Press OK to start an update if this is acceptable:',
1872                                   'Local GSAS-II Mods',
1873                                   wx.OK|wx.CANCEL)
1874            if dlg.ShowModal() != wx.ID_OK:
1875                dlg.Destroy()
1876                return
1877            else:
1878                dlg.Destroy()
1879        else:
1880            dlg = wx.MessageDialog(self.frame,
1881                                   'You have version '+local+
1882                                   ' of GSAS-II installed, but the current version is '+repos+
1883                                   '. Press OK to start an update:',
1884                                   'GSAS-II Updates',
1885                                   wx.OK|wx.CANCEL)
1886            if dlg.ShowModal() != wx.ID_OK:
1887                dlg.Destroy()
1888                return
1889            dlg.Destroy()
1890        print 'start updates'
1891        dlg = wx.MessageDialog(self.frame,
1892                               'Your project will now be saved, GSAS-II will exit and an update '
1893                               'will be performed and GSAS-II will restart. Press Cancel to '
1894                               'abort the update',
1895                               'Start update?',
1896                               wx.OK|wx.CANCEL)
1897        if dlg.ShowModal() != wx.ID_OK:
1898            dlg.Destroy()
1899            return
1900        dlg.Destroy()
1901        self.frame.OnFileSave(event)
1902        GSASIIpath.svnUpdateProcess(projectfile=self.frame.GSASprojectfile)
1903        return
1904
1905    def OnSelectVersion(self,event):
1906        '''Allow the user to select a specific version of GSAS-II
1907        '''
1908        if not GSASIIpath.whichsvn():
1909            dlg = wx.MessageDialog(self,'No Subversion','Cannot update GSAS-II because subversion (svn) '+
1910                                   'was not found.'
1911                                   ,wx.OK)
1912            dlg.ShowModal()
1913            return
1914        local = GSASIIpath.svnGetRev()
1915        if local is None: 
1916            dlg = wx.MessageDialog(self.frame,
1917                                   'Unable to run subversion on the GSAS-II current directory. Is GSAS-II installed correctly?',
1918                                   'Subversion error',
1919                                   wx.OK)
1920            dlg.ShowModal()
1921            return
1922        mods = GSASIIpath.svnFindLocalChanges()
1923        if mods:
1924            dlg = wx.MessageDialog(self.frame,
1925                                   'You have version '+local+
1926                                   ' of GSAS-II installed'
1927                                   '. However, '+str(len(mods))+
1928                                   ' file(s) on your local computer have been modified.'
1929                                   ' Downdating will attempt to merge your local changes with '
1930                                   'the selected GSAS-II version. '
1931                                   'Downdating is not encouraged because '
1932                                   'if merging is not possible, your local changes will be '
1933                                   'discarded. It is also possible that the '
1934                                   'local changes my prevent GSAS-II from running. '
1935                                   'Press OK to continue anyway.',
1936                                   'Local GSAS-II Mods',
1937                                   wx.OK|wx.CANCEL)
1938            if dlg.ShowModal() != wx.ID_OK:
1939                dlg.Destroy()
1940                return
1941            dlg.Destroy()
1942        dlg = downdate(parent=self.frame)
1943        if dlg.ShowModal() == wx.ID_OK:
1944            ver = dlg.getVersion()
1945        else:
1946            dlg.Destroy()
1947            return
1948        dlg.Destroy()
1949        print('start regress to '+str(ver))
1950        GSASIIpath.svnUpdateProcess(
1951            projectfile=self.frame.GSASprojectfile,
1952            version=str(ver)
1953            )
1954        self.frame.OnFileSave(event)
1955        return
1956
1957################################################################################
1958class AddHelp(wx.Menu):
1959    '''For the Mac: creates an entry to the help menu of type
1960    'Help on <helpType>': where helpType is a reference to an HTML page to
1961    be opened.
1962
1963    NOTE: when appending this menu (menu.Append) be sure to set the title to
1964    '&Help' so that wx handles it correctly.
1965    '''
1966    def __init__(self,frame,helpType,helpLbl=None,title=''):
1967        wx.Menu.__init__(self,title)
1968        self.frame = frame
1969        if helpLbl is None: helpLbl = helpType
1970        # add a help item only when helpType is specified
1971        helpobj = self.Append(text='Help on '+helpLbl,
1972                              id=wx.ID_ANY, kind=wx.ITEM_NORMAL)
1973        frame.Bind(wx.EVT_MENU, self.OnHelpById, helpobj)
1974        self.HelpById = helpType
1975       
1976    def OnHelpById(self,event):
1977        '''Called when Help on... is pressed in a menu. Brings up
1978        a web page for documentation.
1979        '''
1980        ShowHelp(self.HelpById,self.frame)
1981
1982################################################################################
1983class HelpButton(wx.Button):
1984    '''Create a help button that displays help information.
1985    The text is displayed in a modal message window.
1986
1987    TODO: it might be nice if it were non-modal: e.g. it stays around until
1988    the parent is deleted or the user closes it, but this did not work for
1989    me.
1990
1991    :param parent: the panel which will be the parent of the button
1992    :param str msg: the help text to be displayed
1993    '''
1994    def __init__(self,parent,msg):
1995        if sys.platform == "darwin": 
1996            wx.Button.__init__(self,parent,wx.ID_HELP)
1997        else:
1998            wx.Button.__init__(self,parent,wx.ID_ANY,'?',style=wx.BU_EXACTFIT)
1999        self.Bind(wx.EVT_BUTTON,self._onPress)
2000        self.msg=StripIndents(msg)
2001        self.parent = parent
2002    def _onClose(self,event):
2003        self.dlg.EndModal(wx.ID_CANCEL)
2004    def _onPress(self,event):
2005        'Respond to a button press by displaying the requested text'
2006        #dlg = wx.MessageDialog(self.parent,self.msg,'Help info',wx.OK)
2007        self.dlg = wx.Dialog(self.parent,wx.ID_ANY,'Help information', 
2008                        style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
2009        #self.dlg.SetBackgroundColour(wx.WHITE)
2010        mainSizer = wx.BoxSizer(wx.VERTICAL)
2011        txt = wx.StaticText(self.dlg,wx.ID_ANY,self.msg)
2012        mainSizer.Add(txt,1,wx.ALL|wx.EXPAND,10)
2013        txt.SetBackgroundColour(wx.WHITE)
2014
2015        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
2016        btn = wx.Button(self.dlg, wx.ID_CLOSE) 
2017        btn.Bind(wx.EVT_BUTTON,self._onClose)
2018        btnsizer.Add(btn)
2019        mainSizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
2020        self.dlg.SetSizer(mainSizer)
2021        mainSizer.Fit(self.dlg)
2022        self.dlg.CenterOnParent()
2023        self.dlg.ShowModal()
2024        self.dlg.Destroy()
2025################################################################################
2026class MyHtmlPanel(wx.Panel):
2027    '''Defines a panel to display HTML help information, as an alternative to
2028    displaying help information in a web browser.
2029    '''
2030    def __init__(self, frame, id):
2031        self.frame = frame
2032        wx.Panel.__init__(self, frame, id)
2033        sizer = wx.BoxSizer(wx.VERTICAL)
2034        back = wx.Button(self, -1, "Back")
2035        back.Bind(wx.EVT_BUTTON, self.OnBack)
2036        self.htmlwin = G2HtmlWindow(self, id, size=(750,450))
2037        sizer.Add(self.htmlwin, 1,wx.EXPAND)
2038        sizer.Add(back, 0, wx.ALIGN_LEFT, 0)
2039        self.SetSizer(sizer)
2040        sizer.Fit(frame)       
2041        self.Bind(wx.EVT_SIZE,self.OnHelpSize)
2042    def OnHelpSize(self,event):         #does the job but weirdly!!
2043        anchor = self.htmlwin.GetOpenedAnchor()
2044        if anchor:           
2045            self.htmlwin.ScrollToAnchor(anchor)
2046            wx.CallAfter(self.htmlwin.ScrollToAnchor,anchor)
2047            event.Skip()
2048    def OnBack(self, event):
2049        self.htmlwin.HistoryBack()
2050    def LoadFile(self,file):
2051        pos = file.rfind('#')
2052        if pos != -1:
2053            helpfile = file[:pos]
2054            helpanchor = file[pos+1:]
2055        else:
2056            helpfile = file
2057            helpanchor = None
2058        self.htmlwin.LoadPage(helpfile)
2059        if helpanchor is not None:
2060            self.htmlwin.ScrollToAnchor(helpanchor)
2061            xs,ys = self.htmlwin.GetViewStart()
2062            self.htmlwin.Scroll(xs,ys-1)
2063################################################################################
2064class G2HtmlWindow(wx.html.HtmlWindow):
2065    '''Displays help information in a primitive HTML browser type window
2066    '''
2067    def __init__(self, parent, *args, **kwargs):
2068        self.parent = parent
2069        wx.html.HtmlWindow.__init__(self, parent, *args, **kwargs)
2070    def LoadPage(self, *args, **kwargs):
2071        wx.html.HtmlWindow.LoadPage(self, *args, **kwargs)
2072        self.TitlePage()
2073    def OnLinkClicked(self, *args, **kwargs):
2074        wx.html.HtmlWindow.OnLinkClicked(self, *args, **kwargs)
2075        xs,ys = self.GetViewStart()
2076        self.Scroll(xs,ys-1)
2077        self.TitlePage()
2078    def HistoryBack(self, *args, **kwargs):
2079        wx.html.HtmlWindow.HistoryBack(self, *args, **kwargs)
2080        self.TitlePage()
2081    def TitlePage(self):
2082        self.parent.frame.SetTitle(self.GetOpenedPage() + ' -- ' + 
2083            self.GetOpenedPageTitle())
2084
2085################################################################################
2086def StripIndents(msg):
2087    'Strip indentation from multiline strings'
2088    msg1 = msg.replace('\n ','\n')
2089    while msg != msg1:
2090        msg = msg1
2091        msg1 = msg.replace('\n ','\n')
2092    return msg.replace('\n\t','\n')
2093
2094def G2MessageBox(parent,msg,title='Error'):
2095    '''Simple code to display a error or warning message
2096    '''
2097    dlg = wx.MessageDialog(parent,StripIndents(msg), title, wx.OK)
2098    dlg.ShowModal()
2099    dlg.Destroy()
2100       
2101################################################################################
2102class downdate(wx.Dialog):
2103    '''Dialog to allow a user to select a version of GSAS-II to install
2104    '''
2105    def __init__(self,parent=None):
2106        style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER
2107        wx.Dialog.__init__(self, parent, wx.ID_ANY, 'Select Version', style=style)
2108        pnl = wx.Panel(self)
2109        sizer = wx.BoxSizer(wx.VERTICAL)
2110        insver = GSASIIpath.svnGetRev(local=True)
2111        curver = int(GSASIIpath.svnGetRev(local=False))
2112        label = wx.StaticText(
2113            pnl,  wx.ID_ANY,
2114            'Select a specific GSAS-II version to install'
2115            )
2116        sizer.Add(label, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
2117        sizer1 = wx.BoxSizer(wx.HORIZONTAL)
2118        sizer1.Add(
2119            wx.StaticText(pnl,  wx.ID_ANY,
2120                          'Currently installed version: '+str(insver)),
2121            0, wx.ALIGN_CENTRE|wx.ALL, 5)
2122        sizer.Add(sizer1)
2123        sizer1 = wx.BoxSizer(wx.HORIZONTAL)
2124        sizer1.Add(
2125            wx.StaticText(pnl,  wx.ID_ANY,
2126                          'Select GSAS-II version to install: '),
2127            0, wx.ALIGN_CENTRE|wx.ALL, 5)
2128        self.spin = wx.SpinCtrl(pnl, wx.ID_ANY,size=(150,-1))
2129        self.spin.SetRange(1, curver)
2130        self.spin.SetValue(curver)
2131        self.Bind(wx.EVT_SPINCTRL, self._onSpin, self.spin)
2132        self.Bind(wx.EVT_KILL_FOCUS, self._onSpin, self.spin)
2133        sizer1.Add(self.spin)
2134        sizer.Add(sizer1)
2135
2136        line = wx.StaticLine(pnl,-1, size=(-1,3), style=wx.LI_HORIZONTAL)
2137        sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.ALL, 10)
2138
2139        self.text = wx.StaticText(pnl,  wx.ID_ANY, "")
2140        sizer.Add(self.text, 0, wx.ALIGN_LEFT|wx.EXPAND|wx.ALL, 5)
2141
2142        line = wx.StaticLine(pnl,-1, size=(-1,3), style=wx.LI_HORIZONTAL)
2143        sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.ALL, 10)
2144        sizer.Add(
2145            wx.StaticText(
2146                pnl,  wx.ID_ANY,
2147                'If "Install" is pressed, your project will be saved;\n'
2148                'GSAS-II will exit; The specified version will be loaded\n'
2149                'and GSAS-II will restart. Press "Cancel" to abort.'),
2150            0, wx.EXPAND|wx.ALL, 10)
2151        btnsizer = wx.StdDialogButtonSizer()
2152        btn = wx.Button(pnl, wx.ID_OK, "Install")
2153        btn.SetDefault()
2154        btnsizer.AddButton(btn)
2155        btn = wx.Button(pnl, wx.ID_CANCEL)
2156        btnsizer.AddButton(btn)
2157        btnsizer.Realize()
2158        sizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
2159        pnl.SetSizer(sizer)
2160        sizer.Fit(self)
2161        self.topsizer=sizer
2162        self.CenterOnParent()
2163        self._onSpin(None)
2164
2165    def _onSpin(self,event):
2166        'Called to load info about the selected version in the dialog'
2167        ver = self.spin.GetValue()
2168        d = GSASIIpath.svnGetLog(version=ver)
2169        date = d.get('date','?').split('T')[0]
2170        s = '(Version '+str(ver)+' created '+date
2171        s += ' by '+d.get('author','?')+')'
2172        msg = d.get('msg')
2173        if msg: s += '\n\nComment: '+msg
2174        self.text.SetLabel(s)
2175        self.topsizer.Fit(self)
2176
2177    def getVersion(self):
2178        'Get the version number in the dialog'
2179        return self.spin.GetValue()
2180################################################################################
2181#### Display Help information
2182################################################################################
2183# define some globals
2184htmlPanel = None
2185htmlFrame = None
2186htmlFirstUse = True
2187helpLocDict = {}
2188path2GSAS2 = os.path.dirname(os.path.realpath(__file__)) # save location of this file
2189def ShowHelp(helpType,frame):
2190    '''Called to bring up a web page for documentation.'''
2191    global htmlFirstUse
2192    # look up a definition for help info from dict
2193    helplink = helpLocDict.get(helpType)
2194    if helplink is None:
2195        # no defined link to use, create a default based on key
2196        helplink = 'gsasII.html#'+helpType.replace(' ','_')
2197    helplink = os.path.join(path2GSAS2,'help',helplink)
2198    # determine if a web browser or the internal viewer should be used for help info
2199    if GSASIIpath.GetConfigValue('Help_mode'):
2200        helpMode = GSASIIpath.GetConfigValue('Help_mode')
2201    else:
2202        helpMode = 'browser'
2203    if helpMode == 'internal':
2204        try:
2205            htmlPanel.LoadFile(helplink)
2206            htmlFrame.Raise()
2207        except:
2208            htmlFrame = wx.Frame(frame, -1, size=(610, 510))
2209            htmlFrame.Show(True)
2210            htmlFrame.SetTitle("HTML Window") # N.B. reset later in LoadFile
2211            htmlPanel = MyHtmlPanel(htmlFrame,-1)
2212            htmlPanel.LoadFile(helplink)
2213    else:
2214        pfx = "file://"
2215        if sys.platform.lower().startswith('win'):
2216            pfx = ''
2217        if htmlFirstUse:
2218            webbrowser.open_new(pfx+helplink)
2219            htmlFirstUse = False
2220        else:
2221            webbrowser.open(pfx+helplink, new=0, autoraise=True)
2222def ShowWebPage(URL,frame):
2223    '''Called to show a tutorial web page.
2224    '''
2225    global htmlFirstUse
2226    # determine if a web browser or the internal viewer should be used for help info
2227    if GSASIIpath.GetConfigValue('Help_mode'):
2228        helpMode = GSASIIpath.GetConfigValue('Help_mode')
2229    else:
2230        helpMode = 'browser'
2231    if helpMode == 'internal':
2232        try:
2233            htmlPanel.LoadFile(URL)
2234            htmlFrame.Raise()
2235        except:
2236            htmlFrame = wx.Frame(frame, -1, size=(610, 510))
2237            htmlFrame.Show(True)
2238            htmlFrame.SetTitle("HTML Window") # N.B. reset later in LoadFile
2239            htmlPanel = MyHtmlPanel(htmlFrame,-1)
2240            htmlPanel.LoadFile(URL)
2241    else:
2242        if URL.startswith('http'): 
2243            pfx = ''
2244        elif sys.platform.lower().startswith('win'):
2245            pfx = ''
2246        else:
2247            pfx = "file://"
2248        if htmlFirstUse:
2249            webbrowser.open_new(pfx+URL)
2250            htmlFirstUse = False
2251        else:
2252            webbrowser.open(pfx+URL, new=0, autoraise=True)
2253################################################################################
2254#### Tutorials selector
2255################################################################################
2256G2BaseURL = "https://subversion.xray.aps.anl.gov/pyGSAS"
2257# N.B. tutorialCatalog is generated by routine catalog.py, which also generates the appropriate
2258# empty directories (.../MT/* .../trunk/GSASII/* *=[help,Exercises])
2259tutorialCatalog = (
2260    # tutorial dir,      exercise dir,      web page file name                                title for page
2261
2262    ['StartingGSASII', 'StartingGSASII', 'Starting GSAS.htm',
2263       'Starting GSAS-II'],
2264       
2265    ['FitPeaks', 'FitPeaks', 'Fit Peaks.htm',
2266       'Fitting individual peaks & autoindexing'],
2267       
2268    ['CWNeutron', 'CWNeutron', 'Neutron CW Powder Data.htm',
2269       'CW Neutron Powder fit for Yttrium-Iron Garnet'],
2270    ['LabData', 'LabData', 'Laboratory X.htm',
2271       'Fitting laboratory X-ray powder data for fluoroapatite'],
2272    ['CWCombined', 'CWCombined', 'Combined refinement.htm',
2273       'Combined X-ray/CW-neutron refinement of PbSO4'],
2274    ['TOF-CW Joint Refinement', 'TOF-CW Joint Refinement', 'TOF combined XN Rietveld refinement in GSAS.htm',
2275       'Combined X-ray/TOF-neutron Rietveld refinement'],
2276    ['SeqRefine', 'SeqRefine', 'SequentialTutorial.htm',
2277       'Sequential refinement of multiple datasets'],
2278    ['SeqParametric', 'SeqParametric', 'ParametricFitting.htm',
2279       'Parametric Fitting and Pseudo Variables for Sequential Fits'],
2280       
2281    ['CFjadarite', 'CFjadarite', 'Charge Flipping in GSAS.htm',
2282       'Charge Flipping structure solution for jadarite'],
2283    ['CFsucrose', 'CFsucrose', 'Charge Flipping - sucrose.htm',
2284       'Charge Flipping structure solution for sucrose'],
2285    ['TOF Charge Flipping', 'TOF Charge Flipping', 'Charge Flipping with TOF single crystal data in GSASII.htm',
2286       'Charge flipping with neutron TOF single crystal data'],
2287    ['MCsimanneal', 'MCsimanneal', 'MCSA in GSAS.htm',
2288       'Monte-Carlo simulated annealing structure'],
2289
2290    ['2DCalibration', '2DCalibration', 'Calibration of an area detector in GSAS.htm',
2291       'Calibration of an area detector'],
2292    ['2DIntegration', '2DIntegration', 'Integration of area detector data in GSAS.htm',
2293       'Integration of area detector data'],
2294    ['TOF Calibration', 'TOF Calibration', 'Calibration of a TOF powder diffractometer.htm',
2295       'Calibration of a Neutron TOF diffractometer'],
2296       
2297    ['2DStrain', '2DStrain', 'Strain fitting of 2D data in GSAS-II.htm',
2298       'Strain fitting of 2D data'],
2299       
2300    ['SAimages', 'SAimages', 'Small Angle Image Processing.htm',
2301       'Image Processing of small angle x-ray data'],
2302    ['SAfit', 'SAfit', 'Fitting Small Angle Scattering Data.htm',
2303       'Fitting small angle x-ray data (alumina powder)'],
2304    ['SAsize', 'SAsize', 'Small Angle Size Distribution.htm',
2305       'Small angle x-ray data size distribution (alumina powder)'],
2306    ['SAseqref', 'SAseqref', 'Sequential Refinement of Small Angle Scattering Data.htm',
2307       'Sequential refinement with small angle scattering data'],
2308   
2309    #['TOF Sequential Single Peak Fit', 'TOF Sequential Single Peak Fit', '', ''],
2310    #['TOF Single Crystal Refinement', 'TOF Single Crystal Refinement', '', ''],
2311    )
2312if GSASIIpath.GetConfigValue('Tutorial_location'):
2313    tutorialPath = GSASIIpath.GetConfigValue('Tutorial_location')
2314else:
2315    # pick a default directory in a logical place
2316    if sys.platform.lower().startswith('win') and os.path.exists(os.path.abspath(os.path.expanduser('~/My Documents'))):
2317        tutorialPath = os.path.abspath(os.path.expanduser('~/My Documents/G2tutorials'))
2318    else:
2319        tutorialPath = os.path.abspath(os.path.expanduser('~/G2tutorials'))
2320
2321class OpenTutorial(wx.Dialog):
2322    '''Open a tutorial, optionally copying it to the local disk. Always copy
2323    the data files locally.
2324
2325    For now tutorials will always be copied into the source code tree, but it
2326    might be better to have an option to copy them somewhere else, for people
2327    who don't have write access to the GSAS-II source code location.
2328    '''
2329    # TODO: set default input-file open location to the download location
2330    def __init__(self,parent=None):
2331        style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER
2332        wx.Dialog.__init__(self, parent, wx.ID_ANY, 'Open Tutorial', style=style)
2333        self.frame = parent
2334        pnl = wx.Panel(self)
2335        sizer = wx.BoxSizer(wx.VERTICAL)
2336        sizer1 = wx.BoxSizer(wx.HORIZONTAL)       
2337        label = wx.StaticText(
2338            pnl,  wx.ID_ANY,
2339            'Select the tutorial to be run and the mode of access'
2340            )
2341        msg = '''To save download time for GSAS-II tutorials and their
2342        sample data files are being moved out of the standard
2343        distribution. This dialog allows users to load selected
2344        tutorials to their computer.
2345
2346        Tutorials can be viewed over the internet or downloaded
2347        to this computer. The sample data can be downloaded or not,
2348        (but it is not possible to run the tutorial without the
2349        data). If no web access is available, tutorials that were
2350        previously downloaded can be viewed.
2351
2352        By default, files are downloaded into the location used
2353        for the GSAS-II distribution, but this may not be possible
2354        if the software is installed by a administrator. The
2355        download location can be changed using the "Set data
2356        location" or the "Tutorial_location" configuration option
2357        (see config_example.py).
2358        '''
2359        hlp = HelpButton(pnl,msg)
2360        sizer1.Add((-1,-1),1, wx.EXPAND, 0)
2361        sizer1.Add(label, 0, wx.ALIGN_CENTRE|wx.ALL, 0)
2362        sizer1.Add((-1,-1),1, wx.EXPAND, 0)
2363        sizer1.Add(hlp,0,wx.ALIGN_RIGHT|wx.ALL)
2364        sizer.Add(sizer1,0,wx.EXPAND|wx.ALL,0)
2365        sizer.Add((10,10))
2366        self.BrowseMode = 1
2367        choices = [
2368            'make local copy of tutorial and data, then open',
2369            'run from web (copy data locally)',
2370            'browse on web (data not loaded)', 
2371            'open from local tutorial copy',
2372        ]
2373        self.mode = wx.RadioBox(pnl,wx.ID_ANY,'access mode:',
2374                                wx.DefaultPosition, wx.DefaultSize,
2375                                choices, 1, wx.RA_SPECIFY_COLS)
2376        self.mode.SetSelection(self.BrowseMode)
2377        self.mode.Bind(wx.EVT_RADIOBOX, self.OnModeSelect)
2378        sizer.Add(self.mode,0,WACV)
2379        sizer.Add((10,10))
2380        label = wx.StaticText(pnl,  wx.ID_ANY,'Click on tutorial to be opened:')
2381        sizer.Add(label, 0, wx.ALIGN_LEFT|wx.ALL, 2)
2382        self.listbox = wx.ListBox(pnl, wx.ID_ANY, size=(450, 100), style=wx.LB_SINGLE)
2383        self.listbox.Bind(wx.EVT_LISTBOX, self.OnTutorialSelected)
2384        sizer.Add(self.listbox,1,WACV|wx.EXPAND|wx.ALL,1)
2385        sizer.Add((10,10))
2386        sizer1 = wx.BoxSizer(wx.HORIZONTAL)
2387        btn = wx.Button(pnl, wx.ID_ANY, "Set download location")
2388        btn.Bind(wx.EVT_BUTTON, self.SelectDownloadLoc)
2389        sizer1.Add(btn,0,WACV)
2390        self.dataLoc = wx.StaticText(pnl, wx.ID_ANY,tutorialPath)
2391        sizer1.Add(self.dataLoc,0,WACV)
2392        sizer.Add(sizer1)
2393        label = wx.StaticText(
2394            pnl,  wx.ID_ANY,
2395            'Tutorials and Exercise files will be downloaded to:'
2396            )
2397        sizer.Add(label, 0, wx.ALIGN_LEFT|wx.ALL, 1)
2398        self.TutorialLabel = wx.StaticText(pnl,wx.ID_ANY,'')
2399        sizer.Add(self.TutorialLabel, 0, wx.ALIGN_LEFT|wx.EXPAND, 5)
2400        self.ExerciseLabel = wx.StaticText(pnl,wx.ID_ANY,'')
2401        sizer.Add(self.ExerciseLabel, 0, wx.ALIGN_LEFT|wx.EXPAND, 5)
2402        self.ShowTutorialPath()
2403        self.OnModeSelect(None)
2404       
2405        btnsizer = wx.StdDialogButtonSizer()
2406        btn = wx.Button(pnl, wx.ID_CANCEL)
2407        btnsizer.AddButton(btn)
2408        btnsizer.Realize()
2409        sizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
2410        pnl.SetSizer(sizer)
2411        sizer.Fit(self)
2412        self.topsizer=sizer
2413        self.CenterOnParent()
2414    # def OpenOld(self,event):
2415    #     '''Open old tutorials. This is needed only until we get all the tutorials items moved
2416    #     '''
2417    #     self.EndModal(wx.ID_OK)
2418    #     ShowHelp('Tutorials',self.frame)
2419    def OnModeSelect(self,event):
2420        '''Respond when the mode is changed
2421        '''
2422        self.BrowseMode = self.mode.GetSelection()
2423        if self.BrowseMode == 3:
2424            import glob
2425            filelist = glob.glob(os.path.join(tutorialPath,'help','*','*.htm'))
2426            taillist = [os.path.split(f)[1] for f in filelist]
2427            itemlist = [tut[-1] for tut in tutorialCatalog if tut[2] in taillist]
2428        else:
2429            itemlist = [tut[-1] for tut in tutorialCatalog if tut[-1]]
2430        self.listbox.Clear()
2431        self.listbox.AppendItems(itemlist)
2432    def OnTutorialSelected(self,event):
2433        '''Respond when a tutorial is selected. Load tutorials and data locally,
2434        as needed and then display the page
2435        '''
2436        for tutdir,exedir,htmlname,title in tutorialCatalog:
2437            if title == event.GetString(): break
2438        else:
2439            raise Exception("Match to file not found")
2440        if self.BrowseMode == 0 or self.BrowseMode == 1:
2441            try: 
2442                self.ValidateTutorialDir(tutorialPath,G2BaseURL)
2443            except:
2444                G2MessageBox(self.frame,
2445            '''The selected directory is not valid.
2446           
2447            You must use a directory that you have write access
2448            to. You can reuse a directory previously used for
2449            downloads, but the help and Tutorials subdirectories
2450             must be created by this routine.
2451            ''')
2452                return
2453        #self.dataLoc.SetLabel(tutorialPath)
2454        self.EndModal(wx.ID_OK)
2455        wx.BeginBusyCursor()
2456        if self.BrowseMode == 0:
2457            # xfer data & web page locally, then open web page
2458            self.LoadTutorial(tutdir,tutorialPath,G2BaseURL)
2459            self.LoadExercise(exedir,tutorialPath,G2BaseURL)
2460            URL = os.path.join(tutorialPath,'help',tutdir,htmlname)
2461            self.frame.ImportDir = os.path.join(tutorialPath,'Exercises',exedir)
2462            ShowWebPage(URL,self.frame)
2463        elif self.BrowseMode == 1:
2464            # xfer data locally, open web page remotely
2465            self.LoadExercise(exedir,tutorialPath,G2BaseURL)
2466            URL = os.path.join(G2BaseURL,'Tutorials',tutdir,htmlname)
2467            self.frame.ImportDir = os.path.join(tutorialPath,'Exercises',exedir)
2468            ShowWebPage(URL,self.frame)
2469        elif self.BrowseMode == 2:
2470            # open web page remotely, don't worry about data
2471            URL = os.path.join(G2BaseURL,'Tutorials',tutdir,htmlname)
2472            ShowWebPage(URL,self.frame)
2473        elif self.BrowseMode == 3:
2474            # open web page that has already been transferred
2475            URL = os.path.join(tutorialPath,'help',tutdir,htmlname)
2476            self.frame.ImportDir = os.path.join(tutorialPath,'Exercises',exedir)
2477            ShowWebPage(URL,self.frame)
2478        else:
2479            wx.EndBusyCursor()
2480            raise Exception("How did this happen!")
2481        wx.EndBusyCursor()
2482    def ShowTutorialPath(self):
2483        'Show the help and exercise directory names'
2484        self.TutorialLabel.SetLabel('\t'+
2485                                    os.path.join(tutorialPath,"help") +
2486                                    ' (tutorials)')
2487        self.ExerciseLabel.SetLabel('\t'+
2488                                    os.path.join(tutorialPath,"Exercises") +
2489                                    ' (exercises)')
2490    def ValidateTutorialDir(self,fullpath=tutorialPath,baseURL=G2BaseURL):
2491        '''Load help to new directory or make sure existing directory looks correctly set up
2492        throws an exception if there is a problem.
2493        '''
2494        wx.BeginBusyCursor()
2495        wx.Yield()
2496        if os.path.exists(fullpath):
2497            if os.path.exists(os.path.join(fullpath,"help")):
2498                if not GSASIIpath.svnGetRev(os.path.join(fullpath,"help")):
2499                    print("Problem with "+fullpath+" dir help exists but is not in SVN")
2500                    wx.EndBusyCursor()
2501                    raise Exception
2502            if os.path.exists(os.path.join(fullpath,"Exercises")):
2503                if not GSASIIpath.svnGetRev(os.path.join(fullpath,"Exercises")):
2504                    print("Problem with "+fullpath+" dir Exercises exists but is not in SVN")
2505                    wx.EndBusyCursor()
2506                    raise Exception
2507            if (os.path.exists(os.path.join(fullpath,"help")) and
2508                    os.path.exists(os.path.join(fullpath,"Exercises"))):
2509                if self.BrowseMode != 3:
2510                    print('Checking for directory updates')
2511                    GSASIIpath.svnUpdateDir(os.path.join(fullpath,"help"))
2512                    GSASIIpath.svnUpdateDir(os.path.join(fullpath,"Exercises"))
2513                wx.EndBusyCursor()
2514                return True # both good
2515            elif (os.path.exists(os.path.join(fullpath,"help")) or
2516                    os.path.exists(os.path.join(fullpath,"Exercises"))):
2517                print("Problem: dir "+fullpath+" exists has either help or Exercises, not both")
2518                wx.EndBusyCursor()
2519                raise Exception
2520        if not GSASIIpath.svnInstallDir(baseURL+"/MT",fullpath):
2521            wx.EndBusyCursor()
2522            print("Problem transferring empty directory from web")
2523            raise Exception
2524        wx.EndBusyCursor()
2525        return True
2526
2527    def LoadTutorial(self,tutorialname,fullpath=tutorialPath,baseURL=G2BaseURL):
2528        'Load a Tutorial to the selected location'
2529        if GSASIIpath.svnSwitchDir("help",tutorialname,baseURL+"/Tutorials",fullpath):
2530            return True
2531        print("Problem transferring Tutorial from web")
2532        raise Exception
2533       
2534    def LoadExercise(self,tutorialname,fullpath=tutorialPath,baseURL=G2BaseURL):
2535        'Load Exercise file(s) for a Tutorial to the selected location'
2536        if GSASIIpath.svnSwitchDir("Exercises",tutorialname,baseURL+"/Exercises",fullpath):
2537            return True
2538        print ("Problem transferring Exercise from web")
2539        raise Exception
2540       
2541    def SelectDownloadLoc(self,event):
2542        '''Select a download location,
2543        Cancel resets to the default
2544        '''
2545        global tutorialPath
2546        dlg = wx.DirDialog(self, "Choose a directory for downloads:",
2547                           defaultPath=tutorialPath)#,style=wx.DD_DEFAULT_STYLE)
2548                           #)
2549        try:
2550            if dlg.ShowModal() != wx.ID_OK:
2551                return
2552            pth = dlg.GetPath()
2553        finally:
2554            dlg.Destroy()
2555
2556        if not os.path.exists(pth):
2557            try:
2558                os.makedirs(pth)
2559            except OSError:
2560                msg = 'The selected directory is not valid.\n\t'
2561                msg += pth
2562                msg += '\n\nAn attempt to create the directory failed'
2563                G2MessageBox(self.frame,msg)
2564                return
2565        try:
2566            self.ValidateTutorialDir(pth,G2BaseURL)
2567            tutorialPath = pth
2568        except:
2569            G2MessageBox(self.frame,
2570            '''Error downloading to the selected directory
2571
2572            Are you connected to the internet? If not, you can
2573            only view previously downloaded tutorials (select
2574            "open from local...")
2575           
2576            You must use a directory that you have write access
2577            to. You can reuse a directory previously used for
2578            downloads, but the help and Tutorials subdirectories
2579            must have been created by this routine.
2580            ''')
2581        self.dataLoc.SetLabel(tutorialPath)
2582        self.ShowTutorialPath()
2583        self.OnModeSelect(None)
2584   
2585if __name__ == '__main__':
2586    app = wx.PySimpleApp()
2587    GSASIIpath.InvokeDebugOpts()
2588    frm = wx.Frame(None) # create a frame
2589    frm.Show(True)
2590    #dlg = OpenTutorial(frm)
2591    #if dlg.ShowModal() == wx.ID_OK:
2592    #    print "OK"
2593    #else:
2594    #    print "Cancel"
2595    #dlg.Destroy()
2596    #import sys
2597    #sys.exit()
2598    #======================================================================
2599    # test ScrolledMultiEditor
2600    #======================================================================
2601    # Data1 = {
2602    #      'Order':1,
2603    #      'omega':'string',
2604    #      'chi':2.0,
2605    #      'phi':'',
2606    #      }
2607    # elemlst = sorted(Data1.keys())
2608    # prelbl = sorted(Data1.keys())
2609    # dictlst = len(elemlst)*[Data1,]
2610    #Data2 = [True,False,False,True]
2611    #Checkdictlst = len(Data2)*[Data2,]
2612    #Checkelemlst = range(len(Checkdictlst))
2613    # print 'before',Data1,'\n',Data2
2614    # dlg = ScrolledMultiEditor(
2615    #     frm,dictlst,elemlst,prelbl,
2616    #     checkdictlst=Checkdictlst,checkelemlst=Checkelemlst,
2617    #     checklabel="Refine?",
2618    #     header="test")
2619    # if dlg.ShowModal() == wx.ID_OK:
2620    #     print "OK"
2621    # else:
2622    #     print "Cancel"
2623    # print 'after',Data1,'\n',Data2
2624    # dlg.Destroy()
2625    Data3 = {
2626         'Order':1.0,
2627         'omega':1.1,
2628         'chi':2.0,
2629         'phi':2.3,
2630         'Order1':1.0,
2631         'omega1':1.1,
2632         'chi1':2.0,
2633         'phi1':2.3,
2634         'Order2':1.0,
2635         'omega2':1.1,
2636         'chi2':2.0,
2637         'phi2':2.3,
2638         }
2639    elemlst = sorted(Data3.keys())
2640    dictlst = len(elemlst)*[Data3,]
2641    prelbl = elemlst[:]
2642    prelbl[0]="this is a much longer label to stretch things out"
2643    Data2 = len(elemlst)*[False,]
2644    Data2[1] = Data2[3] = True
2645    Checkdictlst = len(elemlst)*[Data2,]
2646    Checkelemlst = range(len(Checkdictlst))
2647    #print 'before',Data3,'\n',Data2
2648    #print dictlst,"\n",elemlst
2649    #print Checkdictlst,"\n",Checkelemlst
2650    # dlg = ScrolledMultiEditor(
2651    #     frm,dictlst,elemlst,prelbl,
2652    #     checkdictlst=Checkdictlst,checkelemlst=Checkelemlst,
2653    #     checklabel="Refine?",
2654    #     header="test",CopyButton=True)
2655    # if dlg.ShowModal() == wx.ID_OK:
2656    #     print "OK"
2657    # else:
2658    #     print "Cancel"
2659    #print 'after',Data3,'\n',Data2
2660
2661    # Data2 = list(range(100))
2662    # elemlst += range(2,6)
2663    # postlbl += range(2,6)
2664    # dictlst += len(range(2,6))*[Data2,]
2665
2666    # prelbl = range(len(elemlst))
2667    # postlbl[1] = "a very long label for the 2nd item to force a horiz. scrollbar"
2668    # header="""This is a longer\nmultiline and perhaps silly header"""
2669    # dlg = ScrolledMultiEditor(frm,dictlst,elemlst,prelbl,postlbl,
2670    #                           header=header,CopyButton=True)
2671    # print Data1
2672    # if dlg.ShowModal() == wx.ID_OK:
2673    #     for d,k in zip(dictlst,elemlst):
2674    #         print k,d[k]
2675    # dlg.Destroy()
2676    # if CallScrolledMultiEditor(frm,dictlst,elemlst,prelbl,postlbl,
2677    #                            header=header):
2678    #     for d,k in zip(dictlst,elemlst):
2679    #         print k,d[k]
2680
2681    #======================================================================
2682    # test G2MultiChoiceDialog
2683    #======================================================================
2684    choices = []
2685    for i in range(21):
2686        choices.append("option_"+str(i))
2687    dlg = G2MultiChoiceDialog(frm, 'Sequential refinement',
2688                              'Select dataset to include',
2689                              choices)
2690    sel = range(2,11,2)
2691    dlg.SetSelections(sel)
2692    dlg.SetSelections((1,5))
2693    if dlg.ShowModal() == wx.ID_OK:
2694        for sel in dlg.GetSelections():
2695            print sel,choices[sel]
2696   
2697    #======================================================================
2698    # test wx.MultiChoiceDialog
2699    #======================================================================
2700    # dlg = wx.MultiChoiceDialog(frm, 'Sequential refinement',
2701    #                           'Select dataset to include',
2702    #                           choices)
2703    # sel = range(2,11,2)
2704    # dlg.SetSelections(sel)
2705    # dlg.SetSelections((1,5))
2706    # if dlg.ShowModal() == wx.ID_OK:
2707    #     for sel in dlg.GetSelections():
2708    #         print sel,choices[sel]
2709
2710    # pnl = wx.Panel(frm)
2711    # siz = wx.BoxSizer(wx.VERTICAL)
2712
2713    # td = {'Goni':200.,'a':1.,'calc':1./3.,'string':'s'}
2714    # for key in sorted(td):
2715    #     txt = ValidatedTxtCtrl(pnl,td,key)
2716    #     siz.Add(txt)
2717    # pnl.SetSizer(siz)
2718    # siz.Fit(frm)
2719    # app.MainLoop()
2720    # print td
Note: See TracBrowser for help on using the repository browser.