source: trunk/GSASIIctrlGUI.py @ 3683

Last change on this file since 3683 was 3683, checked in by vondreele, 3 years ago

refactor MultiDataDialog? so it can show a line of multiple choice (or bool) entries in a row
use for run k-SUBGROUPSMAG - much nicer

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Author Revision URL Id
File size: 242.2 KB
Line 
1# -*- coding: utf-8 -*-
2#GSASIIctrlGUI - Custom GSAS-II GUI controls
3########### SVN repository information ###################
4# $Date: 2018-10-18 21:25:25 +0000 (Thu, 18 Oct 2018) $
5# $Author: vondreele $
6# $Revision: 3683 $
7# $URL: trunk/GSASIIctrlGUI.py $
8# $Id: GSASIIctrlGUI.py 3683 2018-10-18 21:25:25Z vondreele $
9########### SVN repository information ###################
10'''
11*GSASIIctrlGUI: Custom GUI controls*
12---------------------------------------------
13
14A library of GUI controls for reuse throughout GSAS-II, as indexed below
15
16================================  =================================================================
17Class or function name             Description
18================================  =================================================================
19:class:`ValidatedTxtCtrl`          A text control with a built-in call back routine to set dict
20                                   or list elements. Optionally validates input as float, int or
21                                   for strings non-blank. Value is set when focus changes
22:class:`EnumSelector`              A combo box with a built-in call back routine that
23                                   automatically sets a dict or list entry.
24:class:`G2ChoiceButton`            A customized wx.Choice that automatically initializes to
25                                   the initial value and saves the choice directly into a dict
26                                   or list value. Optionally calls function when a
27                                   choice is selected
28:class:`G2CheckBox`                A customized wx.CheckBox that automatically initializes to
29                                   the initial value and saves the choice directly into a dict
30                                   or list value. Optionally calls function when a
31                                   choice is selected
32:func:`CallScrolledMultiEditor`    Routine for editing many dict- or list-contained items.
33                                   using the :class:`ScrolledMultiEditor` dialog
34:class:`ScrolledMultiEditor`       wx.Dialog for editing many dict- or list-contained items.
35                                   with validation. Results are placed in dict or list.
36:class:`G2MultiChoiceDialog`       Dialog similar to wx.MultiChoiceDialog, but provides
37                                   a filter to select choices and buttons to make selection
38                                   of multiple items more simple.
39:class:`G2SingleChoiceDialog`      Dialog similar to wx.SingleChoiceDialog, but provides
40                                   a filter to help search through choices.
41:class:`FlagSetDialog`             Dialog that provides a table of items along with a
42                                   checkbox for each.
43:class:`SingleFloatDialog`         Dialog to obtain a single float value from user, with
44                                   optional range validation.
45:class:`MultiDataDialog`           Dialog to obtain multiple data values from user,
46                                   with optional range validation; items can be float, str or bool
47:class:`SingleStringDialog`        Dialog to obtain a single string value from user,
48                                   with optional an optional default value.
49:class:`MultiStringDialog`         Dialog to obtain multiple string values from user,
50                                   with a description for each value and optional
51                                   defaults.
52:class:`SingleIntDialog`           Dialog to obtain a single integer value from user,
53                                   with optional range validation.
54:class:`MultiIntegerDialog`        Dialog to obtain multiple integer values from user,
55                                   with a description for each value and optional
56                                   defaults.
57:class:`MultiColumnSelection`      A dialog that builds a multicolumn table, word wrapping
58                                   is used for the 2nd, 3rd,... columns.
59:class:`G2ColumnIDDialog`          A dialog for matching column data to desired items; some
60                                   columns may be ignored.
61:class:`G2HistoDataDialog`         A dialog for global edits to histogram data globally
62:class:`OrderBox`                  Creates a wx.Panel with scrollbars where items can be
63                                   ordered into columns.
64:class:`HelpButton`                Creates a button labeled with a "?" that when pressed
65                                   displays help text in a modal message window.
66:func:`G2MessageBox`               Displays text typically used for errors or warnings.
67:func:`HorizontalLine`             Places a line in a Frame or Dialog to separate sections.
68:func:`SelectEdit1Var`             Select a variable from a list, then edit it and select
69                                   histograms to copy it to.
70:func:`ItemSelector`               Select a single item or multiple items from list of choices.
71                                   Creates and then destroys a wx.Dialog and returns the
72                                   selections(s).
73:func:`GetItemOrder`               Creates a dialog for ordering items into columns
74:func:`GetImportFile`              Gets one ore more file from the appropriate import
75                                   directory, which can be overridden. Arguments follow those
76                                   of :func:`wx.FileDialog`
77:func:`Define_wxId`                Create a unique wx.Id symbol that is global to this
78                                   module (:mod:`GSASIIctrlGUI`). Such symbols are needed
79                                   when the menu item is defined in a different location
80                                   from the wx.Bind that links the menu item to a function.
81                                   This function allows menu Ids to be
82                                   defined where they are first used rather than be placed
83                                   yet a third location somewhere in this module.
84:func:`askSaveFile`                Get a file name from user
85:func:`askSaveDirectory`           Get a directory name from user
86================================  =================================================================
87
88Other miscellaneous routines that may be of use:
89
90================================  =================================================================
91Function name                      Description
92================================  =================================================================
93:func:`StripIndents`               Regularizes the intentation from a string with multiple
94                                   newline characters by removing spaces at the beginning
95                                   of each line.
96:func:`StripUnicode`               Removes unicode characters from strings
97:func:`GetImportPath`              Determines the default location to use for importing files.
98                                   Tries sequentially :attr:`G2frame.TutorialImportDir`,
99                                   config var ``Import_directory`` and
100                                   :attr:`G2frame.LastImportDir`.
101:func:`GetExportPath`              Determines the default location to use for writing files.
102                                   Tries sequentially :attr:`G2frame.LastExportDir` and
103                                   :attr:`G2frame.LastGPXdir`
104================================  =================================================================
105
106Documentation for all the routines in module :mod:`GSASIIctrlGUI`.
107
108'''
109from __future__ import division, print_function
110import os
111import sys
112import platform
113try:
114    import wx
115    import wx.grid as wg
116    # import wx.wizard as wz
117    import wx.aui
118    import wx.lib.scrolledpanel as wxscroll
119    import wx.html        # could postpone this for quicker startup
120    import matplotlib as mpl
121except ImportError:
122    raise
123    # Dumm 'wx' so this file can be imported
124    vals = ('TreeCtrl TextCtrl PyValidator Button ComboBox Choice CheckBox'.split() +
125            'Dialog ID_ANY OPEN'.split())
126    class Placeholder(object):
127        def __init__(self, vals):
128            for val in vals:
129                setattr(self, val, object)
130        def __getattr__(self, value):
131            if value[0].isupper():
132                return object
133            return Placeholder([])
134    wx = Placeholder(vals)
135    wxscroll = Placeholder(['ScrolledPanel'])
136    if 'phoenix' in wx.version():
137        wg = Placeholder('Grid GridTableBase GridCellEditor'.split())
138    else:
139        wg = Placeholder('Grid PyGridTableBase PyGridCellEditor'.split())
140import time
141import copy
142import webbrowser     # could postpone this for quicker startup
143import numpy as np
144
145import GSASIIpath
146GSASIIpath.SetVersionNumber("$Revision: 3683 $")
147import GSASIIdataGUI as G2gd
148import GSASIIpwdGUI as G2pdG
149import GSASIIspc as G2spc
150import GSASIIpy3 as G2py3
151import GSASIIlog as log
152import GSASIIobj as G2obj
153
154
155# Define a short names for convenience
156WHITE = (255,255,255)
157DULL_YELLOW = (230,230,190)
158# Don't depend on wx, for scriptable
159try:
160    VERY_LIGHT_GREY = wx.Colour(235,235,235)
161    WACV = wx.ALIGN_CENTER_VERTICAL
162except:
163    # Don't depend on GUI
164    pass
165
166################################################################################
167#### Fixed definitions for wx Ids
168################################################################################
169def Define_wxId(*args):
170    '''routine to create unique global wx Id symbols in this module.
171    '''
172    for arg in args:
173        if GSASIIpath.GetConfigValue('debug') and not arg.startswith('wxID_'):
174            print ('DBG_Problem in name'+arg)
175        if arg in globals():
176            if GSASIIpath.GetConfigValue('debug'): print ('DBG_'+arg+'already defined')
177            continue
178        exec('global '+arg+';'+arg+' = wx.NewId()')
179
180################################################################################
181#### Tree Control
182################################################################################
183class G2TreeCtrl(wx.TreeCtrl):
184    '''Create a wrapper around the standard TreeCtrl so we can "wrap"
185    various events.
186   
187    This logs when a tree item is selected (in :meth:`onSelectionChanged`)
188
189    This also wraps lists and dicts pulled out of the tree to track where
190    they were retrieved from.
191    '''
192    #def SelectItem(self,event):
193    #    print 'Select Item'
194    #    import GSASIIobj as G2obj
195    #    G2obj.HowDidIgetHere()
196    #    wx.TreeCtrl.SelectItem(self,event)
197       
198    def __init__(self,parent=None,*args,**kwargs):
199        super(self.__class__,self).__init__(parent=parent,*args,**kwargs)
200        self.G2frame = parent.GetTopLevelParent()
201        self.root = self.AddRoot('Loaded Data: ')
202        self.SelectionChanged = None
203        self.textlist = None
204        log.LogInfo['Tree'] = self
205
206    def _getTreeItemsList(self,item):
207        '''Get the full tree hierarchy from a reference to a tree item.
208        Note that this effectively hard-codes phase and histogram names in the
209        returned list. We may want to make these names relative in the future.
210        '''
211        textlist = [self.GetItemText(item)]
212        parent = self.GetItemParent(item)
213        while parent:
214            if parent == self.root: break
215            textlist.insert(0,self.GetItemText(parent))
216            parent = self.GetItemParent(parent)
217        return textlist
218   
219    def GetItemPyData(self,id):
220        if 'phoenix' in wx.version():
221            return wx.TreeCtrl.GetItemData(self,id)
222        else:
223            return wx.TreeCtrl.GetItemPyData(self,id)
224
225    def SetItemPyData(self,id,data):
226        if 'phoenix' in wx.version():
227            return wx.TreeCtrl.SetItemData(self,id,data)
228        else:
229            return wx.TreeCtrl.SetItemPyData(self,id,data)
230
231    # def onSelectionChanged(self,event):
232    #     '''Log each press on a tree item here.
233    #     '''
234    #     if not self.G2frame.treePanel:
235    #         return
236    #     if self.SelectionChanged:
237    #         textlist = self._getTreeItemsList(event.GetItem())
238    #         if log.LogInfo['Logging'] and event.GetItem() != self.root:
239    #             textlist[0] = self.GetRelativeHistNum(textlist[0])
240    #             if textlist[0] == "Phases" and len(textlist) > 1:
241    #                 textlist[1] = self.GetRelativePhaseNum(textlist[1])
242    #             log.MakeTreeLog(textlist)
243    #         if textlist == self.textlist:
244    #             return      #same as last time - don't get it again
245    #         self.textlist = textlist
246    #         self.SelectionChanged(event)
247
248    # def Bind(self,eventtype,handler,*args,**kwargs):
249    #     '''Override the Bind() function so that page change events can be trapped
250    #     '''
251    #     if eventtype == wx.EVT_TREE_SEL_CHANGED:
252    #         self.SelectionChanged = handler
253    #         wx.TreeCtrl.Bind(self,eventtype,self.onSelectionChanged)
254    #         return
255    #     wx.TreeCtrl.Bind(self,eventtype,handler,*args,**kwargs)
256
257    # commented out, disables Logging
258    # def GetItemPyData(self,*args,**kwargs):
259    #    '''Override the standard method to wrap the contents
260    #    so that the source can be logged when changed
261    #    '''
262    #    data = super(self.__class__,self).GetItemPyData(*args,**kwargs)
263    #    textlist = self._getTreeItemsList(args[0])
264    #    if type(data) is dict:
265    #        return log.dictLogged(data,textlist)
266    #    if type(data) is list:
267    #        return log.listLogged(data,textlist)
268    #    if type(data) is tuple: #N.B. tuples get converted to lists
269    #        return log.listLogged(list(data),textlist)
270    #    return data
271
272    def GetRelativeHistNum(self,histname):
273        '''Returns list with a histogram type and a relative number for that
274        histogram, or the original string if not a histogram
275        '''
276        histtype = histname.split()[0]
277        if histtype != histtype.upper(): # histograms (only) have a keyword all in caps
278            return histname
279        item, cookie = self.GetFirstChild(self.root)
280        i = 0
281        while item:
282            itemtext = self.GetItemText(item)
283            if itemtext == histname:
284                return histtype,i
285            elif itemtext.split()[0] == histtype:
286                i += 1
287            item, cookie = self.GetNextChild(self.root, cookie)
288        else:
289            raise Exception("Histogram not found: "+histname)
290
291    def ConvertRelativeHistNum(self,histtype,histnum):
292        '''Converts a histogram type and relative histogram number to a
293        histogram name in the current project
294        '''
295        item, cookie = self.GetFirstChild(self.root)
296        i = 0
297        while item:
298            itemtext = self.GetItemText(item)
299            if itemtext.split()[0] == histtype:
300                if i == histnum: return itemtext
301                i += 1
302            item, cookie = self.GetNextChild(self.root, cookie)
303        else:
304            raise Exception("Histogram #'+str(histnum)+' of type "+histtype+' not found')
305       
306    def GetRelativePhaseNum(self,phasename):
307        '''Returns a phase number if the string matches a phase name
308        or else returns the original string
309        '''
310        item, cookie = self.GetFirstChild(self.root)
311        while item:
312            itemtext = self.GetItemText(item)
313            if itemtext == "Phases":
314                parent = item
315                item, cookie = self.GetFirstChild(parent)
316                i = 0
317                while item:
318                    itemtext = self.GetItemText(item)
319                    if itemtext == phasename:
320                        return i
321                    item, cookie = self.GetNextChild(parent, cookie)
322                    i += 1
323                else:
324                    return phasename # not a phase name
325            item, cookie = self.GetNextChild(self.root, cookie)
326        else:
327            raise Exception("No phases found ")
328
329    def ConvertRelativePhaseNum(self,phasenum):
330        '''Converts relative phase number to a phase name in
331        the current project
332        '''
333        item, cookie = self.GetFirstChild(self.root)
334        while item:
335            itemtext = self.GetItemText(item)
336            if itemtext == "Phases":
337                parent = item
338                item, cookie = self.GetFirstChild(parent)
339                i = 0
340                while item:
341                    if i == phasenum:
342                        return self.GetItemText(item)
343                    item, cookie = self.GetNextChild(parent, cookie)
344                    i += 1
345                else:
346                    raise Exception("Phase "+str(phasenum)+" not found")
347            item, cookie = self.GetNextChild(self.root, cookie)
348        else:
349            raise Exception("No phases found ")
350
351    def GetImageLoc(self,TreeId):
352        '''Get Image data from the Tree. Handles cases where the
353        image name is specified, as well as where the image file name is
354        a tuple containing the image file and an image number
355        '''
356       
357        size,imagefile = self.GetItemPyData(TreeId)
358        if type(imagefile) is tuple or type(imagefile) is list:
359            return size,imagefile[0],imagefile[1]
360        else:
361            return size,imagefile,None
362
363    def UpdateImageLoc(self,TreeId,imagefile):
364        '''Saves a new imagefile name in the Tree. Handles cases where the
365        image name is specified, as well as where the image file name is
366        a tuple containing the image file and an image number
367        '''
368       
369        idata = self.GetItemPyData(TreeId)
370        if type(idata[1]) is tuple or type(idata[1]) is list:
371            idata[1] = list(idata[1])
372            idata[1][0] = [imagefile,idata[1][1]]
373        else:
374            idata[1]  = imagefile
375       
376    def SaveExposedItems(self):
377        '''Traverse the top level tree items and save names of exposed (expanded) tree items.
378        Done before a refinement.
379        '''
380        self.ExposedItems = []
381        item, cookie = self.GetFirstChild(self.root)
382        while item:
383            name = self.GetItemText(item)
384            if self.IsExpanded(item): self.ExposedItems.append(name)
385            item, cookie = self.GetNextChild(self.root, cookie)
386#        print 'exposed:',self.ExposedItems
387
388    def RestoreExposedItems(self):
389        '''Traverse the top level tree items and restore exposed (expanded) tree items
390        back to their previous state (done after a reload of the tree after a refinement)
391        '''
392        item, cookie = self.GetFirstChild(self.root)
393        while item:
394            name = self.GetItemText(item)
395            if name in self.ExposedItems: self.Expand(item)
396            item, cookie = self.GetNextChild(self.root, cookie)
397
398################################################################################
399#### TextCtrl that stores input as entered with optional validation
400################################################################################
401class ValidatedTxtCtrl(wx.TextCtrl):
402    '''Create a TextCtrl widget that uses a validator to prevent the
403    entry of inappropriate characters and changes color to highlight
404    when invalid input is supplied. As valid values are typed,
405    they are placed into the dict or list where the initial value
406    came from. The type of the initial value must be int,
407    float or str or None (see :obj:`key` and :obj:`typeHint`);
408    this type (or the one in :obj:`typeHint`) is preserved.
409
410    Float values can be entered in the TextCtrl as numbers or also
411    as algebraic expressions using operators + - / \* () and \*\*,
412    in addition pi, sind(), cosd(), tand(), and sqrt() can be used,
413    as well as appreviations s, sin, c, cos, t, tan and sq.
414
415    :param wx.Panel parent: name of panel or frame that will be
416      the parent to the TextCtrl. Can be None.
417
418    :param dict/list loc: the dict or list with the initial value to be
419      placed in the TextCtrl.
420
421    :param int/str key: the dict key or the list index for the value to be
422      edited by the TextCtrl. The ``loc[key]`` element must exist, but may
423      have value None. If None, the type for the element is taken from
424      :obj:`typeHint` and the value for the control is set initially
425      blank (and thus invalid.) This is a way to specify a field without a
426      default value: a user must set a valid value.
427       
428      If the value is not None, it must have a base
429      type of int, float, str or unicode; the TextCrtl will be initialized
430      from this value.
431     
432    :param list nDig: number of digits, places and optionally the format
433       ([nDig,nPlc,fmt]) after decimal to use for display of float. The format
434       is either 'f' (default) or 'g'. Alternately, None can be specified which
435       causes numbers to be displayed with approximately 5 significant figures
436       for floats. If this is specified, then :obj:`typeHint` = float becomes the
437       default.
438       (Default=None).
439
440    :param bool notBlank: if True (default) blank values are invalid
441      for str inputs.
442     
443    :param number min: minimum allowed valid value. If None (default) the
444      lower limit is unbounded.
445      NB: test in NumberValidator is val >= min not val > min
446
447    :param number max: maximum allowed valid value. If None (default) the
448      upper limit is unbounded
449      NB: test in NumberValidator is val <= max not val < max
450     
451    :param list exclLim: if True exclude min/max value ([exclMin,exclMax]);
452      (Default=[False,False])
453
454    :param function OKcontrol: specifies a function or method that will be
455      called when the input is validated. The called function is supplied
456      with one argument which is False if the TextCtrl contains an invalid
457      value and True if the value is valid.
458      Note that this function should check all values
459      in the dialog when True, since other entries might be invalid.
460      The default for this is None, which indicates no function should
461      be called.
462
463    :param function OnLeave: specifies a function or method that will be
464      called when the focus for the control is lost.
465      The called function is supplied with (at present) three keyword arguments:
466
467      * invalid: (*bool*) True if the value for the TextCtrl is invalid
468      * value:   (*int/float/str*)  the value contained in the TextCtrl
469      * tc:      (*wx.TextCtrl*)  the TextCtrl object
470
471      The number of keyword arguments may be increased in the future should needs arise,
472      so it is best to code these functions with a \*\*kwargs argument so they will
473      continue to run without errors
474
475      The default for OnLeave is None, which indicates no function should
476      be called.
477
478    :param type typeHint: the value of typeHint should be int, float or str (or None).
479      The value for this will override the initial type taken from value
480      for the dict/list element ``loc[key]`` if not None and thus specifies the
481      type for input to the TextCtrl.
482      Defaults as None, which is ignored, unless  :obj:`nDig` is specified in which
483      case the default is float.
484
485    :param bool CIFinput: for str input, indicates that only printable
486      ASCII characters may be entered into the TextCtrl. Forces output
487      to be ASCII rather than Unicode. For float and int input, allows
488      use of a single '?' or '.' character as valid input.
489
490    :param dict OnLeaveArgs: a dict with keyword args that are passed to
491      the :attr:`OnLeave` function. Defaults to ``{}``
492
493    :param bool ASCIIonly: if set as True will remove unicode characters from
494      strings
495
496    :param (other): other optional keyword parameters for the
497      wx.TextCtrl widget such as size or style may be specified.
498    '''
499    def __init__(self,parent,loc,key,nDig=None,notBlank=True,min=None,max=None,
500        OKcontrol=None,OnLeave=None,typeHint=None,CIFinput=False,exclLim=[False,False],
501        OnLeaveArgs={}, ASCIIonly=False, **kw):
502        # save passed values needed outside __init__
503        self.result = loc
504        self.key = key
505        self.nDig = nDig
506        self.OKcontrol=OKcontrol
507        self.OnLeave = OnLeave
508        self.OnLeaveArgs = OnLeaveArgs
509        self.CIFinput = CIFinput
510        self.notBlank = notBlank
511        self.ASCIIonly = ASCIIonly
512        self.type = str
513        # initialization
514        self.invalid = False   # indicates if the control has invalid contents
515        self.evaluated = False # set to True when the validator recognizes an expression
516        val = loc[key]
517        if 'style' in kw: # add a "Process Enter" to style
518            kw['style'] += kw['style'] | wx.TE_PROCESS_ENTER
519        else:
520            kw['style'] = wx.TE_PROCESS_ENTER
521        if typeHint is not None:
522            self.type = typeHint
523        elif nDig is not None:
524            self.type = float
525        elif 'int' in str(type(val)):
526            self.type = int
527        elif 'float' in str(type(val)):
528            self.type = float
529        elif isinstance(val,str) or isinstance(val,unicode):
530            self.type = str
531        elif val is None:
532            raise Exception("ValidatedTxtCtrl error: value of "+str(key)+
533                             " element is None and typeHint not defined as int or float")
534        else:
535            raise Exception("ValidatedTxtCtrl error: Unknown element ("+str(key)+
536                             ") type: "+str(type(val)))
537        if self.type is int:       
538            wx.TextCtrl.__init__(self,parent,wx.ID_ANY,
539                validator=NumberValidator(int,result=loc,key=key,min=min,max=max,
540                    exclLim=exclLim,OKcontrol=OKcontrol,CIFinput=CIFinput),**kw)
541            if val is not None:
542                self._setValue(val)
543            else: # no default is invalid for a number
544                self.invalid = True
545                self._IndicateValidity()
546        elif self.type is float:
547            wx.TextCtrl.__init__(self,parent,wx.ID_ANY,
548                validator=NumberValidator(float,result=loc,key=key,min=min,max=max,
549                    exclLim=exclLim,OKcontrol=OKcontrol,CIFinput=CIFinput),**kw)
550            if val is not None:
551                self._setValue(val)
552            else:
553                self.invalid = True
554                self._IndicateValidity()
555        else:
556            if self.CIFinput:
557                wx.TextCtrl.__init__(
558                    self,parent,wx.ID_ANY,
559                    validator=ASCIIValidator(result=loc,key=key),
560                    **kw)
561            else:
562                wx.TextCtrl.__init__(self,parent,wx.ID_ANY,**kw)
563            if val is not None:
564                self.SetValue(val)
565            if notBlank:
566                self.Bind(wx.EVT_CHAR,self._onStringKey)
567                self.ShowStringValidity() # test if valid input
568            else:
569                self.invalid = False
570                self.Bind(wx.EVT_CHAR,self._GetStringValue)
571       
572        # When the mouse is moved away or the widget loses focus,
573        # display the last saved value, if an expression
574        self.Bind(wx.EVT_LEAVE_WINDOW, self._onLeaveWindow)
575        self.Bind(wx.EVT_TEXT_ENTER, self._onLoseFocus)
576        self.Bind(wx.EVT_KILL_FOCUS, self._onLoseFocus)
577        # patch for wx 2.9 on Mac
578        i,j= wx.__version__.split('.')[0:2]
579        if int(i)+int(j)/10. > 2.8 and 'wxOSX' in wx.PlatformInfo:
580            self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
581
582    def SetValue(self,val):
583        if self.result is not None: # note that this bypasses formatting
584            self.result[self.key] = val
585            log.LogVarChange(self.result,self.key)
586        self._setValue(val)
587
588    def _setValue(self,val,show=True):
589        '''Check the validity of an int or float value and convert to a str.
590        Possibly format it. If show is True, display the formatted value in
591        the Text widget.
592        '''
593        self.invalid = False
594        if self.type is int:
595            try:
596                if int(val) != val:
597                    self.invalid = True
598                else:
599                    val = int(val)
600            except:
601                if self.CIFinput and (val == '?' or val == '.'):
602                    pass
603                else:
604                    self.invalid = True
605            if show and not self.invalid: wx.TextCtrl.SetValue(self,str(val))
606        elif self.type is float:
607            try:
608                val = float(val) # convert strings, if needed
609            except:
610                if self.CIFinput and (val == '?' or val == '.'):
611                    pass
612                else:
613                    self.invalid = True
614            if self.nDig and show and not self.invalid:
615                wx.TextCtrl.SetValue(self,str(G2py3.FormatValue(val,self.nDig)))
616            elif show and not self.invalid:
617                wx.TextCtrl.SetValue(self,str(G2py3.FormatSigFigs(val)).rstrip('0'))
618        else:
619            if self.ASCIIonly:
620                s = ''
621                for c in val:
622                    if ord(c) < 128: s += c
623                if val != s:
624                    val = s
625                    show = True
626            if show:
627                try:
628                    wx.TextCtrl.SetValue(self,str(val))
629                except:
630                    wx.TextCtrl.SetValue(self,val)
631            self.ShowStringValidity() # test if valid input
632            return
633       
634        self._IndicateValidity()
635        if self.OKcontrol:
636            self.OKcontrol(not self.invalid)
637
638    def OnKeyDown(self,event):
639        'Special callback for wx 2.9+ on Mac where backspace is not processed by validator'
640        key = event.GetKeyCode()
641        if key in [wx.WXK_BACK, wx.WXK_DELETE]:
642            if self.Validator: wx.CallAfter(self.Validator.TestValid,self)
643        if key == wx.WXK_RETURN or key == wx.WXK_NUMPAD_ENTER:
644            self._onLoseFocus(None)
645        if event: event.Skip()
646                   
647    def _onStringKey(self,event):
648        if event: event.Skip()
649        if self.invalid: # check for validity after processing the keystroke
650            wx.CallAfter(self.ShowStringValidity,True) # was invalid
651        else:
652            wx.CallAfter(self.ShowStringValidity,False) # was valid
653
654    def _IndicateValidity(self):
655        'Set the control colors to show invalid input'
656        if self.invalid:
657            ins = self.GetInsertionPoint()
658            self.SetForegroundColour("red")
659            self.SetBackgroundColour("yellow")
660            self.SetFocus()
661            self.Refresh() # this selects text on some Linuxes
662            self.SetSelection(0,0)   # unselect
663            self.SetInsertionPoint(ins) # put insertion point back
664        else: # valid input
665            self.SetBackgroundColour(wx.SystemSettings.GetColour(wx.SYS_COLOUR_WINDOW))
666            self.SetForegroundColour("black")
667            self.Refresh()
668
669    def ShowStringValidity(self,previousInvalid=True):
670        '''Check if input is valid. Anytime the input is
671        invalid, call self.OKcontrol (if defined) because it is fast.
672        If valid, check for any other invalid entries only when
673        changing from invalid to valid, since that is slower.
674       
675        :param bool previousInvalid: True if the TextCtrl contents were
676          invalid prior to the current change.
677         
678        '''
679        val = self.GetValue().strip()
680        if self.notBlank:
681            self.invalid = not val
682        else:
683            self.invalid = False
684        self._IndicateValidity()
685        if self.invalid:
686            if self.OKcontrol:
687                self.OKcontrol(False)
688        elif self.OKcontrol and previousInvalid:
689            self.OKcontrol(True)
690        # always store the result
691        if self.CIFinput: # for CIF make results ASCII
692            self.result[self.key] = val.encode('ascii','replace') 
693        else:
694            self.result[self.key] = val
695        log.LogVarChange(self.result,self.key)
696
697    def _GetStringValue(self,event):
698        '''Get string input and store.
699        '''
700        if event: event.Skip() # process keystroke
701        wx.CallAfter(self._SaveStringValue)
702       
703    def _SaveStringValue(self):
704        val = self.GetValue().strip()
705        # always store the result
706        if self.CIFinput: # for CIF make results ASCII
707            self.result[self.key] = val.encode('ascii','replace') 
708        else:
709            self.result[self.key] = val
710        log.LogVarChange(self.result,self.key)
711
712    def _onLeaveWindow(self,event):
713        '''If the mouse leaves the text box, save the result, if valid,
714        but (unlike _onLoseFocus) don't update the textbox contents.
715        '''
716        if not self.IsModified():   #ignore mouse crusing
717            return
718        if self.evaluated and not self.invalid: # deal with computed expressions
719            self.evaluated = False # expression has been recast as value, reset flag
720        if self.invalid: # don't update an invalid expression
721            if event: event.Skip()
722            return
723        self._setValue(self.result[self.key],show=False) # save value quietly
724        if self.OnLeave:
725            self.event = event
726            self.OnLeave(invalid=self.invalid,value=self.result[self.key],
727                tc=self,**self.OnLeaveArgs)
728        if event: event.Skip()
729           
730    def _onLoseFocus(self,event):
731        '''Enter has been pressed or focus transferred to another control,
732        Evaluate and update the current control contents
733        '''
734        if event: event.Skip()
735        if not self.IsModified():   #ignore mouse crusing
736            return
737        if self.evaluated: # deal with computed expressions
738            if self.invalid: # don't substitute for an invalid expression
739                return 
740            self.evaluated = False # expression has been recast as value, reset flag
741            self._setValue(self.result[self.key])
742        elif self.result is not None: # show formatted result, as Bob wants
743            if not self.invalid: # don't update an invalid expression
744                self._setValue(self.result[self.key])
745        if self.OnLeave:
746            self.event = event
747            self.OnLeave(invalid=self.invalid,value=self.result[self.key],
748                tc=self,**self.OnLeaveArgs)
749
750################################################################################
751class NumberValidator(wx.PyValidator):
752    '''A validator to be used with a TextCtrl to prevent
753    entering characters other than digits, signs, and for float
754    input, a period and exponents.
755   
756    The value is checked for validity after every keystroke
757      If an invalid number is entered, the box is highlighted.
758      If the number is valid, it is saved in result[key]
759
760    :param type typ: the base data type. Must be int or float.
761
762    :param bool positiveonly: If True, negative integers are not allowed
763      (default False). This prevents the + or - keys from being pressed.
764      Used with typ=int; ignored for typ=float.
765
766    :param number min: Minimum allowed value. If None (default) the
767      lower limit is unbounded
768
769    :param number max: Maximum allowed value. If None (default) the
770      upper limit is unbounded
771     
772    :param list exclLim: if True exclude min/max value ([exclMin,exclMax]);
773     (Default=[False,False])
774
775    :param dict/list result: List or dict where value should be placed when valid
776
777    :param any key: key to use for result (int for list)
778
779    :param function OKcontrol: function or class method to control
780      an OK button for a window.
781      Ignored if None (default)
782
783    :param bool CIFinput: allows use of a single '?' or '.' character
784      as valid input.
785     
786    '''
787    def __init__(self, typ, positiveonly=False, min=None, max=None,exclLim=[False,False],
788        result=None, key=None, OKcontrol=None, CIFinput=False):
789        'Create the validator'
790        if 'phoenix' in wx.version():
791            wx.Validator.__init__(self)
792        else:
793            wx.PyValidator.__init__(self)
794        # save passed parameters
795        self.typ = typ
796        self.positiveonly = positiveonly
797        self.min = min
798        self.max = max
799        self.exclLim = exclLim
800        self.result = result
801        self.key = key
802        self.OKcontrol = OKcontrol
803        self.CIFinput = CIFinput
804        # set allowed keys by data type
805        self.Bind(wx.EVT_CHAR, self.OnChar)
806        if self.typ == int and self.positiveonly:
807            self.validchars = '0123456789'
808        elif self.typ == int:
809            self.validchars = '0123456789+-'
810        elif self.typ == float:
811            # allow for above and sind, cosd, sqrt, tand, pi, and abbreviations
812            # also addition, subtraction, division, multiplication, exponentiation
813            self.validchars = '0123456789.-+eE/cosindcqrtap()*'
814        else:
815            self.validchars = None
816            return
817        if self.CIFinput:
818            self.validchars += '?.'
819    def Clone(self):
820        'Create a copy of the validator, a strange, but required component'
821        return NumberValidator(typ=self.typ, 
822                               positiveonly=self.positiveonly,
823                               min=self.min, max=self.max,
824                               result=self.result, key=self.key,
825                               OKcontrol=self.OKcontrol,
826                               CIFinput=self.CIFinput)
827    def TransferToWindow(self):
828        'Needed by validator, strange, but required component'
829        return True # Prevent wxDialog from complaining.
830    def TransferFromWindow(self):
831        'Needed by validator, strange, but required component'
832        return True # Prevent wxDialog from complaining.
833    def TestValid(self,tc):
834        '''Check if the value is valid by casting the input string
835        into the current type.
836
837        Set the invalid variable in the TextCtrl object accordingly.
838
839        If the value is valid, save it in the dict/list where
840        the initial value was stored, if appropriate.
841
842        :param wx.TextCtrl tc: A reference to the TextCtrl that the validator
843          is associated with.
844        '''
845        tc.invalid = False # assume valid
846        if self.CIFinput:
847            val = tc.GetValue().strip()
848            if val == '?' or val == '.':
849                self.result[self.key] = val
850                log.LogVarChange(self.result,self.key)
851                return
852        try:
853            val = self.typ(tc.GetValue())
854        except (ValueError, SyntaxError):
855            if self.typ is float: # for float values, see if an expression can be evaluated
856                val = G2py3.FormulaEval(tc.GetValue())
857                if val is None:
858                    tc.invalid = True
859                    return
860                else:
861                    tc.evaluated = True
862            else: 
863                tc.invalid = True
864                return
865        if self.max != None:
866            if val >= self.max and self.exclLim[1]:
867                tc.invalid = True
868            elif val > self.max:
869                tc.invalid = True
870        if self.min != None:
871            if val <= self.min and self.exclLim[0]:
872                tc.invalid = True
873            elif val < self.min:
874                tc.invalid = True  # invalid
875        if self.key is not None and self.result is not None and not tc.invalid:
876            self.result[self.key] = val
877            log.LogVarChange(self.result,self.key)
878
879    def ShowValidity(self,tc):
880        '''Set the control colors to show invalid input
881
882        :param wx.TextCtrl tc: A reference to the TextCtrl that the validator
883          is associated with.
884
885        '''
886        if tc.invalid:
887            ins = tc.GetInsertionPoint()
888            tc.SetForegroundColour("red")
889            tc.SetBackgroundColour("yellow")
890            tc.SetFocus()
891            tc.Refresh() # this selects text on some Linuxes
892            tc.SetSelection(0,0)   # unselect
893            tc.SetInsertionPoint(ins) # put insertion point back
894            return False
895        else: # valid input
896            tc.SetBackgroundColour(wx.SystemSettings.GetColour(wx.SYS_COLOUR_WINDOW))
897            tc.SetForegroundColour("black")
898            tc.Refresh()
899            return True
900
901    def CheckInput(self,previousInvalid):
902        '''called to test every change to the TextCtrl for validity and
903        to change the appearance of the TextCtrl
904
905        Anytime the input is invalid, call self.OKcontrol
906        (if defined) because it is fast.
907        If valid, check for any other invalid entries only when
908        changing from invalid to valid, since that is slower.
909
910        :param bool previousInvalid: True if the TextCtrl contents were
911          invalid prior to the current change.
912        '''
913        tc = self.GetWindow()
914        self.TestValid(tc)
915        self.ShowValidity(tc)
916        # if invalid
917        if tc.invalid and self.OKcontrol:
918            self.OKcontrol(False)
919        if not tc.invalid and self.OKcontrol and previousInvalid:
920            self.OKcontrol(True)
921
922    def OnChar(self, event):
923        '''Called each type a key is pressed
924        ignores keys that are not allowed for int and float types
925        '''
926        key = event.GetKeyCode()
927        tc = self.GetWindow()
928        if key == wx.WXK_RETURN or key == wx.WXK_NUMPAD_ENTER:
929            if tc.invalid:
930                self.CheckInput(True) 
931            else:
932                self.CheckInput(False) 
933            if event: event.Skip()
934            return
935        if key < wx.WXK_SPACE or key == wx.WXK_DELETE or key > 255: # control characters get processed
936            if event: event.Skip()
937            if tc.invalid:
938                wx.CallAfter(self.CheckInput,True) 
939            else:
940                wx.CallAfter(self.CheckInput,False) 
941            return
942        elif chr(key) in self.validchars: # valid char pressed?
943            if event: event.Skip()
944            if tc.invalid:
945                wx.CallAfter(self.CheckInput,True) 
946            else:
947                wx.CallAfter(self.CheckInput,False) 
948            return
949        return  # Returning without calling event.Skip, which eats the keystroke
950
951################################################################################
952class ASCIIValidator(wx.PyValidator):
953    '''A validator to be used with a TextCtrl to prevent
954    entering characters other than ASCII characters.
955   
956    The value is checked for validity after every keystroke
957      If an invalid number is entered, the box is highlighted.
958      If the number is valid, it is saved in result[key]
959
960    :param dict/list result: List or dict where value should be placed when valid
961
962    :param any key: key to use for result (int for list)
963
964    '''
965    def __init__(self, result=None, key=None):
966        'Create the validator'
967        import string
968        wx.PyValidator.__init__(self)
969        # save passed parameters
970        self.result = result
971        self.key = key
972        self.validchars = string.ascii_letters + string.digits + string.punctuation + string.whitespace
973        self.Bind(wx.EVT_CHAR, self.OnChar)
974    def Clone(self):
975        'Create a copy of the validator, a strange, but required component'
976        return ASCIIValidator(result=self.result, key=self.key)
977        tc = self.GetWindow()
978        tc.invalid = False # make sure the validity flag is defined in parent
979    def TransferToWindow(self):
980        'Needed by validator, strange, but required component'
981        return True # Prevent wxDialog from complaining.
982    def TransferFromWindow(self):
983        'Needed by validator, strange, but required component'
984        return True # Prevent wxDialog from complaining.
985    def TestValid(self,tc):
986        '''Check if the value is valid by casting the input string
987        into ASCII.
988
989        Save it in the dict/list where the initial value was stored
990
991        :param wx.TextCtrl tc: A reference to the TextCtrl that the validator
992          is associated with.
993        '''
994        self.result[self.key] = tc.GetValue().encode('ascii','replace')
995        log.LogVarChange(self.result,self.key)
996
997    def OnChar(self, event):
998        '''Called each type a key is pressed
999        ignores keys that are not allowed for int and float types
1000        '''
1001        key = event.GetKeyCode()
1002        tc = self.GetWindow()
1003        if key == wx.WXK_RETURN or key == wx.WXK_NUMPAD_ENTER:
1004            self.TestValid(tc)
1005            if event: event.Skip()
1006            return
1007        if key < wx.WXK_SPACE or key == wx.WXK_DELETE or key > 255: # control characters get processed
1008            if event: event.Skip()
1009            self.TestValid(tc)
1010            return
1011        elif chr(key) in self.validchars: # valid char pressed?
1012            if event: event.Skip()
1013            self.TestValid(tc)
1014            return
1015        return  # Returning without calling event.Skip, which eats the keystroke
1016
1017################################################################################
1018def HorizontalLine(sizer,parent):
1019    '''Draws a horizontal line as wide as the window.
1020    This shows up on the Mac as a very thin line, no matter what I do
1021    '''
1022    line = wx.StaticLine(parent, size=(-1,3), style=wx.LI_HORIZONTAL)
1023    sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.ALL, 5)
1024
1025################################################################################
1026class G2LoggedButton(wx.Button):
1027    '''A version of wx.Button that creates logging events. Bindings are saved
1028    in the object, and are looked up rather than directly set with a bind.
1029    An index to these buttons is saved as log.ButtonBindingLookup
1030    :param wx.Panel parent: parent widget
1031    :param int id: Id for button
1032    :param str label: label for button
1033    :param str locationcode: a label used internally to uniquely indentify the button
1034    :param function handler: a routine to call when the button is pressed
1035    '''
1036    def __init__(self,parent,id=wx.ID_ANY,label='',locationcode='',
1037                 handler=None,*args,**kwargs):
1038        super(self.__class__,self).__init__(parent,id,label,*args,**kwargs)
1039        self.label = label
1040        self.handler = handler
1041        self.locationcode = locationcode
1042        key = locationcode + '+' + label # hash code to find button
1043        self.Bind(wx.EVT_BUTTON,self.onPress)
1044        log.ButtonBindingLookup[key] = self
1045    def onPress(self,event):
1046        'create log event and call handler'
1047        log.MakeButtonLog(self.locationcode,self.label)
1048        self.handler(event)
1049       
1050################################################################################
1051class EnumSelector(wx.ComboBox):
1052    '''A customized :class:`wxpython.ComboBox` that selects items from a list
1053    of choices, but sets a dict (list) entry to the corresponding
1054    entry from the input list of values.
1055
1056    :param wx.Panel parent: the parent to the :class:`~wxpython.ComboBox` (usually a
1057      frame or panel)
1058    :param dict dct: a dict (or list) to contain the value set
1059      for the :class:`~wxpython.ComboBox`.
1060    :param item: the dict key (or list index) where ``dct[item]`` will
1061      be set to the value selected in the :class:`~wxpython.ComboBox`. Also, dct[item]
1062      contains the starting value shown in the widget. If the value
1063      does not match an entry in :data:`values`, the first value
1064      in :data:`choices` is used as the default, but ``dct[item]`` is
1065      not changed.   
1066    :param list choices: a list of choices to be displayed to the
1067      user such as
1068      ::
1069     
1070      ["default","option 1","option 2",]
1071
1072      Note that these options will correspond to the entries in
1073      :data:`values` (if specified) item by item.
1074    :param list values: a list of values that correspond to
1075      the options in :data:`choices`, such as
1076      ::
1077     
1078      [0,1,2]
1079     
1080      The default for :data:`values` is to use the same list as
1081      specified for :data:`choices`.
1082    :param (other): additional keyword arguments accepted by
1083      :class:`~wxpython.ComboBox` can be specified.
1084    '''
1085    def __init__(self,parent,dct,item,choices,values=None,**kw):
1086        if values is None:
1087            values = choices
1088        if dct[item] in values:
1089            i = values.index(dct[item])
1090        else:
1091            i = 0
1092        startval = choices[i]
1093        wx.ComboBox.__init__(self,parent,wx.ID_ANY,startval,
1094                             choices = choices,
1095                             style=wx.CB_DROPDOWN|wx.CB_READONLY,
1096                             **kw)
1097        self.choices = choices
1098        self.values = values
1099        self.dct = dct
1100        self.item = item
1101        self.Bind(wx.EVT_COMBOBOX, self.onSelection)
1102    def onSelection(self,event):
1103        # respond to a selection by setting the enum value in the CIF dictionary
1104        if self.GetValue() in self.choices: # should always be true!
1105            self.dct[self.item] = self.values[self.choices.index(self.GetValue())]
1106        else:
1107            self.dct[self.item] = self.values[0] # unknown
1108
1109################################################################################
1110class G2ChoiceButton(wx.Choice):
1111    '''A customized version of a wx.Choice that automatically initializes
1112    the control to match a supplied value and saves the choice directly
1113    into an array or list. Optionally a function can be called each time a
1114    choice is selected. The widget can be used with an array item that is set to
1115    to the choice by number (``indLoc[indKey]``) or by string value
1116    (``strLoc[strKey]``) or both. The initial value is taken from ``indLoc[indKey]``
1117    if not None or ``strLoc[strKey]`` if not None.
1118
1119    :param wx.Panel parent: name of panel or frame that will be
1120      the parent to the widget. Can be None.
1121    :param list choiceList: a list or tuple of choices to offer the user.
1122    :param dict/list indLoc: a dict or list with the initial value to be
1123      placed in the Choice button. If this is None, this is ignored.
1124    :param int/str indKey: the dict key or the list index for the value to be
1125      edited by the Choice button. If indLoc is not None then this
1126      must be specified and the ``indLoc[indKey]`` will be set. If the value
1127      for ``indLoc[indKey]`` is not None, it should be an integer in
1128      range(len(choiceList)). The Choice button will be initialized to the
1129      choice corresponding to the value in this element if not None.
1130    :param dict/list strLoc: a dict or list with the string value corresponding to
1131      indLoc/indKey. Default (None) means that this is not used.
1132    :param int/str strKey: the dict key or the list index for the string value
1133      The ``strLoc[strKey]`` element must exist or strLoc must be None (default).
1134    :param function onChoice: name of a function to call when the choice is made.
1135    '''
1136    def __init__(self,parent,choiceList,indLoc=None,indKey=None,strLoc=None,strKey=None,
1137                 onChoice=None,**kwargs):
1138        wx.Choice.__init__(self,parent,choices=choiceList,id=wx.ID_ANY,**kwargs)
1139        self.choiceList = choiceList
1140        self.indLoc = indLoc
1141        self.indKey = indKey
1142        self.strLoc = strLoc
1143        self.strKey = strKey
1144        self.onChoice = None
1145        self.SetSelection(wx.NOT_FOUND)
1146        if self.indLoc is not None and self.indLoc.get(self.indKey) is not None:
1147            self.SetSelection(self.indLoc[self.indKey])
1148            if self.strLoc is not None:
1149                self.strLoc[self.strKey] = self.GetStringSelection()
1150                log.LogVarChange(self.strLoc,self.strKey)
1151        elif self.strLoc is not None and self.strLoc.get(self.strKey) is not None:
1152            try:
1153                self.SetSelection(choiceList.index(self.strLoc[self.strKey]))
1154                if self.indLoc is not None:
1155                    self.indLoc[self.indKey] = self.GetSelection()
1156                    log.LogVarChange(self.indLoc,self.indKey)
1157            except ValueError:
1158                pass
1159        self.Bind(wx.EVT_CHOICE, self._OnChoice)
1160        #if self.strLoc is not None: # make sure strLoc gets initialized
1161        #    self._OnChoice(None) # note that onChoice will not be called
1162        self.onChoice = onChoice
1163    def _OnChoice(self,event):
1164        if self.indLoc is not None:
1165            self.indLoc[self.indKey] = self.GetSelection()
1166            log.LogVarChange(self.indLoc,self.indKey)
1167        if self.strLoc is not None:
1168            self.strLoc[self.strKey] = self.GetStringSelection()
1169            log.LogVarChange(self.strLoc,self.strKey)
1170        if self.onChoice:
1171            self.onChoice()
1172
1173##############################################################
1174# Custom checkbox that saves values into dict/list as used
1175class G2CheckBox(wx.CheckBox):
1176    '''A customized version of a CheckBox that automatically initializes
1177    the control to a supplied list or dict entry and updates that
1178    entry as the widget is used.
1179
1180    :param wx.Panel parent: name of panel or frame that will be
1181      the parent to the widget. Can be None.
1182    :param str label: text to put on check button
1183    :param dict/list loc: the dict or list with the initial value to be
1184      placed in the CheckBox.
1185    :param int/str key: the dict key or the list index for the value to be
1186      edited by the CheckBox. The ``loc[key]`` element must exist.
1187      The CheckBox will be initialized from this value.
1188      If the value is anything other that True (or 1), it will be taken as
1189      False.
1190    :param function OnChange: specifies a function or method that will be
1191      called when the CheckBox is changed (Default is None).
1192      The called function is supplied with one argument, the calling event.
1193    '''
1194    def __init__(self,parent,label,loc,key,OnChange=None):
1195        wx.CheckBox.__init__(self,parent,id=wx.ID_ANY,label=label)
1196        self.loc = loc
1197        self.key = key
1198        self.OnChange = OnChange
1199        self.SetValue(self.loc[self.key]==True)
1200        self.Bind(wx.EVT_CHECKBOX, self._OnCheckBox)
1201    def _OnCheckBox(self,event):
1202        self.loc[self.key] = self.GetValue()
1203        log.LogVarChange(self.loc,self.key)
1204        if self.OnChange: self.OnChange(event)
1205                   
1206################################################################################
1207#### Commonly used dialogs
1208################################################################################
1209def CallScrolledMultiEditor(parent,dictlst,elemlst,prelbl=[],postlbl=[],
1210                 title='Edit items',header='',size=(300,250),
1211                             CopyButton=False, ASCIIonly=False, **kw):
1212    '''Shell routine to call a ScrolledMultiEditor dialog. See
1213    :class:`ScrolledMultiEditor` for parameter definitions.
1214
1215    :returns: True if the OK button is pressed; False if the window is closed
1216      with the system menu or the Cancel button.
1217
1218    '''
1219    dlg = ScrolledMultiEditor(parent,dictlst,elemlst,prelbl,postlbl,
1220                              title,header,size,
1221                              CopyButton, ASCIIonly, **kw)
1222    if dlg.ShowModal() == wx.ID_OK:
1223        dlg.Destroy()
1224        return True
1225    else:
1226        dlg.Destroy()
1227        return False
1228
1229################################################################################
1230class ScrolledMultiEditor(wx.Dialog):
1231    '''Define a window for editing a potentially large number of dict- or
1232    list-contained values with validation for each item. Edited values are
1233    automatically placed in their source location. If invalid entries
1234    are provided, the TextCtrl is turned yellow and the OK button is disabled.
1235
1236    The type for each TextCtrl validation is determined by the
1237    initial value of the entry (int, float or string).
1238    Float values can be entered in the TextCtrl as numbers or also
1239    as algebraic expressions using operators + - / \* () and \*\*,
1240    in addition pi, sind(), cosd(), tand(), and sqrt() can be used,
1241    as well as appreviations s(), sin(), c(), cos(), t(), tan() and sq().
1242
1243    :param wx.Frame parent: name of parent window, or may be None
1244
1245    :param tuple dictlst: a list of dicts or lists containing values to edit
1246
1247    :param tuple elemlst: a list of keys for each item in a dictlst. Must have the
1248      same length as dictlst.
1249
1250    :param wx.Frame parent: name of parent window, or may be None
1251   
1252    :param tuple prelbl: a list of labels placed before the TextCtrl for each
1253      item (optional)
1254   
1255    :param tuple postlbl: a list of labels placed after the TextCtrl for each
1256      item (optional)
1257
1258    :param str title: a title to place in the frame of the dialog
1259
1260    :param str header: text to place at the top of the window. May contain
1261      new line characters.
1262
1263    :param wx.Size size: a size parameter that dictates the
1264      size for the scrolled region of the dialog. The default is
1265      (300,250).
1266
1267    :param bool CopyButton: if True adds a small button that copies the
1268      value for the current row to all fields below (default is False)
1269     
1270    :param bool ASCIIonly: if set as True will remove unicode characters from
1271      strings
1272     
1273    :param list minvals: optional list of minimum values for validation
1274      of float or int values. Ignored if value is None.
1275    :param list maxvals: optional list of maximum values for validation
1276      of float or int values. Ignored if value is None.
1277    :param list sizevals: optional list of wx.Size values for each input
1278      widget. Ignored if value is None.
1279     
1280    :param tuple checkdictlst: an optional list of dicts or lists containing bool
1281      values (similar to dictlst).
1282    :param tuple checkelemlst: an optional list of dicts or lists containing bool
1283      key values (similar to elemlst). Must be used with checkdictlst.
1284    :param string checklabel: a string to use for each checkbutton
1285     
1286    :returns: the wx.Dialog created here. Use method .ShowModal() to display it.
1287   
1288    *Example for use of ScrolledMultiEditor:*
1289
1290    ::
1291
1292        dlg = <pkg>.ScrolledMultiEditor(frame,dictlst,elemlst,prelbl,postlbl,
1293                                        header=header)
1294        if dlg.ShowModal() == wx.ID_OK:
1295             for d,k in zip(dictlst,elemlst):
1296                 print d[k]
1297
1298    *Example definitions for dictlst and elemlst:*
1299
1300    ::
1301     
1302          dictlst = (dict1,list1,dict1,list1)
1303          elemlst = ('a', 1, 2, 3)
1304
1305      This causes items dict1['a'], list1[1], dict1[2] and list1[3] to be edited.
1306   
1307    Note that these items must have int, float or str values assigned to
1308    them. The dialog will force these types to be retained. String values
1309    that are blank are marked as invalid.
1310    '''
1311   
1312    def __init__(self,parent,dictlst,elemlst,prelbl=[],postlbl=[],
1313                 title='Edit items',header='',size=(300,250),
1314                 CopyButton=False, ASCIIonly=False,
1315                 minvals=[],maxvals=[],sizevals=[],
1316                 checkdictlst=[], checkelemlst=[], checklabel=""):
1317        if len(dictlst) != len(elemlst):
1318            raise Exception("ScrolledMultiEditor error: len(dictlst) != len(elemlst) "+str(len(dictlst))+" != "+str(len(elemlst)))
1319        if len(checkdictlst) != len(checkelemlst):
1320            raise Exception("ScrolledMultiEditor error: len(checkdictlst) != len(checkelemlst) "+str(len(checkdictlst))+" != "+str(len(checkelemlst)))
1321        wx.Dialog.__init__( # create dialog & sizer
1322            self,parent,wx.ID_ANY,title,
1323            style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
1324        mainSizer = wx.BoxSizer(wx.VERTICAL)
1325        self.orig = []
1326        self.dictlst = dictlst
1327        self.elemlst = elemlst
1328        self.checkdictlst = checkdictlst
1329        self.checkelemlst = checkelemlst
1330        self.StartCheckValues = [checkdictlst[i][checkelemlst[i]] for i in range(len(checkdictlst))]
1331        self.ButtonIndex = {}
1332        for d,i in zip(dictlst,elemlst):
1333            self.orig.append(d[i])
1334        # add a header if supplied
1335        if header:
1336            subSizer = wx.BoxSizer(wx.HORIZONTAL)
1337            subSizer.Add((-1,-1),1,wx.EXPAND)
1338            subSizer.Add(wx.StaticText(self,wx.ID_ANY,header))
1339            subSizer.Add((-1,-1),1,wx.EXPAND)
1340            mainSizer.Add(subSizer,0,wx.EXPAND,0)
1341        # make OK button now, because we will need it for validation
1342        self.OKbtn = wx.Button(self, wx.ID_OK)
1343        self.OKbtn.SetDefault()
1344        # create scrolled panel and sizer
1345        panel = wxscroll.ScrolledPanel(self, wx.ID_ANY,size=size,
1346            style = wx.TAB_TRAVERSAL|wx.SUNKEN_BORDER)
1347        cols = 4
1348        if CopyButton: cols += 1
1349        subSizer = wx.FlexGridSizer(cols=cols,hgap=2,vgap=2)
1350        self.ValidatedControlsList = [] # make list of TextCtrls
1351        self.CheckControlsList = [] # make list of CheckBoxes
1352        for i,(d,k) in enumerate(zip(dictlst,elemlst)):
1353            if i >= len(prelbl): # label before TextCtrl, or put in a blank
1354                subSizer.Add((-1,-1)) 
1355            else:
1356                subSizer.Add(wx.StaticText(panel,wx.ID_ANY,str(prelbl[i])))
1357            kargs = {}
1358            if i < len(minvals):
1359                if minvals[i] is not None: kargs['min']=minvals[i]
1360            if i < len(maxvals):
1361                if maxvals[i] is not None: kargs['max']=maxvals[i]
1362            if i < len(sizevals):
1363                if sizevals[i]: kargs['size']=sizevals[i]
1364            if CopyButton:
1365                import wx.lib.colourselect as wscs  # is there a way to test?
1366                but = wscs.ColourSelect(label='v', # would like to use u'\u2193' or u'\u25BC' but not in WinXP
1367                    parent=panel,colour=(255,255,200),size=wx.Size(30,23),
1368                    style=wx.RAISED_BORDER)
1369                but.Bind(wx.EVT_BUTTON, self._OnCopyButton)
1370                if 'phoenix' in wx.version():
1371                    but.SetToolTip('Press to copy adjacent value to all rows below')
1372                else:
1373                    but.SetToolTipString('Press to copy adjacent value to all rows below')
1374                self.ButtonIndex[but] = i
1375                subSizer.Add(but)
1376            # create the validated TextCrtl, store it and add it to the sizer
1377            ctrl = ValidatedTxtCtrl(panel,d,k,OKcontrol=self.ControlOKButton,ASCIIonly=ASCIIonly,
1378                                    **kargs)
1379            self.ValidatedControlsList.append(ctrl)
1380            subSizer.Add(ctrl)
1381            if i < len(postlbl): # label after TextCtrl, or put in a blank
1382                subSizer.Add(wx.StaticText(panel,wx.ID_ANY,str(postlbl[i])))
1383            else:
1384                subSizer.Add((-1,-1))
1385            if i < len(checkdictlst):
1386                ch = G2CheckBox(panel,checklabel,checkdictlst[i],checkelemlst[i])
1387                self.CheckControlsList.append(ch)
1388                subSizer.Add(ch)                   
1389            else:
1390                subSizer.Add((-1,-1))
1391        # finish up ScrolledPanel
1392        panel.SetSizer(subSizer)
1393        panel.SetAutoLayout(1)
1394        panel.SetupScrolling()
1395        # patch for wx 2.9 on Mac
1396        i,j= wx.__version__.split('.')[0:2]
1397        if int(i)+int(j)/10. > 2.8 and 'wxOSX' in wx.PlatformInfo:
1398            panel.SetMinSize((subSizer.GetSize()[0]+30,panel.GetSize()[1]))       
1399        mainSizer.Add(panel,1, wx.ALL|wx.EXPAND,1)
1400
1401        # Sizer for OK/Close buttons. N.B. on Close changes are discarded
1402        # by restoring the initial values
1403        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
1404        btnsizer.Add(self.OKbtn)
1405        btn = wx.Button(self, wx.ID_CLOSE,"Cancel") 
1406        btn.Bind(wx.EVT_BUTTON,self._onClose)
1407        btnsizer.Add(btn)
1408        mainSizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
1409        # size out the window. Set it to be enlarged but not made smaller
1410        self.SetSizer(mainSizer)
1411        mainSizer.Fit(self)
1412        self.SetMinSize(self.GetSize())
1413
1414    def _OnCopyButton(self,event):
1415        'Implements the copy down functionality'
1416        but = event.GetEventObject()
1417        n = self.ButtonIndex.get(but)
1418        if n is None: return
1419        for i,(d,k,ctrl) in enumerate(zip(self.dictlst,self.elemlst,self.ValidatedControlsList)):
1420            if i < n: continue
1421            if i == n:
1422                val = d[k]
1423                continue
1424            d[k] = val
1425            ctrl.SetValue(val)
1426        for i in range(len(self.checkdictlst)):
1427            if i < n: continue
1428            self.checkdictlst[i][self.checkelemlst[i]] = self.checkdictlst[n][self.checkelemlst[n]]
1429            self.CheckControlsList[i].SetValue(self.checkdictlst[i][self.checkelemlst[i]])
1430    def _onClose(self,event):
1431        'Used on Cancel: Restore original values & close the window'
1432        for d,i,v in zip(self.dictlst,self.elemlst,self.orig):
1433            d[i] = v
1434        for i in range(len(self.checkdictlst)):
1435            self.checkdictlst[i][self.checkelemlst[i]] = self.StartCheckValues[i]
1436        self.EndModal(wx.ID_CANCEL)
1437       
1438    def ControlOKButton(self,setvalue):
1439        '''Enable or Disable the OK button for the dialog. Note that this is
1440        passed into the ValidatedTxtCtrl for use by validators.
1441
1442        :param bool setvalue: if True, all entries in the dialog are
1443          checked for validity. if False then the OK button is disabled.
1444
1445        '''
1446        if setvalue: # turn button on, do only if all controls show as valid
1447            for ctrl in self.ValidatedControlsList:
1448                if ctrl.invalid:
1449                    self.OKbtn.Disable()
1450                    return
1451            else:
1452                self.OKbtn.Enable()
1453        else:
1454            self.OKbtn.Disable()
1455
1456###############################################  Multichoice Dialog with set all, toggle & filter options
1457class G2MultiChoiceDialog(wx.Dialog):
1458    '''A dialog similar to MultiChoiceDialog except that buttons are
1459    added to set all choices and to toggle all choices.
1460
1461    :param wx.Frame ParentFrame: reference to parent frame
1462    :param str title: heading above list of choices
1463    :param str header: Title to place on window frame
1464    :param list ChoiceList: a list of choices where one more will be selected
1465    :param bool toggle: If True (default) the toggle and select all buttons
1466      are displayed
1467    :param bool monoFont: If False (default), use a variable-spaced font;
1468      if True use a equally-spaced font.
1469    :param bool filterBox: If True (default) an input widget is placed on
1470      the window and only entries matching the entered text are shown.
1471    :param dict extraOpts: a dict containing a entries of form label_i and value_i with extra
1472      options to present to the user, where value_i is the default value.
1473      Options are listed ordered by the value_i values.
1474    :param kw: optional keyword parameters for the wx.Dialog may
1475      be included such as size [which defaults to `(320,310)`] and
1476      style (which defaults to `wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL`);
1477      note that `wx.OK` and `wx.CANCEL` style items control
1478      the presence of the eponymous buttons in the dialog.
1479    :returns: the name of the created dialog 
1480    '''
1481    def __init__(self,parent, title, header, ChoiceList, toggle=True,
1482                 monoFont=False, filterBox=True, extraOpts={}, **kw):
1483        # process keyword parameters, notably style
1484        options = {'size':(320,310), # default Frame keywords
1485                   'style':wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL,
1486                   }
1487        options.update(kw)
1488        self.ChoiceList = ['%4d) %s'%(i,item) for i,item in enumerate(ChoiceList)] # numbered list of choices (list of str values)
1489        self.Selections = len(self.ChoiceList) * [False,] # selection status for each choice (list of bools)
1490        self.filterlist = range(len(self.ChoiceList)) # list of the choice numbers that have been filtered (list of int indices)
1491        self.Stride = 1
1492        if options['style'] & wx.OK:
1493            useOK = True
1494            options['style'] ^= wx.OK
1495        else:
1496            useOK = False
1497        if options['style'] & wx.CANCEL:
1498            useCANCEL = True
1499            options['style'] ^= wx.CANCEL
1500        else:
1501            useCANCEL = False       
1502        # create the dialog frame
1503        wx.Dialog.__init__(self,parent,wx.ID_ANY,header,**options)
1504        # fill the dialog
1505        Sizer = wx.BoxSizer(wx.VERTICAL)
1506        topSizer = wx.BoxSizer(wx.HORIZONTAL)
1507        topSizer.Add(wx.StaticText(self,wx.ID_ANY,title,size=(-1,35)),
1508            1,wx.ALL|wx.EXPAND|WACV,1)
1509        if filterBox:
1510            self.timer = wx.Timer()
1511            self.timer.Bind(wx.EVT_TIMER,self.Filter)
1512            topSizer.Add(wx.StaticText(self,wx.ID_ANY,'Name \nFilter: '),0,wx.ALL|WACV,1)
1513            self.filterBox = wx.TextCtrl(self, wx.ID_ANY, size=(80,-1),style=wx.TE_PROCESS_ENTER)
1514            self.filterBox.Bind(wx.EVT_TEXT,self.onChar)
1515            self.filterBox.Bind(wx.EVT_TEXT_ENTER,self.Filter)
1516            topSizer.Add(self.filterBox,0,wx.ALL|WACV,0)
1517        Sizer.Add(topSizer,0,wx.ALL|wx.EXPAND,8)
1518        self.settingRange = False
1519        self.rangeFirst = None
1520        self.clb = wx.CheckListBox(self, wx.ID_ANY, (30,30), wx.DefaultSize, self.ChoiceList)
1521        self.clb.Bind(wx.EVT_CHECKLISTBOX,self.OnCheck)
1522        if monoFont:
1523            font1 = wx.Font(self.clb.GetFont().GetPointSize(),
1524                            wx.MODERN, wx.NORMAL, wx.NORMAL, False)
1525            self.clb.SetFont(font1)
1526        Sizer.Add(self.clb,1,wx.LEFT|wx.RIGHT|wx.EXPAND,10)
1527        Sizer.Add((-1,10))
1528        # set/toggle buttons
1529        if toggle:
1530            tSizer = wx.FlexGridSizer(cols=2,hgap=5,vgap=5)
1531            tSizer.Add(wx.StaticText(self,label=' Apply stride:'),0,WACV)
1532            numbs = [str(i+1) for i in range(9)]+[str(2*i+10) for i in range(6)]
1533            self.stride = wx.ComboBox(self,value='1',choices=numbs,style=wx.CB_READONLY|wx.CB_DROPDOWN)
1534            self.stride.Bind(wx.EVT_COMBOBOX,self.OnStride)
1535            tSizer.Add(self.stride,0,WACV)
1536            setBut = wx.Button(self,wx.ID_ANY,'Set All')
1537            setBut.Bind(wx.EVT_BUTTON,self._SetAll)
1538            tSizer.Add(setBut)
1539            togBut = wx.Button(self,wx.ID_ANY,'Toggle All')
1540            togBut.Bind(wx.EVT_BUTTON,self._ToggleAll)
1541            tSizer.Add(togBut)
1542            self.rangeBut = wx.ToggleButton(self,wx.ID_ANY,'Set Range')
1543            self.rangeBut.Bind(wx.EVT_TOGGLEBUTTON,self.SetRange)
1544            tSizer.Add(self.rangeBut)
1545            self.rangeCapt = wx.StaticText(self,wx.ID_ANY,'')
1546            tSizer.Add(self.rangeCapt)
1547            Sizer.Add(tSizer,0,wx.LEFT,12)
1548        # Extra widgets
1549        Sizer.Add((-1,5),0,wx.LEFT,0)
1550        bSizer = wx.BoxSizer(wx.VERTICAL)
1551        for lbl in sorted(extraOpts.keys()):
1552            if not lbl.startswith('label'): continue
1553            key = lbl.replace('label','value')
1554            if key not in extraOpts: continue
1555            eSizer = wx.BoxSizer(wx.HORIZONTAL)
1556            if type(extraOpts[key]) is bool:
1557                eSizer.Add(G2CheckBox(self,extraOpts[lbl],extraOpts,key))
1558            else:
1559                eSizer.Add(wx.StaticText(self,wx.ID_ANY,extraOpts[lbl]))
1560                eSizer.Add(ValidatedTxtCtrl(self,extraOpts,key))
1561            bSizer.Add(eSizer,0,wx.LEFT,0)
1562        Sizer.Add(bSizer,0,wx.CENTER,0)
1563        Sizer.Add((-1,5),0,wx.LEFT,0)
1564        # OK/Cancel buttons
1565        btnsizer = wx.StdDialogButtonSizer()
1566        if useOK:
1567            self.OKbtn = wx.Button(self, wx.ID_OK)
1568            self.OKbtn.SetDefault()
1569            btnsizer.AddButton(self.OKbtn)
1570            self.OKbtn.Bind(wx.EVT_BUTTON,self.onOk)
1571        if useCANCEL:
1572            btn = wx.Button(self, wx.ID_CANCEL)
1573            btn.Bind(wx.EVT_BUTTON,self.onCancel)
1574            btnsizer.AddButton(btn)
1575        btnsizer.Realize()
1576        Sizer.Add((-1,5))
1577        Sizer.Add(btnsizer,0,wx.ALIGN_RIGHT,50)
1578        Sizer.Add((-1,20))
1579        # OK done, let's get outa here
1580        self.SetSizer(Sizer)
1581        Sizer.Fit(self)
1582        self.CenterOnParent()
1583       
1584    def onOk(self,event):
1585        parent = self.GetParent()
1586        parent.Raise()
1587        self.EndModal(wx.ID_OK)             
1588       
1589    def onCancel(self,event):
1590        parent = self.GetParent()
1591        parent.Raise()
1592        self.EndModal(wx.ID_CANCEL)
1593       
1594    def OnStride(self,event):
1595        self.Stride = int(self.stride.GetValue())
1596
1597    def SetRange(self,event):
1598        '''Respond to a press of the Set Range button. Set the range flag and
1599        the caption next to the button
1600        '''
1601        self.settingRange = self.rangeBut.GetValue()
1602        if self.settingRange:
1603            self.rangeCapt.SetLabel('Select range start')
1604        else:
1605            self.rangeCapt.SetLabel('')           
1606        self.rangeFirst = None
1607       
1608    def GetSelections(self):
1609        'Returns a list of the indices for the selected choices'
1610        # update self.Selections with settings for displayed items
1611        for i in range(len(self.filterlist)):
1612            self.Selections[self.filterlist[i]] = self.clb.IsChecked(i)
1613        # return all selections, shown or hidden
1614        return [i for i in range(len(self.Selections)) if self.Selections[i]]
1615       
1616    def SetSelections(self,selList):
1617        '''Sets the selection indices in selList as selected. Resets any previous
1618        selections for compatibility with wx.MultiChoiceDialog. Note that
1619        the state for only the filtered items is shown.
1620
1621        :param list selList: indices of items to be selected. These indices
1622          are referenced to the order in self.ChoiceList
1623        '''
1624        self.Selections = len(self.ChoiceList) * [False,] # reset selections
1625        for sel in selList:
1626            self.Selections[sel] = True
1627        self._ShowSelections()
1628
1629    def _ShowSelections(self):
1630        'Show the selection state for displayed items'
1631        self.clb.SetChecked(
1632            [i for i in range(len(self.filterlist)) if self.Selections[self.filterlist[i]]]
1633            ) # Note anything previously checked will be cleared.
1634           
1635    def _SetAll(self,event):
1636        'Set all viewed choices on'
1637        if 'phoenix' in wx.version():
1638            self.clb.SetCheckedItems(range(0,len(self.filterlist),self.Stride))
1639        else:
1640            self.clb.SetChecked(range(0,len(self.filterlist),self.Stride))
1641        self.stride.SetValue('1')
1642        self.Stride = 1
1643       
1644    def _ToggleAll(self,event):
1645        'flip the state of all viewed choices'
1646        for i in range(len(self.filterlist)):
1647            self.clb.Check(i,not self.clb.IsChecked(i))
1648           
1649    def onChar(self,event):
1650        'Respond to keyboard events in the Filter box'
1651        self.OKbtn.Enable(False)
1652        if self.timer.IsRunning():
1653            self.timer.Stop()
1654        self.timer.Start(1000,oneShot=True)
1655        if event: event.Skip()
1656       
1657    def OnCheck(self,event):
1658        '''for CheckListBox events; if Set Range is in use, this sets/clears all
1659        entries in range between start and end according to the value in start.
1660        Repeated clicks on the start change the checkbox state, but do not trigger
1661        the range copy.
1662        The caption next to the button is updated on the first button press.
1663        '''
1664        if self.settingRange:
1665            id = event.GetInt()
1666            if self.rangeFirst is None:
1667                name = self.clb.GetString(id)
1668                self.rangeCapt.SetLabel(name+' to...')
1669                self.rangeFirst = id
1670            elif self.rangeFirst == id:
1671                pass
1672            else:
1673                for i in range(min(self.rangeFirst,id), max(self.rangeFirst,id)+1,self.Stride):
1674                    self.clb.Check(i,self.clb.IsChecked(self.rangeFirst))
1675                self.rangeBut.SetValue(False)
1676                self.rangeCapt.SetLabel('')
1677            return
1678       
1679    def Filter(self,event):
1680        '''Read text from filter control and select entries that match. Called by
1681        Timer after a delay with no input or if Enter is pressed.
1682        '''
1683        if self.timer.IsRunning():
1684            self.timer.Stop()
1685        self.GetSelections() # record current selections
1686        txt = self.filterBox.GetValue()
1687        self.clb.Clear()
1688       
1689        self.Update()
1690        self.filterlist = []
1691        if txt:
1692            txt = txt.lower()
1693            ChoiceList = []
1694            for i,item in enumerate(self.ChoiceList):
1695                if item.lower().find(txt) != -1:
1696                    ChoiceList.append(item)
1697                    self.filterlist.append(i)
1698        else:
1699            self.filterlist = range(len(self.ChoiceList))
1700            ChoiceList = self.ChoiceList
1701        self.clb.AppendItems(ChoiceList)
1702        self._ShowSelections()
1703        self.OKbtn.Enable(True)
1704
1705def SelectEdit1Var(G2frame,array,labelLst,elemKeysLst,dspLst,refFlgElem):
1706    '''Select a variable from a list, then edit it and select histograms
1707    to copy it to.
1708
1709    :param wx.Frame G2frame: main GSAS-II frame
1710    :param dict array: the array (dict or list) where values to be edited are kept
1711    :param list labelLst: labels for each data item
1712    :param list elemKeysLst: a list of lists of keys needed to be applied (see below)
1713      to obtain the value of each parameter
1714    :param list dspLst: list list of digits to be displayed (10,4) is 10 digits
1715      with 4 decimal places. Can be None.
1716    :param list refFlgElem: a list of lists of keys needed to be applied (see below)
1717      to obtain the refine flag for each parameter or None if the parameter
1718      does not have refine flag.
1719
1720    Example::
1721      array = data
1722      labelLst = ['v1','v2']
1723      elemKeysLst = [['v1'], ['v2',0]]
1724      refFlgElem = [None, ['v2',1]]
1725
1726     * The value for v1 will be in data['v1'] and this cannot be refined while,
1727     * The value for v2 will be in data['v2'][0] and its refinement flag is data['v2'][1]
1728    '''
1729    def unkey(dct,keylist):
1730        '''dive into a nested set of dicts/lists applying keys in keylist
1731        consecutively
1732        '''
1733        d = dct
1734        for k in keylist:
1735            d = d[k]
1736        return d
1737
1738    def OnChoice(event):
1739        'Respond when a parameter is selected in the Choice box'
1740        if 'phoenix' in wx.version():
1741            valSizer.Clear(True)
1742        else:
1743            valSizer.DeleteWindows()
1744        lbl = event.GetString()
1745        copyopts['currentsel'] = lbl
1746        i = labelLst.index(lbl)
1747        OKbtn.Enable(True)
1748        ch.SetLabel(lbl)
1749        args = {}
1750        if dspLst[i]:
1751            args = {'nDig':dspLst[i]}
1752        Val = ValidatedTxtCtrl(
1753            dlg,
1754            unkey(array,elemKeysLst[i][:-1]),
1755            elemKeysLst[i][-1],
1756            **args)
1757        copyopts['startvalue'] = unkey(array,elemKeysLst[i])
1758        #unkey(array,elemKeysLst[i][:-1])[elemKeysLst[i][-1]] =
1759        valSizer.Add(Val,0,wx.LEFT,5)
1760        dlg.SendSizeEvent()
1761       
1762    # SelectEdit1Var execution begins here
1763    saveArray = copy.deepcopy(array) # keep original values
1764    TreeItemType = G2frame.GPXtree.GetItemText(G2frame.PickId)
1765    copyopts = {'InTable':False,"startvalue":None,'currentsel':None}       
1766    hst = G2frame.GPXtree.GetItemText(G2frame.PatternId)
1767    histList = G2pdG.GetHistsLikeSelected(G2frame)
1768    if not histList:
1769        G2frame.ErrorDialog('No match','No histograms match '+hst,G2frame)
1770        return
1771    dlg = wx.Dialog(G2frame,wx.ID_ANY,'Set a parameter value',
1772        style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
1773    mainSizer = wx.BoxSizer(wx.VERTICAL)
1774    mainSizer.Add((5,5))
1775    subSizer = wx.BoxSizer(wx.HORIZONTAL)
1776    subSizer.Add((-1,-1),1,wx.EXPAND)
1777    subSizer.Add(wx.StaticText(dlg,wx.ID_ANY,'Select a parameter and set a new value'))
1778    subSizer.Add((-1,-1),1,wx.EXPAND)
1779    mainSizer.Add(subSizer,0,wx.EXPAND,0)
1780    mainSizer.Add((0,10))
1781
1782    subSizer = wx.FlexGridSizer(0,2,5,0)
1783    subSizer.Add(wx.StaticText(dlg,wx.ID_ANY,'Parameter: '))
1784    ch = wx.Choice(dlg, wx.ID_ANY, choices = sorted(labelLst))
1785    ch.SetSelection(-1)
1786    ch.Bind(wx.EVT_CHOICE, OnChoice)
1787    subSizer.Add(ch)
1788    subSizer.Add(wx.StaticText(dlg,wx.ID_ANY,'Value: '))
1789    valSizer = wx.BoxSizer(wx.HORIZONTAL)
1790    subSizer.Add(valSizer)
1791    mainSizer.Add(subSizer)
1792
1793    mainSizer.Add((-1,20))
1794    subSizer = wx.BoxSizer(wx.HORIZONTAL)
1795    subSizer.Add(G2CheckBox(dlg, 'Edit in table ', copyopts, 'InTable'))
1796    mainSizer.Add(subSizer)
1797
1798    btnsizer = wx.StdDialogButtonSizer()
1799    OKbtn = wx.Button(dlg, wx.ID_OK,'Continue')
1800    OKbtn.Enable(False)
1801    OKbtn.SetDefault()
1802    OKbtn.Bind(wx.EVT_BUTTON,lambda event: dlg.EndModal(wx.ID_OK))
1803    btnsizer.AddButton(OKbtn)
1804    btn = wx.Button(dlg, wx.ID_CANCEL)
1805    btnsizer.AddButton(btn)
1806    btnsizer.Realize()
1807    mainSizer.Add((-1,5),1,wx.EXPAND,1)
1808    mainSizer.Add(btnsizer,0,wx.ALIGN_CENTER,0)
1809    mainSizer.Add((-1,10))
1810
1811    dlg.SetSizer(mainSizer)
1812    dlg.CenterOnParent()
1813    if dlg.ShowModal() != wx.ID_OK:
1814        array.update(saveArray)
1815        dlg.Destroy()
1816        return
1817    dlg.Destroy()
1818
1819    copyList = []
1820    lbl = copyopts['currentsel']
1821    dlg = G2MultiChoiceDialog(G2frame,'Copy parameter '+lbl+' from\n'+hst,
1822        'Copy parameters', histList)
1823    dlg.CenterOnParent()
1824    try:
1825        if dlg.ShowModal() == wx.ID_OK:
1826            for i in dlg.GetSelections(): 
1827                copyList.append(histList[i])
1828        else:
1829            # reset the parameter since cancel was pressed
1830            array.update(saveArray)
1831            return
1832    finally:
1833        dlg.Destroy()
1834
1835    prelbl = [hst]
1836    i = labelLst.index(lbl)
1837    keyLst = elemKeysLst[i]
1838    refkeys = refFlgElem[i]
1839    dictlst = [unkey(array,keyLst[:-1])]
1840    if refkeys is not None:
1841        refdictlst = [unkey(array,refkeys[:-1])]
1842    else:
1843        refdictlst = None
1844    Id = G2gd.GetGPXtreeItemId(G2frame,G2frame.root,hst)
1845    hstData = G2frame.GPXtree.GetItemPyData(G2gd.GetGPXtreeItemId(G2frame,Id,'Instrument Parameters'))[0]
1846    for h in copyList:
1847        Id = G2gd.GetGPXtreeItemId(G2frame,G2frame.root,h)
1848        instData = G2frame.GPXtree.GetItemPyData(G2gd.GetGPXtreeItemId(G2frame,Id,'Instrument Parameters'))[0]
1849        if len(hstData) != len(instData) or hstData['Type'][0] != instData['Type'][0]:  #don't mix data types or lam & lam1/lam2 parms!
1850            print (h+' not copied - instrument parameters not commensurate')
1851            continue
1852        hData = G2frame.GPXtree.GetItemPyData(G2gd.GetGPXtreeItemId(G2frame,Id,TreeItemType))
1853        if TreeItemType == 'Instrument Parameters':
1854            hData = hData[0]
1855        #copy the value if it is changed or we will not edit in a table
1856        valNow = unkey(array,keyLst)
1857        if copyopts['startvalue'] != valNow or not copyopts['InTable']:
1858            unkey(hData,keyLst[:-1])[keyLst[-1]] = valNow
1859        prelbl += [h]
1860        dictlst += [unkey(hData,keyLst[:-1])]
1861        if refdictlst is not None:
1862            refdictlst += [unkey(hData,refkeys[:-1])]
1863    if refdictlst is None:
1864        args = {}
1865    else:
1866        args = {'checkdictlst':refdictlst,
1867                'checkelemlst':len(dictlst)*[refkeys[-1]],
1868                'checklabel':'Refine?'}
1869    if copyopts['InTable']:
1870        dlg = ScrolledMultiEditor(
1871            G2frame,dictlst,
1872            len(dictlst)*[keyLst[-1]],prelbl,
1873            header='Editing parameter '+lbl,
1874            CopyButton=True,**args)
1875        dlg.CenterOnParent()
1876        if dlg.ShowModal() != wx.ID_OK:
1877            array.update(saveArray)
1878        dlg.Destroy()
1879
1880################################################################        Single choice Dialog with filter options
1881class G2SingleChoiceDialog(wx.Dialog):
1882    '''A dialog similar to wx.SingleChoiceDialog except that a filter can be
1883    added.
1884
1885    :param wx.Frame ParentFrame: reference to parent frame
1886    :param str title: heading above list of choices
1887    :param str header: Title to place on window frame
1888    :param list ChoiceList: a list of choices where one will be selected
1889    :param bool monoFont: If False (default), use a variable-spaced font;
1890      if True use a equally-spaced font.
1891    :param bool filterBox: If True (default) an input widget is placed on
1892      the window and only entries matching the entered text are shown.
1893    :param kw: optional keyword parameters for the wx.Dialog may
1894      be included such as size [which defaults to `(320,310)`] and
1895      style (which defaults to ``wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER | wx.CENTRE | wx.OK | wx.CANCEL``);
1896      note that ``wx.OK`` and ``wx.CANCEL`` controls
1897      the presence of the eponymous buttons in the dialog.
1898    :returns: the name of the created dialog
1899    '''
1900    def __init__(self,parent, title, header, ChoiceList, 
1901                 monoFont=False, filterBox=True, **kw):
1902        # process keyword parameters, notably style
1903        options = {'size':(320,310), # default Frame keywords
1904                   'style':wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL,
1905                   }
1906        options.update(kw)
1907        self.ChoiceList = ChoiceList
1908        self.filterlist = range(len(self.ChoiceList))
1909        if options['style'] & wx.OK:
1910            useOK = True
1911            options['style'] ^= wx.OK
1912        else:
1913            useOK = False
1914        if options['style'] & wx.CANCEL:
1915            useCANCEL = True
1916            options['style'] ^= wx.CANCEL
1917        else:
1918            useCANCEL = False       
1919        # create the dialog frame
1920        wx.Dialog.__init__(self,parent,wx.ID_ANY,header,**options)
1921        # fill the dialog
1922        Sizer = wx.BoxSizer(wx.VERTICAL)
1923        topSizer = wx.BoxSizer(wx.HORIZONTAL)
1924        h = max(35,17*int(len(title)/26.+1)) # adjust height of title box with guessed # of lines
1925        topSizer.Add(
1926            wx.StaticText(self,wx.ID_ANY,title,size=(-1,h)),
1927            1,wx.ALL|wx.EXPAND|WACV,1)
1928        if filterBox:
1929            self.timer = wx.Timer()
1930            self.timer.Bind(wx.EVT_TIMER,self.Filter)
1931            topSizer.Add(wx.StaticText(self,wx.ID_ANY,'Filter: '),0,wx.ALL,1)
1932            self.filterBox = wx.TextCtrl(self, wx.ID_ANY, size=(80,-1),
1933                                         style=wx.TE_PROCESS_ENTER)
1934            self.filterBox.Bind(wx.EVT_CHAR,self.onChar)
1935            self.filterBox.Bind(wx.EVT_TEXT_ENTER,self.Filter)
1936            topSizer.Add(self.filterBox,0,wx.ALL,0)
1937        Sizer.Add(topSizer,0,wx.ALL|wx.EXPAND,8)
1938        self.clb = wx.ListBox(self, wx.ID_ANY, (30,30), wx.DefaultSize, ChoiceList)
1939        self.clb.Bind(wx.EVT_LEFT_DCLICK,self.onDoubleClick)
1940        if monoFont:
1941            font1 = wx.Font(self.clb.GetFont().GetPointSize(),
1942                            wx.MODERN, wx.NORMAL, wx.NORMAL, False)
1943            self.clb.SetFont(font1)
1944        Sizer.Add(self.clb,1,wx.LEFT|wx.RIGHT|wx.EXPAND,10)
1945        Sizer.Add((-1,10))
1946        # OK/Cancel buttons
1947        btnsizer = wx.StdDialogButtonSizer()
1948        if useOK:
1949            self.OKbtn = wx.Button(self, wx.ID_OK)
1950            self.OKbtn.SetDefault()
1951            btnsizer.AddButton(self.OKbtn)
1952        if useCANCEL:
1953            btn = wx.Button(self, wx.ID_CANCEL)
1954            btnsizer.AddButton(btn)
1955        btnsizer.Realize()
1956        Sizer.Add((-1,5))
1957        Sizer.Add(btnsizer,0,wx.ALIGN_RIGHT,50)
1958        Sizer.Add((-1,20))
1959        # OK done, let's get outa here
1960        self.SetSizer(Sizer)
1961    def GetSelection(self):
1962        'Returns the index of the selected choice'
1963        i = self.clb.GetSelection()
1964        if i < 0 or i >= len(self.filterlist):
1965            return wx.NOT_FOUND
1966        return self.filterlist[i]
1967    def onChar(self,event):
1968        self.OKbtn.Enable(False)
1969        if self.timer.IsRunning():
1970            self.timer.Stop()
1971        self.timer.Start(1000,oneShot=True)
1972        if event: event.Skip()
1973    def Filter(self,event):
1974        if self.timer.IsRunning():
1975            self.timer.Stop()
1976        txt = self.filterBox.GetValue()
1977        self.clb.Clear()
1978        self.Update()
1979        self.filterlist = []
1980        if txt:
1981            txt = txt.lower()
1982            ChoiceList = []
1983            for i,item in enumerate(self.ChoiceList):
1984                if item.lower().find(txt) != -1:
1985                    ChoiceList.append(item)
1986                    self.filterlist.append(i)
1987        else:
1988            self.filterlist = range(len(self.ChoiceList))
1989            ChoiceList = self.ChoiceList
1990        self.clb.AppendItems(ChoiceList)
1991        self.OKbtn.Enable(True)
1992    def onDoubleClick(self,event):
1993        self.EndModal(wx.ID_OK)
1994       
1995################################################################################
1996class FlagSetDialog(wx.Dialog):
1997    ''' Creates popup with table of variables to be checked for e.g. refinement flags
1998    '''
1999    def __init__(self,parent,title,colnames,rownames,flags):
2000        wx.Dialog.__init__(self,parent,-1,title,
2001            pos=wx.DefaultPosition,style=wx.DEFAULT_DIALOG_STYLE)
2002        self.panel = None
2003        self.colnames = colnames
2004        self.rownames = rownames
2005        self.flags = flags
2006        self.newflags = copy.copy(flags)
2007        self.Draw()
2008       
2009    def Draw(self):
2010        Indx = {}
2011       
2012        def OnSelection(event):
2013            Obj = event.GetEventObject()
2014            [name,ia] = Indx[Obj.GetId()]
2015            self.newflags[name][ia] = Obj.GetValue()
2016           
2017        if self.panel:
2018            self.panel.DestroyChildren()  #safe: wx.Panel
2019            self.panel.Destroy()
2020        self.panel = wx.Panel(self)
2021        mainSizer = wx.BoxSizer(wx.VERTICAL)
2022        flagSizer = wx.FlexGridSizer(0,len(self.colnames),5,5)
2023        for item in self.colnames:
2024            flagSizer.Add(wx.StaticText(self.panel,label=item),0,WACV)
2025        for ia,atm in enumerate(self.rownames):
2026            flagSizer.Add(wx.StaticText(self.panel,label=atm),0,WACV)
2027            for name in self.colnames[1:]:
2028                if self.flags[name][ia]:
2029                    self.newflags[name][ia] = False     #default is off
2030                    flg = wx.CheckBox(self.panel,-1,label='')
2031                    flg.Bind(wx.EVT_CHECKBOX,OnSelection)
2032                    Indx[flg.GetId()] = [name,ia]
2033                    flagSizer.Add(flg,0,WACV)
2034                else:
2035                    flagSizer.Add(wx.StaticText(self.panel,label='na'),0,WACV)
2036           
2037        mainSizer.Add(flagSizer,0)
2038        OkBtn = wx.Button(self.panel,-1,"Ok")
2039        OkBtn.Bind(wx.EVT_BUTTON, self.OnOk)
2040        CancelBtn = wx.Button(self.panel,-1,'Cancel')
2041        CancelBtn.Bind(wx.EVT_BUTTON, self.OnCancel)
2042        btnSizer = wx.BoxSizer(wx.HORIZONTAL)
2043        btnSizer.Add((20,20),1)
2044        btnSizer.Add(OkBtn)
2045        btnSizer.Add(CancelBtn)
2046        btnSizer.Add((20,20),1)
2047        mainSizer.Add(btnSizer,0,wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
2048        self.panel.SetSizer(mainSizer)
2049        self.panel.Fit()
2050        self.Fit()
2051       
2052    def GetSelection(self):
2053        return self.newflags
2054
2055    def OnOk(self,event):
2056        parent = self.GetParent()
2057        parent.Raise()
2058        self.EndModal(wx.ID_OK)             
2059       
2060    def OnCancel(self,event):
2061        parent = self.GetParent()
2062        parent.Raise()
2063        self.EndModal(wx.ID_CANCEL)
2064
2065###################################################################,#############
2066def G2MessageBox(parent,msg,title='Error'):
2067    '''Simple code to display a error or warning message
2068    '''
2069    dlg = wx.MessageDialog(parent,StripIndents(msg), title, wx.OK)
2070    dlg.ShowModal()
2071    dlg.Destroy()
2072   
2073################################################################################
2074class PickTwoDialog(wx.Dialog):
2075    '''This does not seem to be in use
2076    '''
2077    def __init__(self,parent,title,prompt,names,choices):
2078        wx.Dialog.__init__(self,parent,-1,title, 
2079            pos=wx.DefaultPosition,style=wx.DEFAULT_DIALOG_STYLE)
2080        self.panel = None
2081        self.prompt = prompt
2082        self.choices = choices
2083        self.names = names
2084        self.Draw()
2085
2086    def Draw(self):
2087        Indx = {}
2088       
2089        def OnSelection(event):
2090            Obj = event.GetEventObject()
2091            id = Indx[Obj.GetId()]
2092            self.choices[id] = Obj.GetValue().encode()  #to avoid Unicode versions
2093            self.Draw()
2094           
2095        if self.panel:
2096            self.panel.DestroyChildren()  #safe: wx.Panel
2097            self.panel.Destroy()
2098        self.panel = wx.Panel(self)
2099        mainSizer = wx.BoxSizer(wx.VERTICAL)
2100        mainSizer.Add(wx.StaticText(self.panel,-1,self.prompt),0,wx.ALIGN_CENTER)
2101        for isel,name in enumerate(self.choices):
2102            lineSizer = wx.BoxSizer(wx.HORIZONTAL)
2103            lineSizer.Add(wx.StaticText(self.panel,-1,'Reference atom '+str(isel+1)),0,wx.ALIGN_CENTER)
2104            nameList = self.names[:]
2105            if isel:
2106                if self.choices[0] in nameList:
2107                    nameList.remove(self.choices[0])
2108            choice = wx.ComboBox(self.panel,-1,value=name,choices=nameList,
2109                style=wx.CB_READONLY|wx.CB_DROPDOWN)
2110            Indx[choice.GetId()] = isel
2111            choice.Bind(wx.EVT_COMBOBOX, OnSelection)
2112            lineSizer.Add(choice,0,WACV)
2113            mainSizer.Add(lineSizer)
2114        OkBtn = wx.Button(self.panel,-1,"Ok")
2115        OkBtn.Bind(wx.EVT_BUTTON, self.OnOk)
2116        CancelBtn = wx.Button(self.panel,-1,'Cancel')
2117        CancelBtn.Bind(wx.EVT_BUTTON, self.OnCancel)
2118        btnSizer = wx.BoxSizer(wx.HORIZONTAL)
2119        btnSizer.Add((20,20),1)
2120        btnSizer.Add(OkBtn)
2121        btnSizer.Add(CancelBtn)
2122        btnSizer.Add((20,20),1)
2123        mainSizer.Add(btnSizer,0,wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
2124        self.panel.SetSizer(mainSizer)
2125        self.panel.Fit()
2126        self.Fit()
2127       
2128    def GetSelection(self):
2129        return self.choices
2130
2131    def OnOk(self,event):
2132        parent = self.GetParent()
2133        parent.Raise()
2134        self.EndModal(wx.ID_OK)             
2135       
2136    def OnCancel(self,event):
2137        parent = self.GetParent()
2138        parent.Raise()
2139        self.EndModal(wx.ID_CANCEL)
2140
2141################################################################################
2142class SingleFloatDialog(wx.Dialog):
2143    '''Dialog to obtain a single float value from user
2144
2145    :param wx.Frame parent: name of parent frame
2146    :param str title: title string for dialog
2147    :param str prompt: string to tell user what they are inputing
2148    :param str value: default input value, if any
2149    :param list limits: upper and lower value used to set bounds for entry, use [None,None]
2150      for no bounds checking, [None,val] for only upper bounds, etc. Default is [0,1].
2151      Values outside of limits will be ignored.
2152    :param str format: string to format numbers. Defaults to '%.5g'. Use '%d' to have
2153      integer input (but dlg.GetValue will still return a float).
2154   
2155    Typical usage::
2156
2157            limits = (0,1)
2158            dlg = G2G.SingleFloatDialog(G2frame,'New value','Enter new value for...',default,limits)
2159            if dlg.ShowModal() == wx.ID_OK:
2160                parm = dlg.GetValue()
2161            dlg.Destroy()   
2162
2163    '''
2164    # TODO: better to generalize this for int & float, use validated text control, OK as default.
2165    # then make SingleFloatDialog & SingleIntDialog as wrappers. Would be good to remove the %-style
2166    # format, too.
2167    def __init__(self,parent,title,prompt,value,limits=[0.,1.],format='%.5g'):
2168        wx.Dialog.__init__(self,parent,-1,title, 
2169            pos=wx.DefaultPosition,style=wx.DEFAULT_DIALOG_STYLE)
2170        self.panel = None
2171        self.limits = limits
2172        self.value = value
2173        self.prompt = prompt
2174        self.format = format
2175        self.Draw()
2176       
2177    def Draw(self):
2178       
2179        def OnValItem(event):
2180            if event: event.Skip()
2181            try:
2182                val = float(valItem.GetValue())
2183                if self.limits[0] is not None and val < self.limits[0]:
2184                    raise ValueError
2185                if self.limits[1] is not None and val > self.limits[1]:
2186                    raise ValueError
2187            except ValueError:
2188                val = self.value
2189            self.value = val
2190            valItem.SetValue(self.format%(self.value))
2191           
2192        if self.panel: self.panel.Destroy()
2193        self.panel = wx.Panel(self)
2194        mainSizer = wx.BoxSizer(wx.VERTICAL)
2195        mainSizer.Add(wx.StaticText(self.panel,-1,self.prompt),0,wx.ALIGN_CENTER)
2196        valItem = wx.TextCtrl(self.panel,-1,value=self.format%(self.value),style=wx.TE_PROCESS_ENTER)
2197        mainSizer.Add(valItem,0,wx.ALIGN_CENTER)
2198        valItem.Bind(wx.EVT_TEXT_ENTER,OnValItem)
2199        valItem.Bind(wx.EVT_KILL_FOCUS,OnValItem)
2200        OkBtn = wx.Button(self.panel,-1,"Ok")
2201        OkBtn.Bind(wx.EVT_BUTTON, self.OnOk)
2202        CancelBtn = wx.Button(self.panel,-1,'Cancel')
2203        CancelBtn.Bind(wx.EVT_BUTTON, self.OnCancel)
2204        btnSizer = wx.BoxSizer(wx.HORIZONTAL)
2205        btnSizer.Add((20,20),1)
2206        btnSizer.Add(OkBtn)
2207        btnSizer.Add(CancelBtn)
2208        btnSizer.Add((20,20),1)
2209        mainSizer.Add(btnSizer,0,wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
2210        self.panel.SetSizer(mainSizer)
2211        self.panel.Fit()
2212        self.Fit()
2213
2214    def GetValue(self):
2215        return self.value
2216       
2217    def OnOk(self,event):
2218        parent = self.GetParent()
2219        parent.Raise()
2220        self.EndModal(wx.ID_OK)             
2221       
2222    def OnCancel(self,event):
2223        parent = self.GetParent()
2224        parent.Raise()
2225        self.EndModal(wx.ID_CANCEL)
2226
2227class SingleIntDialog(SingleFloatDialog):
2228    '''Dialog to obtain a single int value from user
2229
2230    :param wx.Frame parent: name of parent frame
2231    :param str title: title string for dialog
2232    :param str prompt: string to tell user what they are inputing
2233    :param str value: default input value, if any
2234    :param list limits: upper and lower value used to set bounds for entries. Default
2235      is [None,None] -- for no bounds checking; use [None,val] for only upper bounds, etc.
2236      Default is [0,1]. Values outside of limits will be ignored.
2237   
2238    Typical usage::
2239
2240            limits = (0,None)  # allows zero or positive values only
2241            dlg = G2G.SingleIntDialog(G2frame,'New value','Enter new value for...',default,limits)
2242            if dlg.ShowModal() == wx.ID_OK:
2243                parm = dlg.GetValue()
2244            dlg.Destroy()   
2245
2246    '''
2247    def __init__(self,parent,title,prompt,value,limits=[None,None]):
2248        SingleFloatDialog.__init__(self,parent,title,prompt,value,limits=limits,format='%d')
2249    def GetValue(self):
2250        return int(self.value)
2251
2252################################################################################
2253class MultiDataDialog(wx.Dialog):
2254    'Dialog to obtain multiple values from user'
2255    def __init__(self,parent,title,prompts,values,limits=[[0.,1.],],formats=['%.5g',]):
2256        wx.Dialog.__init__(self,parent,-1,title, 
2257            pos=wx.DefaultPosition,style=wx.DEFAULT_DIALOG_STYLE)
2258        self.panel = None
2259        self.limits = limits
2260        self.values = values
2261        self.prompts = prompts
2262        self.formats = formats
2263        self.Draw()
2264       
2265    def Draw(self):
2266       
2267        def OnValItem(event):
2268            if event: event.Skip()
2269            Obj = event.GetEventObject()
2270            format = Indx[Obj][-1]
2271            if type(format) is list:
2272                id,idl,limits = Indx[Obj][:3]
2273                self.values[id][idl] = Obj.GetValue()
2274            elif 'bool' in format:
2275                self.values[Indx[Obj][0]] = Obj.GetValue()
2276            elif 'str' in format:
2277                id,limits = Indx[Obj][:2]
2278                try:
2279                    val = Obj.GetValue()
2280                    if val not in limits:
2281                        raise ValueError
2282                except ValueError:
2283                    val = self.values[id]
2284                self.values[id] = val
2285                Obj.SetValue('%s'%(val))
2286            elif 'choice' in format:
2287                self.values[Indx[Obj][0]] = Obj.GetValue()
2288            else:
2289                id,limits = Indx[Obj][:2]
2290                try:
2291                    val = float(Obj.GetValue())
2292                    if val < limits[0] or val > limits[1]:
2293                        raise ValueError
2294                except ValueError:
2295                    val = self.values[id]
2296                self.values[id] = val
2297                Obj.SetValue(format%(val))
2298           
2299        Indx = {}
2300        if self.panel: self.panel.Destroy()
2301        self.panel = wx.Panel(self)
2302        mainSizer = wx.BoxSizer(wx.VERTICAL)
2303        lineSizer = wx.FlexGridSizer(0,2,5,5)
2304        for id,[prompt,value,limits,format] in enumerate(zip(self.prompts,self.values,self.limits,self.formats)):
2305            lineSizer.Add(wx.StaticText(self.panel,label=prompt),0,wx.ALIGN_CENTER)
2306            if type(format) is list:  #let's assume these are 'choice' for now
2307                valItem = wx.BoxSizer(wx.HORIZONTAL)
2308                for idl,item in enumerate(format):
2309                    listItem = wx.ComboBox(self.panel,value=limits[idl][0],choices=limits[idl],style=wx.CB_READONLY|wx.CB_DROPDOWN)
2310                    listItem.Bind(wx.EVT_COMBOBOX,OnValItem)
2311                    valItem.Add(listItem,0,WACV)
2312                    Indx[listItem] = [id,idl,limits,format]
2313            elif 'bool' in format:
2314                valItem = wx.CheckBox(self.panel,label='')
2315                valItem.Bind(wx.EVT_CHECKBOX,OnValItem)
2316                valItem.SetValue(value)
2317            elif 'str' in format:
2318                valItem = wx.TextCtrl(self.panel,value='%s'%(value),style=wx.TE_PROCESS_ENTER)
2319                valItem.Bind(wx.EVT_TEXT_ENTER,OnValItem)
2320                valItem.Bind(wx.EVT_KILL_FOCUS,OnValItem)
2321                valItem.SetValue('%s'%value)
2322            elif 'choice' in format:
2323                valItem = wx.ComboBox(self.panel,value=limits[0],choices=limits,style=wx.CB_READONLY|wx.CB_DROPDOWN)
2324                valItem.Bind(wx.EVT_COMBOBOX,OnValItem)
2325            else:
2326                valItem = wx.TextCtrl(self.panel,value=format%(value),style=wx.TE_PROCESS_ENTER)
2327                valItem.Bind(wx.EVT_TEXT_ENTER,OnValItem)
2328                valItem.Bind(wx.EVT_KILL_FOCUS,OnValItem)
2329            Indx[valItem] = [id,limits,format]
2330            lineSizer.Add(valItem,0,wx.ALIGN_CENTER)
2331        mainSizer.Add(lineSizer)
2332        OkBtn = wx.Button(self.panel,-1,"Ok")
2333        OkBtn.Bind(wx.EVT_BUTTON, self.OnOk)
2334        CancelBtn = wx.Button(self.panel,-1,'Cancel')
2335        CancelBtn.Bind(wx.EVT_BUTTON, self.OnCancel)
2336        btnSizer = wx.BoxSizer(wx.HORIZONTAL)
2337        btnSizer.Add((20,20),1)
2338        btnSizer.Add(OkBtn)
2339        btnSizer.Add(CancelBtn)
2340        btnSizer.Add((20,20),1)
2341        mainSizer.Add(btnSizer,0,wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
2342        self.panel.SetSizer(mainSizer)
2343        self.panel.Fit()
2344        self.Fit()
2345
2346    def GetValues(self):
2347        return self.values
2348       
2349    def OnOk(self,event):
2350        parent = self.GetParent()
2351        parent.Raise()
2352        self.EndModal(wx.ID_OK)             
2353       
2354    def OnCancel(self,event):
2355        parent = self.GetParent()
2356        parent.Raise()
2357        self.EndModal(wx.ID_CANCEL)
2358
2359################################################################################
2360class SingleStringDialog(wx.Dialog):
2361    '''Dialog to obtain a single string value from user
2362   
2363    :param wx.Frame parent: name of parent frame
2364    :param str title: title string for dialog
2365    :param str prompt: string to tell use what they are inputting
2366    :param str value: default input value, if any
2367    '''
2368    def __init__(self,parent,title,prompt,value='',size=(200,-1),help=''):
2369        wx.Dialog.__init__(self,parent,wx.ID_ANY,title,pos=wx.DefaultPosition,
2370            style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
2371        self.value = value
2372        self.prompt = prompt
2373        self.CenterOnParent()
2374        self.panel = wx.Panel(self)
2375        mainSizer = wx.BoxSizer(wx.VERTICAL)
2376        mainSizer.Add(wx.StaticText(self.panel,-1,self.prompt),0,wx.ALIGN_CENTER)
2377        sizer1 = wx.BoxSizer(wx.HORIZONTAL)
2378        self.valItem = wx.TextCtrl(self.panel,-1,value=self.value,size=size)
2379        sizer1.Add(self.valItem,0,wx.ALIGN_CENTER)
2380        if help:
2381            sizer1.Add(HelpButton(self.panel,help),0,wx.ALIGN_RIGHT|wx.ALL)
2382        mainSizer.Add(sizer1,0,wx.ALIGN_CENTER)
2383        btnsizer = wx.StdDialogButtonSizer()
2384        OKbtn = wx.Button(self.panel, wx.ID_OK)
2385        OKbtn.SetDefault()
2386        btnsizer.AddButton(OKbtn)
2387        btn = wx.Button(self.panel, wx.ID_CANCEL)
2388        btnsizer.AddButton(btn)
2389        btnsizer.Realize()
2390        mainSizer.Add(btnsizer,0,wx.ALIGN_CENTER)
2391        self.panel.SetSizer(mainSizer)
2392        self.panel.Fit()
2393        self.Fit()
2394
2395    def Show(self):
2396        '''Use this method after creating the dialog to post it
2397        :returns: True if the user pressed OK; False if the User pressed Cancel
2398        '''
2399        if self.ShowModal() == wx.ID_OK:
2400            self.value = self.valItem.GetValue()
2401            return True
2402        else:
2403            return False
2404
2405    def GetValue(self):
2406        '''Use this method to get the value entered by the user
2407        :returns: string entered by user
2408        '''
2409        return self.value
2410
2411################################################################################
2412class MultiStringDialog(wx.Dialog):
2413    '''Dialog to obtain a multi string values from user
2414   
2415    :param wx.Frame parent: name of parent frame
2416    :param str title: title string for dialog
2417    :param str prompts: strings to tell use what they are inputting
2418    :param str values: default input values, if any
2419    :param int size: length of the input box in pixels
2420    '''
2421    def __init__(self,parent,title,prompts,values=[],size=-1):
2422       
2423        wx.Dialog.__init__(self,parent,wx.ID_ANY,title, 
2424                           pos=wx.DefaultPosition,
2425                           style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
2426        self.values = values
2427        self.prompts = prompts
2428        self.CenterOnParent()
2429        mainSizer = wx.BoxSizer(wx.VERTICAL)
2430        promptSizer = wx.FlexGridSizer(0,2,5,5)
2431        self.Indx = {}
2432        for prompt,value in zip(prompts,values):
2433            promptSizer.Add(wx.StaticText(self,-1,prompt),0,WACV)
2434            valItem = wx.TextCtrl(self,-1,value=value,style=wx.TE_PROCESS_ENTER,size=(size,-1))
2435            self.Indx[valItem.GetId()] = prompt
2436            valItem.Bind(wx.EVT_TEXT,self.newValue)
2437            promptSizer.Add(valItem,1,WACV|wx.EXPAND,1)
2438        mainSizer.Add(promptSizer,1,wx.ALL|wx.EXPAND,1)
2439        btnsizer = wx.StdDialogButtonSizer()
2440        OKbtn = wx.Button(self, wx.ID_OK)
2441        OKbtn.SetDefault()
2442        btnsizer.AddButton(OKbtn)
2443        btn = wx.Button(self, wx.ID_CANCEL)
2444        btnsizer.AddButton(btn)
2445        btnsizer.Realize()
2446        mainSizer.Add(btnsizer,0,wx.ALIGN_CENTER)
2447        self.SetSizer(mainSizer)
2448        self.Fit()
2449       
2450    def newValue(self,event):
2451        Obj = event.GetEventObject()
2452        item = self.Indx[Obj.GetId()]
2453        id = self.prompts.index(item)
2454        self.values[id] = Obj.GetValue()
2455
2456    def Show(self):
2457        '''Use this method after creating the dialog to post it
2458        :returns: True if the user pressed OK; False if the User pressed Cancel
2459        '''
2460        if self.ShowModal() == wx.ID_OK:
2461            return True
2462        else:
2463            return False
2464
2465    def GetValues(self):
2466        '''Use this method to get the value entered by the user
2467        :returns: string entered by user
2468        '''
2469        return self.values
2470
2471################################################################################
2472class G2ColumnIDDialog(wx.Dialog):
2473    '''A dialog for matching column data to desired items; some columns may be ignored.
2474   
2475    :param wx.Frame ParentFrame: reference to parent frame
2476    :param str title: heading above list of choices
2477    :param str header: Title to place on window frame
2478    :param list ChoiceList: a list of possible choices for the columns
2479    :param list ColumnData: lists of column data to be matched with ChoiceList
2480    :param bool monoFont: If False (default), use a variable-spaced font;
2481      if True use a equally-spaced font.
2482    :param kw: optional keyword parameters for the wx.Dialog may
2483      be included such as size [which defaults to `(320,310)`] and
2484      style (which defaults to ``wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER | wx.CENTRE | wx.OK | wx.CANCEL``);
2485      note that ``wx.OK`` and ``wx.CANCEL`` controls
2486      the presence of the eponymous buttons in the dialog.
2487    :returns: the name of the created dialog
2488   
2489    '''
2490
2491    def __init__(self,parent, title, header,Comments,ChoiceList, ColumnData,
2492                 monoFont=False, **kw):
2493
2494        def OnOk(sevent):
2495            OK = True
2496            selCols = []
2497            for col in self.sel:
2498                item = col.GetValue()
2499                if item != ' ' and item in selCols:
2500                    OK = False
2501                    break
2502                else:
2503                    selCols.append(item)
2504            parent = self.GetParent()
2505            if not OK:
2506                parent.ErrorDialog('Duplicate',item+' selected more than once')
2507                return
2508            parent.Raise()
2509            self.EndModal(wx.ID_OK)
2510           
2511        def OnModify(event):
2512            if event: event.Skip()
2513            Obj = event.GetEventObject()
2514            icol,colData = Indx[Obj.GetId()]
2515            modify = Obj.GetValue()
2516            if not modify:
2517                return
2518            #print 'Modify column',icol,' by', modify
2519            for i,item in enumerate(self.ColumnData[icol]):
2520                self.ColumnData[icol][i] = str(eval(item+modify))
2521            colData.SetValue('\n'.join(self.ColumnData[icol]))
2522            Obj.SetValue('')
2523           
2524        # process keyword parameters, notably style
2525        options = {'size':(600,310), # default Frame keywords
2526                   'style':wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL,
2527                   }
2528        options.update(kw)
2529        self.Comments = ''.join(Comments)
2530        self.ChoiceList = ChoiceList
2531        self.ColumnData = ColumnData
2532        nCol = len(ColumnData)
2533        if options['style'] & wx.OK:
2534            useOK = True
2535            options['style'] ^= wx.OK
2536        else:
2537            useOK = False
2538        if options['style'] & wx.CANCEL:
2539            useCANCEL = True
2540            options['style'] ^= wx.CANCEL
2541        else:
2542            useCANCEL = False       
2543        # create the dialog frame
2544        wx.Dialog.__init__(self,parent,wx.ID_ANY,header,**options)
2545        panel = wxscroll.ScrolledPanel(self)
2546        # fill the dialog
2547        Sizer = wx.BoxSizer(wx.VERTICAL)
2548        Sizer.Add((-1,5))
2549        Sizer.Add(wx.StaticText(panel,label=title),0,WACV)
2550        if self.Comments:
2551            Sizer.Add(wx.StaticText(panel,label=' Header lines:'),0,WACV)
2552            Sizer.Add(wx.TextCtrl(panel,value=self.Comments,size=(200,-1),
2553                style=wx.TE_MULTILINE|wx.TE_READONLY|wx.TE_DONTWRAP),0,wx.ALL|wx.EXPAND|WACV,8)
2554        columnsSizer = wx.FlexGridSizer(0,nCol,5,10)
2555        self.sel = []
2556        self.mod = []
2557        Indx = {}
2558        for icol,col in enumerate(self.ColumnData):
2559            colSizer = wx.BoxSizer(wx.VERTICAL)
2560            colSizer.Add(wx.StaticText(panel,label=' Column #%d Select:'%(icol)),0,WACV)
2561            self.sel.append(wx.ComboBox(panel,value=' ',choices=self.ChoiceList,style=wx.CB_READONLY|wx.CB_DROPDOWN))
2562            colSizer.Add(self.sel[-1])
2563            colData = wx.TextCtrl(panel,value='\n'.join(self.ColumnData[icol]),size=(120,-1),
2564                style=wx.TE_MULTILINE|wx.TE_READONLY|wx.TE_DONTWRAP)
2565            colSizer.Add(colData,0,WACV)
2566            colSizer.Add(wx.StaticText(panel,label=' Modify by:'),0,WACV)
2567            mod = wx.TextCtrl(panel,size=(120,-1),value='',style=wx.TE_PROCESS_ENTER)
2568            mod.Bind(wx.EVT_TEXT_ENTER,OnModify)
2569            mod.Bind(wx.EVT_KILL_FOCUS,OnModify)
2570            Indx[mod.GetId()] = [icol,colData]
2571            colSizer.Add(mod,0,WACV)
2572            columnsSizer.Add(colSizer)
2573        Sizer.Add(columnsSizer)
2574        Sizer.Add(wx.StaticText(panel,label=' For modify by, enter arithmetic string eg. "-12345.67". "+","-","*","/","**" all allowed'),0,WACV) 
2575        Sizer.Add((-1,10))
2576        # OK/Cancel buttons
2577        btnsizer = wx.StdDialogButtonSizer()
2578        if useOK:
2579            self.OKbtn = wx.Button(panel, wx.ID_OK)
2580            self.OKbtn.SetDefault()
2581            btnsizer.AddButton(self.OKbtn)
2582            self.OKbtn.Bind(wx.EVT_BUTTON, OnOk)
2583        if useCANCEL:
2584            btn = wx.Button(panel, wx.ID_CANCEL)
2585            btnsizer.AddButton(btn)
2586        btnsizer.Realize()
2587        Sizer.Add((-1,5))
2588        Sizer.Add(btnsizer,0,wx.ALIGN_LEFT,20)
2589        Sizer.Add((-1,5))
2590        # OK done, let's get outa here
2591        panel.SetSizer(Sizer)
2592        panel.SetAutoLayout(1)
2593        panel.SetupScrolling()
2594        Size = [450,375]
2595        panel.SetSize(Size)
2596        Size[0] += 25; Size[1]+= 25
2597        self.SetSize(Size)
2598       
2599    def GetSelection(self):
2600        'Returns the selected sample parm for each column'
2601        selCols = []
2602        for item in self.sel:
2603            selCols.append(item.GetValue())
2604        return selCols,self.ColumnData
2605   
2606################################################################################
2607class G2HistoDataDialog(wx.Dialog):
2608    '''A dialog for editing histogram data globally.
2609   
2610    :param wx.Frame ParentFrame: reference to parent frame
2611    :param str title: heading above list of choices
2612    :param str header: Title to place on window frame
2613    :param list ParmList: a list of names for the columns
2614    :param list ParmFmt: a list of formatting strings for the columns
2615    :param list: HistoList: a list of histogram names
2616    :param list ParmData: a list of lists of data matched to ParmList; one for each item in HistoList
2617    :param bool monoFont: If False (default), use a variable-spaced font;
2618      if True use a equally-spaced font.
2619    :param kw: optional keyword parameters for the wx.Dialog may
2620      be included such as size [which defaults to `(320,310)`] and
2621      style (which defaults to
2622      ``wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER | wx.CENTRE | wx.OK | wx.CANCEL``);
2623      note that ``wx.OK`` and ``wx.CANCEL`` controls the presence of the eponymous buttons in the dialog.
2624    :returns: the modified ParmData
2625   
2626    '''
2627
2628    def __init__(self,parent, title, header,ParmList,ParmFmt,HistoList,ParmData,
2629                 monoFont=False, **kw):
2630
2631        def OnOk(sevent):
2632            parent.Raise()
2633            self.EndModal(wx.ID_OK)
2634           
2635        def OnModify(event):
2636            Obj = event.GetEventObject()
2637            irow,it = Indx[Obj.GetId()]
2638            try:
2639                val = float(Obj.GetValue())
2640            except ValueError:
2641                val = self.ParmData[irow][it]
2642            self.ParmData[irow][it] = val
2643            Obj.SetValue(self.ParmFmt[it]%val)
2644                       
2645        # process keyword parameters, notably style
2646        options = {'size':(600,310), # default Frame keywords
2647                   'style':wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL,
2648                   }
2649        options.update(kw)
2650        self.ParmList = ParmList
2651        self.ParmFmt = ParmFmt
2652        self.HistoList = HistoList
2653        self.ParmData = ParmData
2654        nCol = len(ParmList)
2655        if options['style'] & wx.OK:
2656            useOK = True
2657            options['style'] ^= wx.OK
2658        else:
2659            useOK = False
2660        if options['style'] & wx.CANCEL:
2661            useCANCEL = True
2662            options['style'] ^= wx.CANCEL
2663        else:
2664            useCANCEL = False       
2665        # create the dialog frame
2666        wx.Dialog.__init__(self,parent,wx.ID_ANY,header,**options)
2667        panel = wxscroll.ScrolledPanel(self)
2668        # fill the dialog
2669        Sizer = wx.BoxSizer(wx.VERTICAL)
2670        Sizer.Add((-1,5))
2671        Sizer.Add(wx.StaticText(panel,label=title),0,WACV)
2672        dataSizer = wx.FlexGridSizer(0,nCol+1,0,0)
2673        self.sel = []
2674        self.mod = []
2675        Indx = {}
2676        for item in ['Histogram',]+self.ParmList:
2677            dataSizer.Add(wx.StaticText(panel,-1,label=' %10s '%(item)),0,WACV)
2678        for irow,name in enumerate(self.HistoList):
2679            dataSizer.Add(wx.StaticText(panel,label=name),0,WACV|wx.LEFT|wx.RIGHT,10)
2680            for it,item in enumerate(self.ParmData[irow]):
2681                dat = wx.TextCtrl(panel,-1,value=self.ParmFmt[it]%(item),style=wx.TE_PROCESS_ENTER)
2682                dataSizer.Add(dat,0,WACV)
2683                dat.Bind(wx.EVT_TEXT_ENTER,OnModify)
2684                dat.Bind(wx.EVT_KILL_FOCUS,OnModify)
2685                Indx[dat.GetId()] = [irow,it]
2686        Sizer.Add(dataSizer)
2687        Sizer.Add((-1,10))
2688        # OK/Cancel buttons
2689        btnsizer = wx.StdDialogButtonSizer()
2690        if useOK:
2691            self.OKbtn = wx.Button(panel, wx.ID_OK)
2692            self.OKbtn.SetDefault()
2693            btnsizer.AddButton(self.OKbtn)
2694            self.OKbtn.Bind(wx.EVT_BUTTON, OnOk)
2695        if useCANCEL:
2696            btn = wx.Button(panel, wx.ID_CANCEL)
2697            btnsizer.AddButton(btn)
2698        btnsizer.Realize()
2699        Sizer.Add((-1,5))
2700        Sizer.Add(btnsizer,0,wx.ALIGN_LEFT,20)
2701        Sizer.Add((-1,5))
2702        # OK done, let's get outa here
2703        panel.SetSizer(Sizer)
2704        panel.SetAutoLayout(1)
2705        panel.SetupScrolling()
2706        Size = [450,375]
2707        panel.SetSize(Size)
2708        Size[0] += 25; Size[1]+= 25
2709        self.SetSize(Size)
2710       
2711    def GetData(self):
2712        'Returns the modified ParmData'
2713        return self.ParmData
2714   
2715################################################################################
2716def ItemSelector(ChoiceList, ParentFrame=None,
2717                 title='Select an item',
2718                 size=None, header='Item Selector',
2719                 useCancel=True,multiple=False):
2720    ''' Provide a wx dialog to select a single item or multiple items from list of choices
2721
2722    :param list ChoiceList: a list of choices where one will be selected
2723    :param wx.Frame ParentFrame: Name of parent frame (default None)
2724    :param str title: heading above list of choices (default 'Select an item')
2725    :param wx.Size size: Size for dialog to be created (default None -- size as needed)
2726    :param str header: Title to place on window frame (default 'Item Selector')
2727    :param bool useCancel: If True (default) both the OK and Cancel buttons are offered
2728    :param bool multiple: If True then multiple items can be selected (default False)
2729   
2730    :returns: the selection index or None or a selection list if multiple is true
2731
2732    Called by GSASIIdataGUI.OnReOrgSelSeq() Which is not fully implemented.
2733    '''
2734    if multiple:
2735        if useCancel:
2736            dlg = G2MultiChoiceDialog(
2737                ParentFrame,title, header, ChoiceList)
2738        else:
2739            dlg = G2MultiChoiceDialog(
2740                ParentFrame,title, header, ChoiceList,
2741                style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.OK|wx.CENTRE)
2742    else:
2743        if useCancel:
2744            dlg = wx.SingleChoiceDialog(
2745                ParentFrame,title, header, ChoiceList)
2746        else:
2747            dlg = wx.SingleChoiceDialog(
2748                ParentFrame,title, header,ChoiceList,
2749                style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.OK|wx.CENTRE)
2750    if size: dlg.SetSize(size)
2751    if dlg.ShowModal() == wx.ID_OK:
2752        if multiple:
2753            dlg.Destroy()
2754            return dlg.GetSelections()
2755        else:
2756            dlg.Destroy()
2757            return dlg.GetSelection()
2758    else:
2759        dlg.Destroy()
2760        return None
2761    dlg.Destroy()
2762
2763######################################################### Column-order selection dialog
2764def GetItemOrder(parent,keylist,vallookup,posdict):
2765    '''Creates a dialog where items can be ordered into columns
2766   
2767    :param list keylist: is a list of keys for column assignments
2768    :param dict vallookup: is a dict keyed by names in keylist where each item is a dict.
2769       Each inner dict contains variable names as keys and their associated values
2770    :param dict posdict: is a dict keyed by names in keylist where each item is a dict.
2771       Each inner dict contains column numbers as keys and their associated
2772       variable name as a value. This is used for both input and output.
2773       
2774    '''
2775    dlg = wx.Dialog(parent,style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
2776    sizer = wx.BoxSizer(wx.VERTICAL)
2777    spanel = OrderBox(dlg,keylist,vallookup,posdict)
2778    spanel.Fit()
2779    sizer.Add(spanel,1,wx.EXPAND)
2780    btnsizer = wx.StdDialogButtonSizer()
2781    btn = wx.Button(dlg, wx.ID_OK)
2782    btn.SetDefault()
2783    btnsizer.AddButton(btn)
2784    #btn = wx.Button(dlg, wx.ID_CANCEL)
2785    #btnsizer.AddButton(btn)
2786    btnsizer.Realize()
2787    sizer.Add(btnsizer, 0, wx.ALIGN_CENTER_VERTICAL|wx.EXPAND|wx.ALL, 5)
2788    dlg.SetSizer(sizer)
2789    sizer.Fit(dlg)
2790    dlg.ShowModal()
2791
2792################################################################################
2793class MultiIntegerDialog(wx.Dialog):
2794    '''Input a series of integers based on prompts
2795    '''
2796    def __init__(self,parent,title,prompts,values):
2797        wx.Dialog.__init__(self,parent,-1,title, 
2798            pos=wx.DefaultPosition,style=wx.DEFAULT_DIALOG_STYLE)
2799        self.panel = wx.Panel(self)         #just a dummy - gets destroyed in Draw!
2800        self.values = values
2801        self.prompts = prompts
2802        self.Draw()
2803       
2804    def Draw(self):
2805       
2806        def OnValItem(event):
2807            event.Skip()
2808            Obj = event.GetEventObject()
2809            ind = Indx[Obj.GetId()]
2810            try:
2811                val = int(Obj.GetValue())
2812                if val <= 0:
2813                    raise ValueError
2814            except ValueError:
2815                val = self.values[ind]
2816            self.values[ind] = val
2817            Obj.SetValue('%d'%(val))
2818           
2819        self.panel.Destroy()
2820        self.panel = wx.Panel(self)
2821        mainSizer = wx.BoxSizer(wx.VERTICAL)
2822        Indx = {}
2823        for ival,[prompt,value] in enumerate(zip(self.prompts,self.values)):
2824            mainSizer.Add(wx.StaticText(self.panel,-1,prompt),0,wx.ALIGN_CENTER)
2825            valItem = wx.TextCtrl(self.panel,-1,value='%d'%(value),style=wx.TE_PROCESS_ENTER)
2826            mainSizer.Add(valItem,0,wx.ALIGN_CENTER)
2827            Indx[valItem.GetId()] = ival
2828            valItem.Bind(wx.EVT_TEXT_ENTER,OnValItem)
2829            valItem.Bind(wx.EVT_KILL_FOCUS,OnValItem)
2830        OkBtn = wx.Button(self.panel,-1,"Ok")
2831        OkBtn.Bind(wx.EVT_BUTTON, self.OnOk)
2832        CancelBtn = wx.Button(self.panel,-1,'Cancel')
2833        CancelBtn.Bind(wx.EVT_BUTTON, self.OnCancel)
2834        btnSizer = wx.BoxSizer(wx.HORIZONTAL)
2835        btnSizer.Add((20,20),1)
2836        btnSizer.Add(OkBtn)
2837        btnSizer.Add(CancelBtn)
2838        btnSizer.Add((20,20),1)
2839        mainSizer.Add(btnSizer,0,wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
2840        self.panel.SetSizer(mainSizer)
2841        self.panel.Fit()
2842        self.Fit()
2843
2844    def GetValues(self):
2845        return self.values
2846       
2847    def OnOk(self,event):
2848        parent = self.GetParent()
2849        parent.Raise()
2850        self.EndModal(wx.ID_OK)             
2851       
2852    def OnCancel(self,event):
2853        parent = self.GetParent()
2854        parent.Raise()
2855        self.EndModal(wx.ID_CANCEL)
2856
2857################################################################################
2858class MultiColumnSelection(wx.Dialog):
2859    '''Defines a Dialog widget that can be used to select an item from a multicolumn list.
2860    The first column should be short, but remaining columns are word-wrapped if the
2861    length of the information extends beyond the column.
2862   
2863    When created, the dialog will be shown and <dlg>.Selection will be set to the index
2864    of the selected row, or -1. Be sure to use <dlg>.Destroy() to remove the window
2865    after reading the selection. If the dialog cannot be shown because a very old
2866    version of wxPython is in use, <dlg>.Selection will be None.
2867   
2868    :param wx.Frame parent: the parent frame (or None)
2869    :param str title: A title for the dialog window
2870    :param list colLabels: labels for each column
2871    :param list choices: a nested list with a value for each row in the table. Within each value
2872      should be a list of values for each column. There must be at least one value, but it is
2873      OK to have more or fewer values than there are column labels (colLabels). Extra are ignored
2874      and unspecified columns are left blank.
2875    :param list colWidths: a list of int values specifying the column width for each
2876      column in the table (pixels). There must be a value for every column label (colLabels).
2877    :param int height: an optional height (pixels) for the table (defaults to 400)
2878   
2879    Example use::
2880   
2881        lbls = ('col 1','col 2','col 3')
2882        choices=(['test1','explanation of test 1'],
2883                 ['b', 'a really really long line that will be word-wrapped'],
2884                 ['test3','more explanation text','optional 3rd column text'])
2885        colWidths=[200,400,100]
2886        dlg = MultiColumnSelection(frm,'select tutorial',lbls,choices,colWidths)
2887        value = choices[dlg.Selection][0]
2888        dlg.Destroy()
2889   
2890    '''
2891    def __init__(self, parent, title, colLabels, choices, colWidths, height=400, *args, **kw):
2892        if len(colLabels) != len(colWidths):
2893            raise ValueError('Length of colLabels) != colWidths')
2894        sizex = 20 # extra room for borders, etc.
2895        for i in colWidths: sizex += i
2896        wx.Dialog.__init__(self, parent, wx.ID_ANY, title, *args,
2897                           style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER,
2898                           size=(sizex,height), **kw)
2899        try:
2900            from wx.lib.wordwrap import wordwrap
2901            import wx.lib.agw.ultimatelistctrl as ULC
2902        except ImportError:
2903            self.Selection = None
2904            return
2905        mainSizer = wx.BoxSizer(wx.VERTICAL)
2906        self.list = ULC.UltimateListCtrl(self, agwStyle=ULC.ULC_REPORT|ULC.ULC_HAS_VARIABLE_ROW_HEIGHT
2907                                         |ULC.ULC_HRULES|ULC.ULC_SINGLE_SEL)
2908        for i,(lbl,wid) in enumerate(zip(colLabels, colWidths)):
2909            self.list.InsertColumn(i, lbl, width=wid)
2910        for i,item in enumerate(choices):
2911            self.list.InsertStringItem(i, item[0])
2912            for j,item in enumerate(item[1:len(colLabels)]):
2913                item = wordwrap(StripIndents(item,True), colWidths[j+1], wx.ClientDC(self))
2914                self.list.SetStringItem(i,1+j, item)
2915        # make buttons
2916        mainSizer.Add(self.list, 1, wx.EXPAND|wx.ALL, 1)
2917        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
2918        OKbtn = wx.Button(self, wx.ID_OK)
2919        OKbtn.SetDefault()
2920        btnsizer.Add(OKbtn)
2921        btn = wx.Button(self, wx.ID_CLOSE,"Cancel") 
2922        btnsizer.Add(btn)
2923        mainSizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
2924        # bindings for close of window, double-click,...
2925        OKbtn.Bind(wx.EVT_BUTTON,self._onSelect)
2926        btn.Bind(wx.EVT_BUTTON,self._onClose)
2927        self.Bind(wx.EVT_CLOSE, self._onClose)
2928        self.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self._onSelect)
2929        self.SetSizer(mainSizer)
2930        self.Selection = -1
2931        self.ShowModal()
2932    def _onClose(self,event):
2933        event.Skip()
2934        self.EndModal(wx.ID_CANCEL)
2935    def _onSelect(self,event):
2936        if self.list.GetNextSelected(-1) == -1: return
2937        self.Selection = self.list.GetNextSelected(-1)
2938        self.EndModal(wx.ID_OK)
2939       
2940################################################################################
2941class OrderBox(wxscroll.ScrolledPanel):
2942    '''Creates a panel with scrollbars where items can be ordered into columns
2943   
2944    :param list keylist: is a list of keys for column assignments
2945    :param dict vallookup: is a dict keyed by names in keylist where each item is a dict.
2946      Each inner dict contains variable names as keys and their associated values
2947    :param dict posdict: is a dict keyed by names in keylist where each item is a dict.
2948      Each inner dict contains column numbers as keys and their associated
2949      variable name as a value. This is used for both input and output.
2950     
2951    '''
2952    def __init__(self,parent,keylist,vallookup,posdict,*arg,**kw):
2953        self.keylist = keylist
2954        self.vallookup = vallookup
2955        self.posdict = posdict
2956        self.maxcol = 0
2957        for nam in keylist:
2958            posdict = self.posdict[nam]
2959            if posdict.keys():
2960                self.maxcol = max(self.maxcol, max(posdict))
2961        wxscroll.ScrolledPanel.__init__(self,parent,wx.ID_ANY,*arg,**kw)
2962        self.GBsizer = wx.GridBagSizer(4,4)
2963        self.SetBackgroundColour(WHITE)
2964        self.SetSizer(self.GBsizer)
2965        colList = [str(i) for i in range(self.maxcol+2)]
2966        for i in range(self.maxcol+1):
2967            wid = wx.StaticText(self,wx.ID_ANY,str(i),style=wx.ALIGN_CENTER)
2968            wid.SetBackgroundColour(DULL_YELLOW)
2969            wid.SetMinSize((50,-1))
2970            self.GBsizer.Add(wid,(0,i),flag=wx.ALIGN_CENTER|wx.EXPAND)
2971        self.chceDict = {}
2972        for row,nam in enumerate(self.keylist):
2973            posdict = self.posdict[nam]
2974            for col in posdict:
2975                lbl = posdict[col]
2976                pnl = wx.Panel(self,wx.ID_ANY)
2977                pnl.SetBackgroundColour(VERY_LIGHT_GREY)
2978                insize = wx.BoxSizer(wx.VERTICAL)
2979                wid = wx.Choice(pnl,wx.ID_ANY,choices=colList)
2980                insize.Add(wid,0,wx.EXPAND|wx.BOTTOM,3)
2981                wid.SetSelection(col)
2982                self.chceDict[wid] = (row,col)
2983                wid.Bind(wx.EVT_CHOICE,self.OnChoice)
2984                wid = wx.StaticText(pnl,wx.ID_ANY,lbl)
2985                insize.Add(wid,0,flag=wx.EXPAND)
2986                try:
2987                    val = G2py3.FormatSigFigs(self.vallookup[nam][lbl],maxdigits=8)
2988                except KeyError:
2989                    val = '?'
2990                wid = wx.StaticText(pnl,wx.ID_ANY,'('+val+')')
2991                insize.Add(wid,0,flag=wx.EXPAND)
2992                pnl.SetSizer(insize)
2993                self.GBsizer.Add(pnl,(row+1,col),flag=wx.EXPAND)
2994        self.SetAutoLayout(1)
2995        self.SetupScrolling()
2996        self.SetMinSize((
2997            min(700,self.GBsizer.GetSize()[0]),
2998            self.GBsizer.GetSize()[1]+20))
2999    def OnChoice(self,event):
3000        '''Called when a column is assigned to a variable
3001        '''
3002        row,col = self.chceDict[event.EventObject] # which variable was this?
3003        newcol = event.Selection # where will it be moved?
3004        if newcol == col:
3005            return # no change: nothing to do!
3006        prevmaxcol = self.maxcol # save current table size
3007        key = self.keylist[row] # get the key for the current row
3008        lbl = self.posdict[key][col] # selected variable name
3009        lbl1 = self.posdict[key].get(col+1,'') # next variable name, if any
3010        # if a posXXX variable is selected, and the next variable is posXXX, move them together
3011        repeat = 1
3012        if lbl[:3] == 'pos' and lbl1[:3] == 'int' and lbl[3:] == lbl1[3:]:
3013            repeat = 2
3014        for i in range(repeat): # process the posXXX and then the intXXX (or a single variable)
3015            col += i
3016            newcol += i
3017            if newcol in self.posdict[key]:
3018                # find first non-blank after newcol
3019                for mtcol in range(newcol+1,self.maxcol+2):
3020                    if mtcol not in self.posdict[key]: break
3021                l1 = range(mtcol,newcol,-1)+[newcol]
3022                l = range(mtcol-1,newcol-1,-1)+[col]
3023            else:
3024                l1 = [newcol]
3025                l = [col]
3026            # move all of the items, starting from the last column
3027            for newcol,col in zip(l1,l):
3028                #print 'moving',col,'to',newcol
3029                self.posdict[key][newcol] = self.posdict[key][col]
3030                del self.posdict[key][col]
3031                self.maxcol = max(self.maxcol,newcol)
3032                obj = self.GBsizer.FindItemAtPosition((row+1,col))
3033                self.GBsizer.SetItemPosition(obj.GetWindow(),(row+1,newcol))
3034                for wid in obj.GetWindow().Children:
3035                    if wid in self.chceDict:
3036                        self.chceDict[wid] = (row,newcol)
3037                        wid.SetSelection(self.chceDict[wid][1])
3038        # has the table gotten larger? If so we need new column heading(s)
3039        if prevmaxcol != self.maxcol:
3040            for i in range(prevmaxcol+1,self.maxcol+1):
3041                wid = wx.StaticText(self,wx.ID_ANY,str(i),style=wx.ALIGN_CENTER)
3042                wid.SetBackgroundColour(DULL_YELLOW)
3043                wid.SetMinSize((50,-1))
3044                self.GBsizer.Add(wid,(0,i),flag=wx.ALIGN_CENTER|wx.EXPAND)
3045            colList = [str(i) for i in range(self.maxcol+2)]
3046            for wid in self.chceDict:
3047                wid.SetItems(colList)
3048                wid.SetSelection(self.chceDict[wid][1])
3049        self.GBsizer.Layout()
3050        self.FitInside()
3051       
3052################################################################################
3053def GetImportFile(G2frame, message, defaultDir="", defaultFile="",
3054                      style=wx.FD_OPEN, parent=None,
3055                      *args, **kwargs):
3056    '''Uses a customized dialog that gets files from the appropriate import directory.
3057    Arguments are used the same as in :func:`wx.FileDialog`. Selection of
3058    multiple files is allowed if argument style includes wx.FD_MULTIPLE.
3059
3060    The default initial directory (unless overridden with argument defaultDir)
3061    is found in G2frame.TutorialImportDir, config setting Import_directory or
3062    G2frame.LastImportDir, see :func:`GetImportPath`.
3063
3064    The path of the first file entered is used to set G2frame.LastImportDir
3065    and optionally config setting Import_directory.
3066
3067    :returns: a list of files or an empty list
3068    '''
3069    if not parent: parent = G2frame
3070    dlg = wx.FileDialog(parent, message, defaultDir, defaultFile, *args,
3071                        style=style, **kwargs)
3072    pth = GetImportPath(G2frame)
3073    if not defaultDir and pth: dlg.SetDirectory(pth)
3074    try:
3075        if dlg.ShowModal() == wx.ID_OK:
3076            if style & wx.FD_MULTIPLE:
3077                filelist = dlg.GetPaths()
3078                if len(filelist) == 0: return []
3079            else:
3080                filelist = [dlg.GetPath(),]
3081            # not sure if we want to do this (why use wx.CHANGE_DIR?)
3082            if style & wx.FD_CHANGE_DIR: # to get Mac/Linux to change directory like windows!
3083                os.chdir(dlg.GetDirectory())
3084        else: # cancel was pressed
3085            return []
3086    finally:
3087        dlg.Destroy()
3088    # save the path of the first file and reset the TutorialImportDir variable
3089    pth = os.path.split(os.path.abspath(filelist[0]))[0]
3090    if GSASIIpath.GetConfigValue('Save_paths'): SaveImportDirectory(pth)
3091    G2frame.LastImportDir = pth
3092    G2frame.TutorialImportDir = None
3093    return filelist
3094
3095def GetImportPath(G2frame):
3096    '''Determines the default location to use for importing files. Tries sequentially
3097    G2frame.TutorialImportDir, config var Import_directory and G2frame.LastImportDir.
3098   
3099    :returns: a string containing the path to be used when reading files or None
3100      if none of the above are specified.
3101    '''
3102    if G2frame.TutorialImportDir:
3103        if os.path.exists(G2frame.TutorialImportDir):
3104            return G2frame.TutorialImportDir
3105        elif GSASIIpath.GetConfigValue('debug'):
3106            print('DBG_Tutorial location (TutorialImportDir) not found: '+G2frame.TutorialImportDir)
3107    pth = GSASIIpath.GetConfigValue('Import_directory')
3108    if pth:
3109        pth = os.path.expanduser(pth)
3110        if os.path.exists(pth):
3111            return pth
3112        elif GSASIIpath.GetConfigValue('debug'):
3113            print('Ignoring Config Import_directory value: '+
3114                      GSASIIpath.GetConfigValue('Import_directory'))
3115    if G2frame.LastImportDir:
3116        if os.path.exists(G2frame.LastImportDir):
3117            return G2frame.LastImportDir
3118        elif GSASIIpath.GetConfigValue('debug'):
3119            print('DBG_Warning: G2frame.LastImportDir not found = '+G2frame.LastImportDir)
3120    return None
3121
3122def GetExportPath(G2frame):
3123    '''Determines the default location to use for writing files. Tries sequentially
3124    G2frame.LastExportDir and G2frame.LastGPXdir.
3125   
3126    :returns: a string containing the path to be used when writing files or '.'
3127      if none of the above are specified.
3128    '''
3129    if G2frame.LastExportDir:
3130        return G2frame.LastExportDir
3131    elif G2frame.LastGPXdir:
3132        return G2frame.LastGPXdir
3133    else:
3134        return '.'
3135
3136################################################################################
3137class SGMessageBox(wx.Dialog):
3138    ''' Special version of MessageBox that displays space group & super space group text
3139    in two blocks
3140    '''
3141    def __init__(self,parent,title,text,table,):
3142        wx.Dialog.__init__(self,parent,wx.ID_ANY,title,pos=wx.DefaultPosition,
3143            style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
3144        self.text = text
3145        self.table = table
3146        self.panel = wx.Panel(self)
3147        mainSizer = wx.BoxSizer(wx.VERTICAL)
3148        mainSizer.Add((0,10))
3149        for line in text:
3150            mainSizer.Add(wx.StaticText(self.panel,label='     %s     '%(line)),0,WACV)
3151        ncol = self.table[0].count(',')+1
3152        tableSizer = wx.FlexGridSizer(0,2*ncol+3,0,0)
3153        j = 0
3154        for item in self.table:
3155            if 'for' in item:
3156                mainSizer.Add(tableSizer,0,wx.ALIGN_LEFT)
3157                mainSizer.Add(wx.StaticText(self.panel,label=item),0,WACV)
3158                tableSizer = wx.FlexGridSizer(0,2*ncol+3,0,0)
3159                continue
3160            num,flds = item.split(')')
3161            tableSizer.Add(wx.StaticText(self.panel,label='     %s  '%(num+')')),0,WACV|wx.ALIGN_LEFT)           
3162            flds = flds.replace(' ','').split(',')
3163            for i,fld in enumerate(flds):
3164                if i < ncol-1:
3165                    tableSizer.Add(wx.StaticText(self.panel,label='%s, '%(fld)),0,WACV|wx.ALIGN_RIGHT)
3166                else:
3167                    tableSizer.Add(wx.StaticText(self.panel,label='%s'%(fld)),0,WACV|wx.ALIGN_RIGHT)
3168            if not j%2:
3169                tableSizer.Add((20,0))
3170            j += 1
3171           
3172        def OnPrintOps(event):
3173            print(' Symmetry operations for %s:'%self.text[0].split(':')[1])
3174            for opText in G2spc.TextOps(self.text,self.table,reverse=True):
3175                print(opText.replace(' ','')) 
3176           
3177        mainSizer.Add(tableSizer,0,wx.ALIGN_LEFT)
3178        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
3179        OKbtn = wx.Button(self.panel, wx.ID_OK)
3180        OKbtn.Bind(wx.EVT_BUTTON, self.OnOk)
3181        btnsizer.Add(OKbtn)
3182        printBtn = wx.Button(self.panel,label='Print Ops')
3183        printBtn.Bind(wx.EVT_BUTTON, OnPrintOps)
3184        btnsizer.Add(printBtn)
3185        mainSizer.Add((0,10))
3186        mainSizer.Add(btnsizer,0,wx.ALIGN_CENTER)
3187        self.panel.SetSizer(mainSizer)
3188        self.panel.Fit()
3189        self.Fit()
3190        size = self.GetSize()
3191        self.SetSize([size[0]+20,size[1]])
3192
3193    def Show(self):
3194        '''Use this method after creating the dialog to post it
3195        '''
3196        self.ShowModal()
3197        return
3198
3199    def OnOk(self,event):
3200        parent = self.GetParent()
3201        parent.Raise()
3202        self.EndModal(wx.ID_OK)
3203
3204################################################################################
3205class SGMagSpinBox(wx.Dialog):
3206    ''' Special version of MessageBox that displays magnetic spin text
3207    '''
3208    def __init__(self,parent,title,text,table,Cents,names,spins,ifGray):
3209        wx.Dialog.__init__(self,parent,wx.ID_ANY,title,pos=wx.DefaultPosition,
3210            style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER,size=wx.Size(420,350))
3211        self.text = text
3212        self.table = table
3213        self.names = names
3214        Nnames = len(self.names)
3215        self.spins = spins
3216        self.ifGray = ifGray
3217        self.PrintTable = [' Magnetic symmetry operations for %s:'%self.text[0].split(':')[1],]
3218        self.panel = wxscroll.ScrolledPanel(self)
3219        mainSizer = wx.BoxSizer(wx.VERTICAL)
3220        mainSizer.Add((0,10))
3221        cents = [0,]
3222        if len(Cents) > 1:
3223            cents = self.text[-1].split(';')
3224        lentable = len(self.table)
3225        for line in self.text:
3226            mainSizer.Add(wx.StaticText(self.panel,label='     %s     '%(line)),0,WACV)
3227            if 'equivalent' in line:
3228                break
3229        ncol = self.table[0].count(',')+2
3230        nBlk = 0
3231        nG = 1
3232        if self.ifGray:
3233            nG = 2
3234        for ng in range(nG):
3235            for ic,cent in enumerate(cents):
3236                Cent = np.array(Cents[ic])
3237                if ic:
3238                    if cent: cent = cent.strip(' (').strip(')+\n')
3239                    label = '      for (%s)+'%(cent)
3240                    if ng or self.spins[nBlk*lentable] < 0:     #test for gray operators
3241                        label += "1'"
3242                    mainSizer.Add(wx.StaticText(self.panel,label=label),0,WACV)
3243                tableSizer = wx.FlexGridSizer(0,2*ncol+3,0,0)
3244                j = 0
3245                for item in self.table:
3246                    flds = item.split(')')[1]
3247                    tableSizer.Add(wx.StaticText(self.panel,label='  (%2d)  '%(j+1)),0,WACV)           
3248                    flds = flds.replace(' ','').split(',')
3249                    for i,fld in enumerate(flds):
3250                        if i < ncol-1:
3251                            text = wx.StaticText(self.panel,label='%s, '%(fld))
3252                            tableSizer.Add(text,0,WACV)
3253                        else:
3254                            text = wx.StaticText(self.panel,label='%s '%(fld))
3255                            tableSizer.Add(text,0,WACV)
3256                    text = wx.StaticText(self.panel,label=' (%s) '%(self.names[j%Nnames]))
3257                    try:
3258                        if self.spins[j+nBlk*lentable] < 0:
3259                            text.SetForegroundColour('Red')
3260                            item += ',-1'
3261                        else:
3262                            item += ',+1'
3263                    except IndexError:
3264                        print(self.spins,j,ic,lentable,self.names[j%Nnames])
3265                        item += ',+1'
3266                    M,T,S = G2spc.MagText2MTS(item.split(')')[1].replace(' ',''),CIF=False)
3267                    T = (T+Cent)%1.
3268                    item = G2spc.MT2text([M,T],reverse=True)
3269                    if S > 0:
3270                        item += ',+1'
3271                    else:
3272                        item += ',-1'
3273                    self.PrintTable.append(item.replace(' ','').lower())
3274                    tableSizer.Add(text,0,WACV)
3275                    if not j%2:
3276                        tableSizer.Add((20,0))
3277                    j += 1
3278                nBlk += 1
3279                mainSizer.Add(tableSizer,0,WACV)
3280           
3281           
3282        def OnPrintOps(event):
3283            for item in self.PrintTable:
3284                print(item)
3285           
3286        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
3287        OKbtn = wx.Button(self.panel, wx.ID_OK)
3288        btnsizer.Add(OKbtn)
3289        printBtn = wx.Button(self.panel,label='Print Ops')
3290        printBtn.Bind(wx.EVT_BUTTON, OnPrintOps)
3291        btnsizer.Add(printBtn)
3292        OKbtn.SetFocus()
3293        mainSizer.Add((0,10))
3294        mainSizer.Add(btnsizer,0,wx.ALIGN_CENTER)
3295       
3296        self.panel.SetSizer(mainSizer)
3297        self.panel.SetAutoLayout(True)
3298        self.panel.SetScrollRate(10,10)
3299        self.panel.SendSizeEvent()
3300
3301
3302    def Show(self):
3303        '''Use this method after creating the dialog to post it
3304        '''
3305        self.ShowModal()
3306        return
3307   
3308
3309################################################################################
3310class DisAglDialog(wx.Dialog):
3311    '''Distance/Angle Controls input dialog. After
3312    :meth:`ShowModal` returns, the results are found in
3313    dict :attr:`self.data`, which is accessed using :meth:`GetData`.
3314
3315    :param wx.Frame parent: reference to parent frame (or None)
3316    :param dict data: a dict containing the current
3317      search ranges or an empty dict, which causes default values
3318      to be used.
3319      Will be used to set element `DisAglCtls` in
3320      :ref:`Phase Tree Item <Phase_table>`
3321    :param dict default:  A dict containing the default
3322      search ranges for each element.
3323    :param bool Reset: if True (default), show Reset button
3324    :param bool Angle: if True (default), show angle radii
3325    '''
3326    def __init__(self,parent,data,default,Reset=True,Angle=True):
3327        text = 'Distance Angle Controls'
3328        if not Angle:
3329            text = 'Distance Controls'
3330        wx.Dialog.__init__(self,parent,wx.ID_ANY,text, 
3331            pos=wx.DefaultPosition,style=wx.DEFAULT_DIALOG_STYLE)
3332        self.default = default
3333        self.Reset = Reset
3334        self.Angle = Angle
3335        self.panel = None
3336        self._default(data,self.default)
3337        self.Draw(self.data)
3338               
3339    def _default(self,data,default):
3340        '''Set starting values for the search values, either from
3341        the input array or from defaults, if input is null
3342        '''
3343        if data:
3344            self.data = copy.deepcopy(data) # don't mess with originals
3345        else:
3346            self.data = {}
3347            self.data['Name'] = default['Name']
3348            self.data['Factors'] = [0.85,0.85]
3349            self.data['AtomTypes'] = default['AtomTypes']
3350            self.data['BondRadii'] = default['BondRadii'][:]
3351            self.data['AngleRadii'] = default['AngleRadii'][:]
3352
3353    def Draw(self,data):
3354        '''Creates the contents of the dialog. Normally called
3355        by :meth:`__init__`.
3356        '''
3357        if self.panel: self.panel.Destroy()
3358        self.panel = wx.Panel(self)
3359        mainSizer = wx.BoxSizer(wx.VERTICAL)
3360        mainSizer.Add(wx.StaticText(self.panel,-1,'Controls for phase '+data['Name']),
3361            0,WACV|wx.LEFT,10)
3362        mainSizer.Add((10,10),1)
3363       
3364        ncol = 3
3365        if not self.Angle:
3366            ncol=2
3367        radiiSizer = wx.FlexGridSizer(0,ncol,5,5)
3368        radiiSizer.Add(wx.StaticText(self.panel,-1,' Type'),0,WACV)
3369        radiiSizer.Add(wx.StaticText(self.panel,-1,'Bond radii'),0,WACV)
3370        if self.Angle:
3371            radiiSizer.Add(wx.StaticText(self.panel,-1,'Angle radii'),0,WACV)
3372        self.objList = {}
3373        for id,item in enumerate(self.data['AtomTypes']):
3374            radiiSizer.Add(wx.StaticText(self.panel,-1,' '+item),0,WACV)
3375            bRadii = ValidatedTxtCtrl(self.panel,data['BondRadii'],id,nDig=(10,3))
3376            radiiSizer.Add(bRadii,0,WACV)
3377            if self.Angle:
3378                aRadii = ValidatedTxtCtrl(self.panel,data['AngleRadii'],id,nDig=(10,3))
3379                radiiSizer.Add(aRadii,0,WACV)
3380        mainSizer.Add(radiiSizer,0,wx.EXPAND)
3381        if self.Angle:
3382            factorSizer = wx.FlexGridSizer(0,2,5,5)
3383            Names = ['Bond','Angle']
3384            for i,name in enumerate(Names):
3385                factorSizer.Add(wx.StaticText(self.panel,-1,name+' search factor'),0,WACV)
3386                bondFact = ValidatedTxtCtrl(self.panel,data['Factors'],i,nDig=(10,3))
3387                factorSizer.Add(bondFact)
3388            mainSizer.Add(factorSizer,0,wx.EXPAND)
3389       
3390        OkBtn = wx.Button(self.panel,-1,"Ok")
3391        OkBtn.Bind(wx.EVT_BUTTON, self.OnOk)
3392        btnSizer = wx.BoxSizer(wx.HORIZONTAL)
3393        btnSizer.Add((20,20),1)
3394        btnSizer.Add(OkBtn)
3395        if self.Reset:
3396            ResetBtn = wx.Button(self.panel,-1,'Reset')
3397            ResetBtn.Bind(wx.EVT_BUTTON, self.OnReset)
3398            btnSizer.Add(ResetBtn)
3399        btnSizer.Add((20,20),1)
3400        mainSizer.Add(btnSizer,0,wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
3401        self.panel.SetSizer(mainSizer)
3402        self.panel.Fit()
3403        self.Fit()
3404   
3405    def GetData(self):
3406        'Returns the values from the dialog'
3407        return self.data
3408       
3409    def OnOk(self,event):
3410        'Called when the OK button is pressed'
3411        parent = self.GetParent()
3412        parent.Raise()
3413        self.EndModal(wx.ID_OK)             
3414       
3415    def OnReset(self,event):
3416        'Called when the Reset button is pressed'
3417        data = {}
3418        self._default(data,self.default)
3419        wx.CallAfter(self.Draw,self.data)
3420               
3421################################################################################
3422class ShowLSParms(wx.Dialog):
3423    '''Create frame to show least-squares parameters
3424    '''
3425    def __init__(self,parent,title,parmDict,varyList,fullVaryList,
3426                 size=(375,430)):
3427       
3428        wx.Dialog.__init__(self,parent,wx.ID_ANY,title,size=size,
3429                           style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
3430        self.parmChoice = 'Phase'
3431        self.parmDict = parmDict
3432        self.varyList = varyList
3433        self.fullVaryList = fullVaryList
3434        self.choiceDict = {}
3435
3436        # make lists of variables of different types along with lists of parameter names, histogram #s, phase #s,...
3437        self.parmNames = sorted(list(parmDict.keys()))
3438        if '2' in platform.python_version_tuple()[0]: 
3439            basestr = basestring
3440        else:
3441            basestr = str
3442        splitNames = [item.split(':') for item in self.parmNames if len(item) > 3 and not isinstance(self.parmDict[item],basestr)]
3443        globNames = [':'.join(item) for item in splitNames if not item[0] and not item[1]]
3444        if len(globNames):
3445            self.choiceDict['Global'] = G2obj.SortVariables(globNames)
3446        self.globVars = sorted(list(set([' ',]+[item[2] for item in splitNames if not item[0] and not item[1]])))
3447        hisNames = [':'.join(item) for item in splitNames if not item[0] and item[1]]
3448        self.choiceDict['Histogram'] = G2obj.SortVariables(hisNames)
3449        self.hisNums = sorted(list(set([int(item.split(':')[1]) for item in hisNames])))
3450        self.hisNums = [' ',]+[str(item) for item in self.hisNums]
3451        self.hisVars = sorted(list(set([' ',]+[item[2] for item in splitNames if not item[0]])))
3452        phasNames = [':'.join(item) for item in splitNames if not item[1] and 'is' not in item[2]]
3453        self.choiceDict['Phase'] = G2obj.SortVariables(phasNames)
3454        self.phasNums = sorted([' ',]+list(set([item.split(':')[0] for item in phasNames])))
3455        if '' in self.phasNums: self.phasNums.remove('')
3456        self.phasVars = sorted(list(set([' ',]+[item[2] for item in splitNames if not item[1] and 'is' not in item[2]])))
3457        hapNames = [':'.join(item) for item in splitNames if item[0] and item[1]]
3458        self.choiceDict['Phase/Histo'] = G2obj.SortVariables(hapNames)
3459        self.hapVars = sorted(list(set([' ',]+[item[2] for item in splitNames if item[0] and item[1]])))
3460       
3461        self.hisNum = ' '
3462        self.phasNum = ' '
3463        self.varName = ' '
3464        self.listSel = 'Refined'
3465        self.DrawPanel()
3466       
3467    def repaintScrollTbl(self):
3468        '''Shows the selected variables
3469
3470        This routine is pretty slow when lots of variables are selected. Why?
3471        '''
3472        self.countSizer.Clear(True)
3473        self.headSizer.Clear(True)
3474        self.scrolledSizer.Clear(True)
3475        self.explainSizer.Clear(True)
3476       
3477        explainRefine = False
3478        count = 0
3479        for name in self.choiceDict[self.parmChoice]:
3480            if '2' in platform.python_version_tuple()[0]: 
3481                basestr = basestring
3482            else:
3483                basestr = str
3484            if isinstance(self.parmDict[name],basestr): continue
3485            if 'Refined' in self.listSel and (name not in self.fullVaryList
3486                                              ) and (name not in self.varyList):
3487                continue
3488            if 'Phase' in self.parmChoice:
3489                if self.phasNum != ' ' and name.split(':')[0] != self.phasNum: continue
3490            if 'Histo' in self.parmChoice:
3491                if self.hisNum != ' ' and name.split(':')[1] != self.hisNum: continue
3492            if (self.varName != ' ') and (self.varName not in name): continue
3493            try:
3494                value = G2py3.FormatSigFigs(self.parmDict[name])
3495            except TypeError:
3496                value = str(self.parmDict[name])+' -?' # unexpected
3497                #continue
3498            v = G2obj.getVarDescr(name)
3499            if v is None or v[-1] is None:
3500                self.scrolledSizer.Add((-1,-1))
3501            else:               
3502                ch = HelpButton(self.panel,G2obj.fmtVarDescr(name))
3503                self.scrolledSizer.Add(ch,0,wx.LEFT|wx.RIGHT|WACV|wx.ALIGN_CENTER,1)
3504            self.scrolledSizer.Add(wx.StaticText(self.panel,wx.ID_ANY,str(name)))
3505            if name in self.varyList:
3506                self.scrolledSizer.Add(wx.StaticText(self.panel,label='R',size=(50,-1)))   #TODO? maybe a checkbox for one stop refinemnt flag setting?
3507            elif name in self.fullVaryList:
3508                self.scrolledSizer.Add(wx.StaticText(self.panel,label='C',size=(50,-1)))
3509                explainRefine = True
3510            else:
3511                self.scrolledSizer.Add((50,-1))
3512            self.scrolledSizer.Add(wx.StaticText(self.panel,label=value),0,wx.ALIGN_RIGHT)
3513            count += 1
3514            if count > 200:
3515                msg = wx.StaticText(self,label='Too many parameters selected. Showing first 200')
3516                msg.SetBackgroundColour(wx.YELLOW)
3517                self.countSizer.Add(msg,0,wx.ALIGN_LEFT)
3518                self.countSizer.Add((-1,10))
3519                break
3520       
3521        if explainRefine:
3522            self.explainSizer.Add(
3523                wx.StaticText(self,label='"R" indicates a refined variable\n'+
3524                    '"C" indicates generated from a constraint'),0, wx.ALL,0)
3525        self.panel.SetAutoLayout(1)
3526        self.panel.SetupScrolling()
3527        self.SetMinSize(self.GetSize())        # Allow window to be enlarged but not made smaller
3528        for txt,wid,loc in zip(['','Parameter name','refine?','value'],self.scrolledSizer.GetColWidths(),
3529                           [wx.ALIGN_LEFT,wx.ALIGN_LEFT,wx.ALIGN_LEFT,wx.ALIGN_RIGHT]):
3530            self.headSizer.Add(wx.StaticText(self,wx.ID_ANY,txt,size=(wid,-1),style=loc),0,loc)
3531        self.SendSizeEvent()
3532           
3533    def DrawPanel(self):
3534        '''Draws the contents of the entire dialog. Called initially & when radio buttons are pressed
3535        '''
3536        def _OnParmSel(event):
3537            self.parmChoice = parmSel.GetStringSelection()
3538            self.varName = ' '
3539            wx.CallLater(100,self.DrawPanel)
3540           
3541        def OnPhasSel(event):
3542            event.Skip()
3543            self.phasNum = phasSel.GetValue()
3544            self.varName = ' '
3545            if varSel: varSel.SetSelection(0)
3546            wx.CallAfter(self.repaintScrollTbl)
3547
3548        def OnHistSel(event):
3549            event.Skip()
3550            self.hisNum = histSel.GetValue()
3551            self.varName = ' '
3552            if varSel: varSel.SetSelection(0)
3553            wx.CallAfter(self.repaintScrollTbl)
3554           
3555        def OnVarSel(event):
3556            event.Skip()
3557            self.varName = varSel.GetValue()
3558            self.phasNum = ' '
3559            if phasSel: phasSel.SetSelection(0)
3560            self.hisNum = ' '
3561            if histSel: histSel.SetSelection(0)
3562            wx.CallAfter(self.repaintScrollTbl)
3563           
3564        def OnListSel(event):
3565            self.listSel = listSel.GetStringSelection()
3566            wx.CallLater(100,self.DrawPanel)
3567                       
3568        def OnVarSpin(event):
3569            '''Respond when any of the SpinButton widgets are pressed'''
3570            event.Skip()
3571            Spinner = event.GetEventObject()
3572            move = Spinner.GetValue()
3573            Spinner.SetValue(0)
3574            varSel,binding = self.SpinDict[Spinner.GetId()]
3575            i = varSel.GetSelection() - move
3576            if i < 0:
3577                i = varSel.GetCount()-1
3578            elif i >= varSel.GetCount():
3579                i = 0
3580            varSel.SetSelection(i)
3581            wx.CallLater(100,binding,event)
3582
3583        def AddSpinner(varSizer,label,SelCtrl,binding):
3584            '''Add a label and a SpinButton to a Combo widget (SelCtrl)
3585            Saves a pointer to the combo widget and the callback used by that widget
3586            '''
3587            SelCtrl.Bind(wx.EVT_COMBOBOX,binding)
3588            varSizer.Add(wx.StaticText(self,label=label))
3589            varSelSizer = wx.BoxSizer(wx.HORIZONTAL)
3590            varSelSizer.Add(SelCtrl,0)
3591            varSpin = wx.SpinButton(self,style=wx.SP_VERTICAL)
3592            varSpin.SetValue(0)
3593            varSpin.SetRange(-1,1)
3594            varSpin.Bind(wx.EVT_SPIN, OnVarSpin)
3595            self.SpinDict[varSpin.GetId()] = SelCtrl,binding
3596            varSelSizer.Add(varSpin,0)
3597            varSizer.Add(varSelSizer,0)
3598           
3599        if self.GetSizer(): self.GetSizer().Clear(True)
3600        self.SpinDict = {}
3601        mainSizer = wx.BoxSizer(wx.VERTICAL)
3602        num = len(self.varyList)
3603        mainSizer.Add(wx.StaticText(self,label=' Number of refined variables: '+str(num)),0,wx.ALIGN_CENTER)
3604        if len(self.varyList) != len(self.fullVaryList):
3605            num = len(self.fullVaryList) - len(self.varyList)
3606            mainSizer.Add(wx.StaticText(self,label=' + '+str(num)+' parameters are varied via constraints'))
3607        choice = ['Phase','Phase/Histo','Histogram']
3608        if 'Global' in self.choiceDict:
3609            choice += ['Global',]
3610        parmSizer = wx.BoxSizer(wx.HORIZONTAL)
3611        parmSel = wx.RadioBox(self,wx.ID_ANY,'Parameter type:',choices=choice,
3612            majorDimension=1,style=wx.RA_SPECIFY_COLS)
3613        parmSel.Bind(wx.EVT_RADIOBOX,_OnParmSel)
3614        parmSel.SetStringSelection(self.parmChoice)
3615        parmSizer.Add(parmSel,0)
3616       
3617        selectionsSizer = wx.BoxSizer(wx.VERTICAL)       
3618        varSizer = wx.BoxSizer(wx.VERTICAL)
3619        varSel = None
3620        if self.parmChoice != 'Global': 
3621            if self.parmChoice in ['Phase',]:
3622                varSel = wx.ComboBox(self,choices=self.phasVars,value=self.varName,
3623                    style=wx.CB_READONLY|wx.CB_DROPDOWN)
3624            elif self.parmChoice in ['Histogram',]:
3625                varSel = wx.ComboBox(self,choices=self.hisVars,value=self.varName,
3626                    style=wx.CB_READONLY|wx.CB_DROPDOWN)
3627            elif self.parmChoice in ['Phase/Histo',]:
3628                varSel = wx.ComboBox(self,choices=self.hapVars,value=self.varName,
3629                    style=wx.CB_READONLY|wx.CB_DROPDOWN)
3630            AddSpinner(varSizer,'Parameter',varSel,OnVarSel)
3631        selectionsSizer.Add(varSizer,0)
3632               
3633        varSizer = wx.BoxSizer(wx.HORIZONTAL)
3634        phasSel = None
3635        if self.parmChoice in ['Phase','Phase/Histo'] and len(self.phasNums) > 1:
3636            numSizer = wx.BoxSizer(wx.VERTICAL)
3637            phasSel = wx.ComboBox(self,choices=self.phasNums,value=self.phasNum,
3638                style=wx.CB_READONLY|wx.CB_DROPDOWN)
3639            AddSpinner(numSizer,'Phase',phasSel,OnPhasSel)
3640            varSizer.Add(numSizer)
3641
3642        histSel = None
3643        if self.parmChoice in ['Histogram','Phase/Histo'] and len(self.hisNums) > 1:
3644            numSizer = wx.BoxSizer(wx.VERTICAL)
3645            histSel = wx.ComboBox(self,choices=self.hisNums,value=self.hisNum,
3646                style=wx.CB_READONLY|wx.CB_DROPDOWN)
3647            AddSpinner(numSizer,'Histogram',histSel,OnHistSel)
3648            varSizer.Add(numSizer)
3649        selectionsSizer.Add(varSizer,0)
3650        parmSizer.Add(selectionsSizer,0)
3651        mainSizer.Add(parmSizer,0)
3652       
3653        listSel = wx.RadioBox(self,wx.ID_ANY,'Parameter type:',
3654            choices=['All','Refined'],
3655            majorDimension=0,style=wx.RA_SPECIFY_COLS)
3656        listSel.SetStringSelection(self.listSel)
3657        listSel.Bind(wx.EVT_RADIOBOX,OnListSel)
3658        mainSizer.Add(listSel,0)
3659       
3660        self.countSizer = wx.BoxSizer(wx.VERTICAL)
3661        mainSizer.Add(self.countSizer)
3662        self.headSizer = wx.BoxSizer(wx.HORIZONTAL) # non-scrolling header       
3663        mainSizer.Add(self.headSizer,0)
3664        self.panel = wxscroll.ScrolledPanel(self)       
3665        self.scrolledSizer = wx.FlexGridSizer(cols=4,hgap=2,vgap=2)
3666        self.panel.SetSizer(self.scrolledSizer)
3667        mainSizer.Add(self.panel,1,wx.ALL|wx.EXPAND,1)
3668        self.explainSizer = wx.BoxSizer(wx.VERTICAL)
3669        mainSizer.Add(self.explainSizer)
3670        # make OK button
3671        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
3672        btn = wx.Button(self, wx.ID_CLOSE,"Close") 
3673        btn.Bind(wx.EVT_BUTTON,self._onClose)
3674        btnsizer.Add(btn)
3675        mainSizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
3676        self.SetSizer(mainSizer)
3677        wx.CallAfter(self.repaintScrollTbl)
3678               
3679    def _onClose(self,event):
3680        self.EndModal(wx.ID_CANCEL)
3681
3682################################################################################
3683#####  Customized Grid Support
3684################################################################################           
3685class GSGrid(wg.Grid):
3686    '''Basic wx.Grid implementation
3687    '''
3688    def __init__(self, parent, name=''):
3689        wg.Grid.__init__(self,parent,-1,name=name)
3690        if hasattr(parent.TopLevelParent,'currentGrids'):
3691            parent.TopLevelParent.currentGrids.append(self)      # save a reference to the grid in the Frame
3692        self.SetScrollRate(0,0)         #GSAS-II grids have no scroll bars by default
3693           
3694    def Clear(self):
3695        wg.Grid.ClearGrid(self)
3696       
3697    def SetCellReadOnly(self,r,c,readonly=True):
3698        self.SetReadOnly(r,c,isReadOnly=readonly)
3699       
3700    def SetCellStyle(self,r,c,color="white",readonly=True):
3701        self.SetCellBackgroundColour(r,c,color)
3702        self.SetReadOnly(r,c,isReadOnly=readonly)
3703       
3704    def GetSelection(self):
3705        #this is to satisfy structure drawing stuff in G2plt when focus changes
3706        return None
3707
3708    def InstallGridToolTip(self, rowcolhintcallback,
3709                           colLblCallback=None,rowLblCallback=None):
3710        '''code to display a tooltip for each item on a grid
3711        from http://wiki.wxpython.org/wxGrid%20ToolTips (buggy!), expanded to
3712        column and row labels using hints from
3713        https://groups.google.com/forum/#!topic/wxPython-users/bm8OARRVDCs
3714
3715        :param function rowcolhintcallback: a routine that returns a text
3716          string depending on the selected row and column, to be used in
3717          explaining grid entries.
3718        :param function colLblCallback: a routine that returns a text
3719          string depending on the selected column, to be used in
3720          explaining grid columns (if None, the default), column labels
3721          do not get a tooltip.
3722        :param function rowLblCallback: a routine that returns a text
3723          string depending on the selected row, to be used in
3724          explaining grid rows (if None, the default), row labels
3725          do not get a tooltip.
3726        '''
3727        prev_rowcol = [None,None,None]
3728        def OnMouseMotion(event):
3729            # event.GetRow() and event.GetCol() would be nice to have here,
3730            # but as this is a mouse event, not a grid event, they are not
3731            # available and we need to compute them by hand.
3732            x, y = self.CalcUnscrolledPosition(event.GetPosition())
3733            row = self.YToRow(y)
3734            col = self.XToCol(x)
3735            hinttext = ''
3736            win = event.GetEventObject()
3737            if [row,col,win] == prev_rowcol: # no change from last position
3738                if event: event.Skip()
3739                return
3740            if win == self.GetGridWindow() and row >= 0 and col >= 0:
3741                hinttext = rowcolhintcallback(row, col)
3742            elif win == self.GetGridColLabelWindow() and col >= 0:
3743                if colLblCallback: hinttext = colLblCallback(col)
3744            elif win == self.GetGridRowLabelWindow() and row >= 0:
3745                if rowLblCallback: hinttext = rowLblCallback(row)
3746            else: # this should be the upper left corner, which is empty
3747                if event: event.Skip()
3748                return
3749            if hinttext is None: hinttext = ''
3750            if 'phoenix' in wx.version():
3751                win.SetToolTip(hinttext)
3752            else:
3753                win.SetToolTipString(hinttext)
3754            prev_rowcol[:] = [row,col,win]
3755            if event: event.Skip()
3756        if 'phoenix' in wx.version():
3757            self.GetGridWindow().Bind(wx.EVT_MOTION,OnMouseMotion)
3758            if colLblCallback: self.GetGridColLabelWindow().Bind(wx.EVT_MOTION,OnMouseMotion)
3759            if rowLblCallback: self.GetGridRowLabelWindow().Bind(wx.EVT_MOTION,OnMouseMotion)
3760        else:
3761            wx.EVT_MOTION(self.GetGridWindow(), OnMouseMotion)
3762            if colLblCallback: wx.EVT_MOTION(self.GetGridColLabelWindow(), OnMouseMotion)
3763            if rowLblCallback: wx.EVT_MOTION(self.GetGridRowLabelWindow(), OnMouseMotion)
3764                                                   
3765################################################################################           
3766class Table(wg.PyGridTableBase):        #TODO: this works in python 3/phoenix but pygridtablebase doesn't exist
3767    '''Basic data table for use with GSgrid
3768    '''
3769    def __init__(self, data=[], rowLabels=None, colLabels=None, types = None):
3770        if 'phoenix' in wx.version():
3771            wg.GridTableBase.__init__(self)
3772        else:
3773            wg.PyGridTableBase.__init__(self)
3774        self.colLabels = colLabels
3775        self.rowLabels = rowLabels
3776        self.dataTypes = types
3777        self.data = data
3778       
3779    def AppendRows(self, numRows=1):
3780        self.data.append([])
3781        return True
3782       
3783    def CanGetValueAs(self, row, col, typeName):
3784        if self.dataTypes:
3785            colType = self.dataTypes[col].split(':')[0]
3786            if typeName == colType:
3787                return True
3788            else:
3789                return False
3790        else:
3791            return False
3792
3793    def CanSetValueAs(self, row, col, typeName):
3794        return self.CanGetValueAs(row, col, typeName)
3795
3796    def DeleteRow(self,pos):
3797        data = self.GetData()
3798        self.SetData([])
3799        new = []
3800        for irow,row in enumerate(data):
3801            if irow != pos:
3802                new.append(row)
3803        self.SetData(new)
3804       
3805    def GetColLabelValue(self, col):
3806        if self.colLabels:
3807            return self.colLabels[col]
3808           
3809    def GetData(self):
3810        data = []
3811        for row in range(self.GetNumberRows()):
3812            data.append(self.GetRowValues(row))
3813        return data
3814       
3815    def GetNumberCols(self):
3816        try:
3817            return len(self.colLabels)
3818        except TypeError:
3819            return None
3820       
3821    def GetNumberRows(self):
3822        return len(self.data)
3823       
3824    def GetRowLabelValue(self, row):
3825        if self.rowLabels:
3826            return self.rowLabels[row]
3827       
3828    def GetColValues(self, col):
3829        data = []
3830        for row in range(self.GetNumberRows()):
3831            data.append(self.GetValue(row, col))
3832        return data
3833       
3834    def GetRowValues(self, row):
3835        data = []
3836        for col in range(self.GetNumberCols()):
3837            data.append(self.GetValue(row, col))
3838        return data
3839       
3840    def GetTypeName(self, row, col):
3841        try:
3842            if self.data[row][col] is None:
3843                return wg.GRID_VALUE_STRING
3844            return self.dataTypes[col]
3845        except (TypeError,IndexError):
3846            return wg.GRID_VALUE_STRING
3847
3848    def GetValue(self, row, col):
3849        try:
3850            if self.data[row][col] is None: return ""
3851            return self.data[row][col]
3852        except IndexError:
3853            return None
3854           
3855    def InsertRows(self, pos, rows):
3856        for row in range(rows):
3857            self.data.insert(pos,[])
3858            pos += 1
3859       
3860    def IsEmptyCell(self,row,col):
3861        try:
3862            return not self.data[row][col]
3863        except IndexError:
3864            return True
3865       
3866    def OnKeyPress(self, event):
3867        dellist = self.GetSelectedRows()
3868        if event.GetKeyCode() == wx.WXK_DELETE and dellist:
3869            grid = self.GetView()
3870            for i in dellist: grid.DeleteRow(i)
3871               
3872    def SetColLabelValue(self, col, label):
3873        numcols = self.GetNumberCols()
3874        if col > numcols-1:
3875            self.colLabels.append(label)
3876        else:
3877            self.colLabels[col]=label
3878       
3879    def SetData(self,data):
3880        for row in range(len(data)):
3881            self.SetRowValues(row,data[row])
3882               
3883    def SetRowLabelValue(self, row, label):
3884        self.rowLabels[row]=label
3885           
3886    def SetRowValues(self,row,data):
3887        self.data[row] = data
3888           
3889    def SetValue(self, row, col, value):
3890        def innerSetValue(row, col, value):
3891            try:
3892                self.data[row][col] = value
3893            except TypeError:
3894                return
3895            except IndexError: # has this been tested?
3896                #print row,col,value
3897                # add a new row
3898                if row > self.GetNumberRows():
3899                    self.data.append([''] * self.GetNumberCols())
3900                elif col > self.GetNumberCols():
3901                    for row in range(self.GetNumberRows()): # bug fixed here
3902                        self.data[row].append('')
3903                #print self.data
3904                self.data[row][col] = value
3905        innerSetValue(row, col, value)
3906
3907################################################################################
3908class GridFractionEditor(wg.PyGridCellEditor):
3909    '''A grid cell editor class that allows entry of values as fractions as well
3910    as sine and cosine values [as s() and c()]
3911    '''
3912    def __init__(self,grid):
3913        if 'phoenix' in wx.version():
3914            wg.GridCellEditor.__init__(self)
3915        else:
3916            wg.PyGridCellEditor.__init__(self)
3917
3918    def Create(self, parent, id, evtHandler):
3919        self._tc = wx.TextCtrl(parent, id, "")
3920        self._tc.SetInsertionPoint(0)
3921        self.SetControl(self._tc)
3922
3923        if evtHandler:
3924            self._tc.PushEventHandler(evtHandler)
3925
3926        self._tc.Bind(wx.EVT_CHAR, self.OnChar)
3927
3928    def SetSize(self, rect):
3929        self._tc.SetSize(rect.x, rect.y, rect.width+2, rect.height+2,
3930                               wx.SIZE_ALLOW_MINUS_ONE)
3931
3932    def BeginEdit(self, row, col, grid):
3933        self.startValue = grid.GetTable().GetValue(row, col)
3934        self._tc.SetValue(str(self.startValue))
3935        self._tc.SetInsertionPointEnd()
3936        self._tc.SetFocus()
3937        self._tc.SetSelection(0, self._tc.GetLastPosition())
3938
3939    def EndEdit(self, row, col, grid, oldVal=None):
3940        changed = False
3941
3942        self.nextval = self.startValue
3943        val = self._tc.GetValue().lower().strip()
3944        if val != str(self.startValue):
3945            changed = True
3946            neg = False
3947            if val.startswith('-'):
3948                neg = True
3949                val = val[1:]
3950            # allow old GSAS s20 and c20 etc for sind(20) and cosd(20)
3951            if val.startswith('s') and '(' not in val:
3952                val = 'sind('+val.strip('s')+')'
3953            elif val.startswith('c') and '(' not in val:
3954                val = 'cosd('+val.strip('c')+')'
3955            if neg:
3956                val = '-' + val
3957            val = G2py3.FormulaEval(val)
3958            if val is not None:
3959                self.nextval = val
3960            else:
3961                return None
3962            if oldVal is None: # this arg appears in 2.9+; before, we should go ahead & change the table
3963                grid.GetTable().SetValue(row, col, val) # update the table
3964            # otherwise self.ApplyEdit gets called
3965
3966        self.startValue = ''
3967        self._tc.SetValue('')
3968        return changed
3969   
3970    def ApplyEdit(self, row, col, grid):
3971        """ Called only in wx >= 2.9
3972        Save the value of the control into the grid if EndEdit() returns as True
3973        """
3974        grid.GetTable().SetValue(row, col, self.nextval) # update the table
3975
3976    def Reset(self):
3977        self._tc.SetValue(self.startValue)
3978        self._tc.SetInsertionPointEnd()
3979
3980    def Clone(self,grid):
3981        return GridFractionEditor(grid)
3982
3983    def StartingKey(self, evt):
3984        self.OnChar(evt)
3985        if evt.GetSkipped():
3986            self._tc.EmulateKeyPress(evt)
3987
3988    def OnChar(self, evt):
3989        key = evt.GetKeyCode()
3990        if key < 32 or key >= 127:
3991            evt.Skip()
3992        elif chr(key).lower() in '.+-*/0123456789cosind()':
3993            evt.Skip()
3994        else:
3995            evt.StopPropagation()
3996
3997################################################################################
3998#####  Get an output file or directory
3999################################################################################           
4000def askSaveFile(G2frame,defnam,extension,longFormatName,parent=None):
4001    '''Ask the user to supply a file name
4002
4003    :param wx.Frame G2frame: The main GSAS-II window
4004    :param str defnam: a default file name
4005    :param str extension: the default file extension beginning with a '.'
4006    :param str longFormatName: a description of the type of file
4007    :param wx.Frame parent: the parent window for the dialog. Defaults
4008      to G2frame.
4009
4010    :returns: a file name (str) or None if Cancel is pressed
4011    '''
4012
4013    if not parent: parent = G2frame
4014    pth = GetExportPath(G2frame)
4015    dlg = wx.FileDialog(
4016        parent, 'Input name for file to write', pth, defnam,
4017        longFormatName+' (*'+extension+')|*'+extension,
4018        wx.FD_SAVE|wx.FD_OVERWRITE_PROMPT)
4019    dlg.CenterOnParent()
4020    try:
4021        if dlg.ShowModal() == wx.ID_OK:
4022            filename = dlg.GetPath()
4023            G2frame.LastExportDir = os.path.split(filename)[0]
4024            filename = os.path.splitext(filename)[0]+extension # make sure extension is correct
4025        else:
4026            filename = None
4027    finally:
4028        dlg.Destroy()
4029    return filename
4030
4031def askSaveDirectory(G2frame):
4032    '''Ask the user to supply a directory name. Path name is used as the
4033    starting point for the next export path search.
4034
4035    :returns: a directory name (str) or None if Cancel is pressed
4036    '''
4037    pth = GetExportPath(G2frame)
4038    dlg = wx.DirDialog(
4039            G2frame, 'Input directory where file(s) will be written', pth,
4040            wx.DD_DEFAULT_STYLE)
4041    dlg.CenterOnParent()
4042    try:
4043        if dlg.ShowModal() == wx.ID_OK:
4044            filename = dlg.GetPath()
4045            G2frame.LastExportDir = filename
4046        else:
4047            filename = None
4048    finally:
4049        dlg.Destroy()
4050    return filename
4051
4052################################################################################
4053#####  Customized Notebook
4054################################################################################           
4055class GSNoteBook(wx.aui.AuiNotebook):
4056    '''Notebook used in various locations; implemented with wx.aui extension
4057    '''
4058    def __init__(self, parent, name='',size = None,style=wx.aui.AUI_NB_TOP |
4059        wx.aui.AUI_NB_SCROLL_BUTTONS):
4060        wx.aui.AuiNotebook.__init__(self, parent, style=style)
4061        if size: self.SetSize(size)
4062        self.parent = parent
4063        self.PageChangeHandler = None
4064       
4065    def PageChangeEvent(self,event):
4066        pass
4067#        G2frame = self.parent.G2frame
4068#        page = event.GetSelection()
4069#        if self.PageChangeHandler:
4070#            if log.LogInfo['Logging']:
4071#                log.MakeTabLog(
4072#                    G2frame.dataWindow.GetTitle(),
4073#                    G2frame.dataDisplay.GetPageText(page)
4074#                    )
4075#            self.PageChangeHandler(event)
4076           
4077#    def Bind(self,eventtype,handler,*args,**kwargs):
4078#        '''Override the Bind() function so that page change events can be trapped
4079#        '''
4080#        if eventtype == wx.aui.EVT_AUINOTEBOOK_PAGE_CHANGED:
4081#            self.PageChangeHandler = handler
4082#            wx.aui.AuiNotebook.Bind(self,eventtype,self.PageChangeEvent)
4083#            return
4084#        wx.aui.AuiNotebook.Bind(self,eventtype,handler,*args,**kwargs)
4085                                                     
4086    def Clear(self):
4087        GSNoteBook.DeleteAllPages(self)
4088       
4089    def FindPage(self,name):
4090        numPage = self.GetPageCount()
4091        for page in range(numPage):
4092            if self.GetPageText(page) == name:
4093                return page
4094        return None
4095
4096    def ChangeSelection(self,page):
4097        # in wx.Notebook ChangeSelection is like SetSelection, but it
4098        # does not invoke the event related to pressing the tab button
4099        # I don't see a way to do that in aui.
4100        oldPage = self.GetSelection()
4101        self.SetSelection(page)
4102        return oldPage
4103
4104    # def __getattribute__(self,name):
4105    #     '''This method provides a way to print out a message every time
4106    #     that a method in a class is called -- to see what all the calls
4107    #     might be, or where they might be coming from.
4108    #     Cute trick for debugging!
4109    #     '''
4110    #     attr = object.__getattribute__(self, name)
4111    #     if hasattr(attr, '__call__'):
4112    #         def newfunc(*args, **kwargs):
4113    #             print('GSauiNoteBook calling %s' %attr.__name__)
4114    #             result = attr(*args, **kwargs)
4115    #             return result
4116    #         return newfunc
4117    #     else:
4118    #         return attr
4119           
4120################################################################################
4121#### Help support routines
4122################################################################################
4123class MyHelp(wx.Menu):
4124    '''
4125    A class that creates the contents of a help menu.
4126    The menu will start with two entries:
4127
4128    * 'Help on <helpType>': where helpType is a reference to an HTML page to
4129      be opened
4130    * About: opens an About dialog using OnHelpAbout. N.B. on the Mac this
4131      gets moved to the App menu to be consistent with Apple style.
4132
4133    NOTE: for this to work properly with respect to system menus, the title
4134    for the menu must be &Help, or it will not be processed properly:
4135
4136    ::
4137
4138       menu.Append(menu=MyHelp(self,...),title="&Help")
4139
4140    '''
4141    def __init__(self,frame,includeTree=False,morehelpitems=[]):
4142        wx.Menu.__init__(self,'')
4143        self.HelpById = {}
4144        self.frame = frame
4145        self.Append(wx.ID_ABOUT,'&About GSAS-II','')
4146        frame.Bind(wx.EVT_MENU, self.OnHelpAbout, id=wx.ID_ABOUT)
4147        if GSASIIpath.whichsvn():
4148            helpobj = self.Append(wx.ID_ANY,'&Check for updates','')
4149            frame.Bind(wx.EVT_MENU, self.OnCheckUpdates, helpobj)
4150            helpobj = self.Append(wx.ID_ANY,'&Regress to an old GSAS-II version','')
4151            frame.Bind(wx.EVT_MENU, self.OnSelectVersion, helpobj)
4152            # if GSASIIpath.svnTestBranch():
4153            #     msg = "&Switch back to standard GSAS-II version"
4154            # else:
4155            #     msg = "&Switch to test (2frame) GSAS-II version"
4156            # helpobj = self.Append(
4157            #     help='', id=wx.ID_ANY, kind=wx.ITEM_NORMAL,text=msg)
4158            # frame.Bind(wx.EVT_MENU, self.OnSelectBranch, helpobj)
4159        # provide special help topic names for extra items in help menu
4160        for lbl,indx in morehelpitems:
4161            helpobj = self.Append(wx.ID_ANY,lbl,'')
4162            frame.Bind(wx.EVT_MENU, self.OnHelpById, helpobj)
4163            self.HelpById[helpobj.GetId()] = indx
4164        # add help lookup(s) in gsasii.html
4165        self.AppendSeparator()
4166        if includeTree:
4167            helpobj = self.Append(wx.ID_ANY,'Help on Data tree','')
4168            frame.Bind(wx.EVT_MENU, self.OnHelpById, id=helpobj.GetId())
4169            self.HelpById[helpobj.GetId()] = 'Data tree'
4170        helpobj = self.Append(wx.ID_ANY,'Help on current data tree item','')
4171        frame.Bind(wx.EVT_MENU, self.OnHelpById, id=helpobj.GetId())
4172       
4173    def OnHelpById(self,event):
4174        '''Called when Help on... is pressed in a menu. Brings up a web page
4175        for documentation. Uses the helpKey value from the dataWindow window
4176        unless a special help key value has been defined for this menu id in
4177        self.HelpById
4178
4179        Note that self should now (2frame) be child of the main window (G2frame)
4180        '''
4181        if hasattr(self.frame,'dataWindow'):  # Debug code: check this is called from menu in G2frame
4182            # should always be true in 2 Frame version
4183            dW = self.frame.dataWindow
4184        else:
4185            print('help error: not called from standard menu?')
4186            print (self)
4187            return           
4188        try:
4189            helpKey = dW.helpKey # look up help from helpKey in data window
4190            #if GSASIIpath.GetConfigValue('debug'): print 'DBG_dataWindow help: key=',helpKey
4191        except AttributeError:
4192            helpKey = ''
4193            if GSASIIpath.GetConfigValue('debug'): print('DBG_No helpKey for current dataWindow!')
4194        helpType = self.HelpById.get(event.GetId(),helpKey) # see if there is a special help topic
4195        #if GSASIIpath.GetConfigValue('debug'): print 'DBG_helpKey=',helpKey,'  helpType=',helpType
4196        if helpType == 'Tutorials':
4197            dlg = OpenTutorial(self.frame)
4198            dlg.ShowModal()
4199            dlg.Destroy()
4200            return
4201        else:
4202            ShowHelp(helpType,self.frame)
4203
4204    def OnHelpAbout(self, event):
4205        "Display an 'About GSAS-II' box"
4206        import GSASII
4207        try:
4208            import wx.adv as wxadv  # AboutBox moved here in Phoenix
4209        except:
4210            wxadv = wx
4211        info = wxadv.AboutDialogInfo()
4212        info.Name = 'GSAS-II'
4213        ver = GSASIIpath.svnGetRev()
4214        if not ver:
4215            ver = GSASIIpath.GetVersionNumber()
4216        info.SetVersion(ver)
4217        #info.Developers = ['Robert B. Von Dreele','Brian H. Toby']
4218        info.Copyright = ('(c) ' + time.strftime('%Y') +
4219''' Argonne National Laboratory
4220This product includes software developed
4221by the UChicago Argonne, LLC, as
4222Operator of Argonne National Laboratory.''')
4223        info.Description = '''General Structure Analysis System-II (GSAS-II)
4224Robert B. Von Dreele and Brian H. Toby
4225
4226Please cite as:
4227  B.H. Toby & R.B. Von Dreele, J. Appl. Cryst. 46, 544-549 (2013)
4228For small angle use cite:
4229  R.B. Von Dreele, J. Appl. Cryst. 47, 1748-9 (2014)
4230For DIFFaX use cite:
4231  M.M.J. Treacy, J.M. Newsam & M.W. Deem,
4232  Proc. Roy. Soc. Lond. A 433, 499-520 (1991)
4233'''
4234        info.WebSite = ("https://subversion.xray.aps.anl.gov/trac/pyGSAS","GSAS-II home page")
4235        wxadv.AboutBox(info)
4236
4237    def OnCheckUpdates(self,event):
4238        '''Check if the GSAS-II repository has an update for the current source files
4239        and perform that update if requested.
4240        '''           
4241        if not GSASIIpath.whichsvn():
4242            dlg = wx.MessageDialog(self.frame,
4243                                   'No Subversion','Cannot update GSAS-II because subversion (svn) was not found.',
4244                                   wx.OK)
4245            dlg.ShowModal()
4246            dlg.Destroy()
4247            return
4248        wx.BeginBusyCursor()
4249        local = GSASIIpath.svnGetRev()
4250        if local is None: 
4251            wx.EndBusyCursor()
4252            dlg = wx.MessageDialog(self.frame,
4253                                   'Unable to run subversion on the GSAS-II current directory. Is GSAS-II installed correctly?',
4254                                   'Subversion error',
4255                                   wx.OK)
4256            dlg.ShowModal()
4257            dlg.Destroy()
4258            return
4259        print ('Installed GSAS-II version: '+local)
4260        repos = GSASIIpath.svnGetRev(local=False)
4261        wx.EndBusyCursor()
4262        # has the current branch disappeared? If so, switch to the trunk -- not fully tested
4263        if (repos is None and "not found" in GSASIIpath.svnLastError.lower()
4264            and "path" in GSASIIpath.svnLastError.lower()):
4265            print('Repository is gone, will switch to trunk')
4266            GSASIIpath.svnSwitch2branch()
4267            return
4268        elif repos is None: 
4269            dlg = wx.MessageDialog(self.frame,
4270                                   'Unable to access the GSAS-II server. Is this computer on the internet?',
4271                                   'Server unavailable',
4272                                   wx.OK)
4273            dlg.ShowModal()
4274            dlg.Destroy()
4275            return
4276        print ('GSAS-II version on server: '+repos)
4277        if local == repos:
4278            dlg = wx.MessageDialog(self.frame,
4279                                   'GSAS-II is up-to-date. Version '+local+' is already loaded.',
4280                                   'GSAS-II Up-to-date',
4281                                   wx.OK)
4282            dlg.ShowModal()
4283            dlg.Destroy()
4284            return
4285        mods = GSASIIpath.svnFindLocalChanges()
4286        if mods:
4287            dlg = wx.MessageDialog(self.frame,
4288                                   'You have version '+local+
4289                                   ' of GSAS-II installed, but the current version is '+repos+
4290                                   '. However, '+str(len(mods))+
4291                                   ' file(s) on your local computer have been modified.'
4292                                   ' Updating will attempt to merge your local changes with '
4293                                   'the latest GSAS-II version, but if '
4294                                   'conflicts arise, local changes will be '
4295                                   'discarded. It is also possible that the '
4296                                   'local changes my prevent GSAS-II from running. '
4297                                   'Press OK to start an update if this is acceptable:',
4298                                   'Local GSAS-II Mods',
4299                                   wx.OK|wx.CANCEL)
4300            if dlg.ShowModal() != wx.ID_OK:
4301                dlg.Destroy()
4302                return
4303            else:
4304                dlg.Destroy()
4305        else:
4306            dlg = wx.MessageDialog(self.frame,
4307                                   'You have version '+local+
4308                                   ' of GSAS-II installed, but the current version is '+repos+
4309                                   '. Press OK to start an update:',
4310                                   'GSAS-II Updates',
4311                                   wx.OK|wx.CANCEL)
4312            if dlg.ShowModal() != wx.ID_OK:
4313                dlg.Destroy()
4314                return
4315            dlg.Destroy()
4316        print ('start updates')
4317        dlg = wx.MessageDialog(self.frame,
4318                               'Your project will now be saved, GSAS-II will exit and an update '
4319                               'will be performed and GSAS-II will restart. Press Cancel to '
4320                               'abort the update',
4321                               'Start update?',
4322                               wx.OK|wx.CANCEL)
4323        if dlg.ShowModal() != wx.ID_OK:
4324            dlg.Destroy()
4325            return
4326        dlg.Destroy()
4327        if self.frame.GPXtree.GetCount() > 1:
4328            self.frame.OnFileSave(event)
4329            GPX = self.frame.GSASprojectfile
4330            GSASIIpath.svnUpdateProcess(projectfile=GPX)
4331        else:
4332            GSASIIpath.svnUpdateProcess()
4333        return
4334
4335    def OnSelectVersion(self,event):
4336        '''Allow the user to select a specific version of GSAS-II
4337        '''
4338        if not GSASIIpath.whichsvn():
4339            dlg = wx.MessageDialog(self,'No Subversion','Cannot update GSAS-II because subversion (svn) '+
4340                                   'was not found.'
4341                                   ,wx.OK)
4342            dlg.ShowModal()
4343            return
4344        local = GSASIIpath.svnGetRev()
4345        if local is None: 
4346            dlg = wx.MessageDialog(self.frame,
4347                                   'Unable to run subversion on the GSAS-II current directory. Is GSAS-II installed correctly?',
4348                                   'Subversion error',
4349                                   wx.OK)
4350            dlg.ShowModal()
4351            dlg.Destroy()
4352            return
4353        mods = GSASIIpath.svnFindLocalChanges()
4354        if mods:
4355            dlg = wx.MessageDialog(self.frame,
4356                                   'You have version '+local+
4357                                   ' of GSAS-II installed'
4358                                   '. However, '+str(len(mods))+
4359                                   ' file(s) on your local computer have been modified.'
4360                                   ' Downdating will attempt to merge your local changes with '
4361                                   'the selected GSAS-II version. '
4362                                   'Downdating is not encouraged because '
4363                                   'if merging is not possible, your local changes will be '
4364                                   'discarded. It is also possible that the '
4365                                   'local changes my prevent GSAS-II from running. '
4366                                   'Press OK to continue anyway.',
4367                                   'Local GSAS-II Mods',
4368                                   wx.OK|wx.CANCEL)
4369            if dlg.ShowModal() != wx.ID_OK:
4370                dlg.Destroy()
4371                return
4372            dlg.Destroy()
4373        if GSASIIpath.svnGetRev(local=False) is None:
4374            dlg = wx.MessageDialog(self.frame,
4375                                   'Error obtaining current GSAS-II version. Is internet access working correctly?',
4376                                   'Subversion error',
4377                                   wx.OK)
4378            dlg.ShowModal()
4379            dlg.Destroy()
4380            return
4381        dlg = downdate(parent=self.frame)
4382        if dlg.ShowModal() == wx.ID_OK:
4383            ver = dlg.getVersion()
4384        else:
4385            dlg.Destroy()
4386            return
4387        dlg.Destroy()
4388        print('start regress to '+str(ver))
4389        self.frame.OnFileSave(event)
4390        GPX = self.frame.GSASprojectfile
4391        GSASIIpath.svnUpdateProcess(projectfile=GPX,version=str(ver))
4392        return
4393
4394    # def OnSelectBranch(self,event):
4395    #     '''Allow the user to select branch of GSAS-II or return to trunk
4396    #     N.B. Name of branch to use is hard-coded here. Must contain a slash
4397    #     '''
4398    #     testbranch = '/branch/2frame'
4399    #     if not GSASIIpath.svnTestBranch():
4400    #         dlg = wx.MessageDialog(self.frame,
4401    #                                'Switching to test GSAS-II version',
4402    #                                'Confirm Switch',
4403    #                                wx.OK|wx.CANCEL)
4404    #         if dlg.ShowModal() != wx.ID_OK: return
4405    #         branch = testbranch
4406    #     else:
4407    #         dlg = wx.MessageDialog(self.frame,
4408    #                                'Switching back to standard GSAS-II version',
4409    #                                'Confirm Switch',
4410    #                                wx.OK|wx.CANCEL)
4411    #         if dlg.ShowModal() != wx.ID_OK: return
4412    #         branch = 'trunk'
4413    #     print('start switch')
4414    #     self.frame.OnFileSave(event)
4415    #     GPX = self.frame.GSASprojectfile
4416    #     GSASIIpath.svnUpdateProcess(projectfile=GPX,branch=branch)
4417
4418################################################################################
4419class HelpButton(wx.Button):
4420    '''Create a help button that displays help information.
4421    The text is displayed in a modal message window.
4422
4423    TODO: it might be nice if it were non-modal: e.g. it stays around until
4424    the parent is deleted or the user closes it, but this did not work for
4425    me.
4426
4427    :param parent: the panel which will be the parent of the button
4428    :param str msg: the help text to be displayed
4429    '''
4430    def __init__(self,parent,msg):
4431        if sys.platform == "darwin": 
4432            wx.Button.__init__(self,parent,wx.ID_HELP)
4433        else:
4434            wx.Button.__init__(self,parent,wx.ID_ANY,'?',style=wx.BU_EXACTFIT)
4435        self.Bind(wx.EVT_BUTTON,self._onPress)
4436        self.msg=StripIndents(msg)
4437        self.parent = parent
4438    def _onClose(self,event):
4439        self.dlg.EndModal(wx.ID_CANCEL)
4440    def _onPress(self,event):
4441        'Respond to a button press by displaying the requested text'
4442        #dlg = wx.MessageDialog(self.parent,self.msg,'Help info',wx.OK)
4443        self.dlg = wx.Dialog(self.parent,wx.ID_ANY,'Help information', 
4444                        style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
4445        #self.dlg.SetBackgroundColour(wx.WHITE)
4446        mainSizer = wx.BoxSizer(wx.VERTICAL)
4447        txt = wx.StaticText(self.dlg,wx.ID_ANY,self.msg)
4448        mainSizer.Add(txt,1,wx.ALL|wx.EXPAND,10)
4449        txt.SetBackgroundColour(wx.WHITE)
4450
4451        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
4452        btn = wx.Button(self.dlg, wx.ID_CLOSE) 
4453        btn.Bind(wx.EVT_BUTTON,self._onClose)
4454        btnsizer.Add(btn)
4455        mainSizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
4456        self.dlg.SetSizer(mainSizer)
4457        mainSizer.Fit(self.dlg)
4458        self.dlg.CenterOnParent()
4459        self.dlg.ShowModal()
4460        self.dlg.Destroy()
4461################################################################################
4462class MyHtmlPanel(wx.Panel):
4463    '''Defines a panel to display HTML help information, as an alternative to
4464    displaying help information in a web browser.
4465    '''
4466    def __init__(self, frame, id):
4467        self.frame = frame
4468        wx.Panel.__init__(self, frame, id)
4469        sizer = wx.BoxSizer(wx.VERTICAL)
4470        back = wx.Button(self, -1, "Back")
4471        back.Bind(wx.EVT_BUTTON, self.OnBack)
4472        self.htmlwin = G2HtmlWindow(self, id, size=(750,450))
4473        sizer.Add(self.htmlwin, 1,wx.EXPAND)
4474        sizer.Add(back, 0, wx.ALIGN_LEFT, 0)
4475        self.SetSizer(sizer)
4476        sizer.Fit(frame)       
4477        self.Bind(wx.EVT_SIZE,self.OnHelpSize)
4478    def OnHelpSize(self,event):         #does the job but weirdly!!
4479        anchor = self.htmlwin.GetOpenedAnchor()
4480        if anchor:           
4481            self.htmlwin.ScrollToAnchor(anchor)
4482            wx.CallAfter(self.htmlwin.ScrollToAnchor,anchor)
4483            if event: event.Skip()
4484    def OnBack(self, event):
4485        self.htmlwin.HistoryBack()
4486    def LoadFile(self,file):
4487        pos = file.rfind('#')
4488        if pos != -1:
4489            helpfile = file[:pos]
4490            helpanchor = file[pos+1:]
4491        else:
4492            helpfile = file
4493            helpanchor = None
4494        self.htmlwin.LoadPage(helpfile)
4495        if helpanchor is not None:
4496            self.htmlwin.ScrollToAnchor(helpanchor)
4497            xs,ys = self.htmlwin.GetViewStart()
4498            self.htmlwin.Scroll(xs,ys-1)
4499################################################################################
4500class G2HtmlWindow(wx.html.HtmlWindow):
4501    '''Displays help information in a primitive HTML browser type window
4502    '''
4503    def __init__(self, parent, *args, **kwargs):
4504        self.parent = parent
4505        wx.html.HtmlWindow.__init__(self, parent, *args, **kwargs)
4506    def LoadPage(self, *args, **kwargs):
4507        wx.html.HtmlWindow.LoadPage(self, *args, **kwargs)
4508        self.TitlePage()
4509    def OnLinkClicked(self, *args, **kwargs):
4510        wx.html.HtmlWindow.OnLinkClicked(self, *args, **kwargs)
4511        xs,ys = self.GetViewStart()
4512        self.Scroll(xs,ys-1)
4513        self.TitlePage()
4514    def HistoryBack(self, *args, **kwargs):
4515        wx.html.HtmlWindow.HistoryBack(self, *args, **kwargs)
4516        self.TitlePage()
4517    def TitlePage(self):
4518        self.parent.frame.SetTitle(self.GetOpenedPage() + ' -- ' + 
4519            self.GetOpenedPageTitle())
4520
4521################################################################################
4522def StripIndents(msg,singleLine=False):
4523    'Strip indentation from multiline strings'
4524    msg1 = msg.replace('\n ','\n')
4525    while msg != msg1:
4526        msg = msg1
4527        msg1 = msg.replace('\n ','\n')
4528    msg = msg.replace('\n\t','\n')
4529    if singleLine:
4530        return msg.replace('\n',' ')
4531    return msg
4532
4533def StripUnicode(string,subs='.'):
4534    '''Strip non-ASCII characters from strings
4535   
4536    :param str string: string to strip Unicode characters from
4537    :param str subs: character(s) to place into string in place of each
4538      Unicode character. Defaults to '.'
4539
4540    :returns: a new string with only ASCII characters
4541    '''
4542    s = ''
4543    for c in string:
4544        if ord(c) < 128:
4545            s += c
4546        else:
4547            s += subs
4548    return s.encode('ascii','replace')
4549       
4550################################################################################
4551# configuration routines (for editing config.py)
4552def SaveGPXdirectory(path):
4553    if GSASIIpath.GetConfigValue('Starting_directory') == path: return
4554    vars = GetConfigValsDocs()
4555    try:
4556        vars['Starting_directory'][1] = path
4557        if GSASIIpath.GetConfigValue('debug'): print('DBG_Saving GPX path: '+path)
4558        SaveConfigVars(vars)
4559    except KeyError:
4560        pass
4561
4562def SaveImportDirectory(path):
4563    if GSASIIpath.GetConfigValue('Import_directory') == path: return
4564    vars = GetConfigValsDocs()
4565    try:
4566        vars['Import_directory'][1] = path
4567        if GSASIIpath.GetConfigValue('debug'): print('DBG_Saving Import path: '+path)
4568        SaveConfigVars(vars)
4569    except KeyError:
4570        pass
4571
4572def GetConfigValsDocs():
4573    '''Reads the module referenced in fname (often <module>.__file__) and
4574    return a dict with names of global variables as keys.
4575    For each global variable, the value contains four items:
4576
4577    :returns: a dict where keys are names defined in module config_example.py
4578      where the value is a list of four items, as follows:
4579
4580         * item 0: the default value
4581         * item 1: the current value
4582         * item 2: the initial value (starts same as item 1)
4583         * item 3: the "docstring" that follows variable definition
4584
4585    '''
4586    import config_example
4587    import ast
4588    fname = os.path.splitext(config_example.__file__)[0]+'.py' # convert .pyc to .py
4589    with open(fname, 'r') as f:
4590        fstr = f.read()
4591    fstr = fstr.replace('\r\n', '\n').replace('\r', '\n')
4592    if not fstr.endswith('\n'):
4593        fstr += '\n'
4594    tree = ast.parse(fstr)
4595    d = {}
4596    key = None
4597    for node in ast.walk(tree):
4598        if isinstance(node,ast.Assign):
4599            key = node.targets[0].id
4600            d[key] = [config_example.__dict__.get(key),
4601                      GSASIIpath.configDict.get(key),
4602                      GSASIIpath.configDict.get(key),'']
4603        elif isinstance(node,ast.Expr) and key:
4604            d[key][3] = node.value.s.strip()
4605        else:
4606            key = None
4607    return d
4608
4609def SaveConfigVars(vars,parent=None):
4610    '''Write the current config variable values to config.py
4611
4612    :params dict vars: a dictionary of variable settings and meanings as
4613      created in :func:`GetConfigValsDocs`.
4614    :param parent: wx.Frame object or None (default) for parent
4615      of error message if no file can be written.
4616    :returns: True if unable to write the file, None otherwise
4617    '''
4618    # try to write to where an old config file is located
4619    try:
4620        import config
4621        savefile = config.__file__
4622    except ImportError: # no config.py file yet
4623        savefile = os.path.join(GSASIIpath.path2GSAS2,'config.py')
4624    # try to open file for write
4625    try:
4626        savefile = os.path.splitext(savefile)[0]+'.py' # convert .pyc to .py
4627        fp = open(savefile,'w')
4628    except IOError:  # can't write there, write in local mods directory
4629        # create a local mods directory, if needed
4630        g2local = os.path.expanduser('~/.G2local/')
4631        if not os.path.exists(g2local):
4632            try:
4633                print(u'Creating directory '+g2local)
4634                os.mkdir(g2local)
4635            except:
4636                if parent:
4637                    G2MessageBox(parent,u'Error trying to create directory '+g2local,
4638                        'Unable to save')
4639                else:
4640                    print(u'Error trying to create directory '+g2local)
4641                return True
4642            sys.path.insert(0,os.path.expanduser('~/.G2local/'))
4643        savefile = os.path.join(os.path.expanduser('~/.G2local/'),'config.py')
4644        try:
4645            fp = open(savefile,'w')
4646        except IOError:
4647            if parent:
4648                G2MessageBox(parent,'Error trying to write configuration to '+savefile,
4649                    'Unable to save')
4650            else:
4651                print('Error trying to write configuration to '+savefile)
4652            return True
4653    import datetime
4654    fp.write("'''\n")
4655    fp.write("*config.py: Configuration options*\n----------------------------------\n")
4656    fp.write("This file created in SelectConfigSetting on {:%d %b %Y %H:%M}\n".
4657             format(datetime.datetime.now()))
4658    fp.write("'''\n\n")
4659    fp.write("import os.path\n")
4660    fp.write("import GSASIIpath\n\n")
4661    for var in sorted(vars.keys(),key=lambda s: s.lower()):
4662        if vars[var][1] is None: continue
4663        if vars[var][1] == '': continue
4664        if vars[var][0] == vars[var][1]: continue
4665        try:
4666            float(vars[var][1]) # test for number
4667            fp.write(var + ' = ' + str(vars[var][1])+'\n')
4668        except:
4669            try:
4670                eval(vars[var][1]) # test for an expression
4671                fp.write(var + ' = ' + str(vars[var][1])+'\n')
4672            except: # must be a string
4673                varstr = vars[var][1]
4674                if '\\' in varstr:
4675                    fp.write(var + ' = os.path.normpath("' + varstr.replace('\\','/') +'")\n')
4676                else:
4677                    fp.write(var + ' = "' + str(varstr)+'"\n')
4678        if vars[var][3]:
4679            fp.write("'''" + str(vars[var][3]) + "\n'''\n\n")
4680    fp.close()
4681    print('wrote file '+savefile)
4682
4683class SelectConfigSetting(wx.Dialog):
4684    '''Dialog to select configuration variables and set associated values.
4685    '''
4686    def __init__(self,parent=None):
4687        style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER
4688        wx.Dialog.__init__(self, parent, wx.ID_ANY, 'Set Config Variable', style=style)
4689        self.sizer = wx.BoxSizer(wx.VERTICAL)
4690        self.vars = GetConfigValsDocs()
4691       
4692        label = wx.StaticText(
4693            self,  wx.ID_ANY,
4694            'Select a GSAS-II configuration variable to change'
4695            )
4696        self.sizer.Add(label, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
4697        self.choice = {}
4698        btn = G2ChoiceButton(self, sorted(self.vars.keys(),key=lambda s: s.lower()),
4699            strLoc=self.choice,strKey=0,onChoice=self.OnSelection)
4700        btn.SetLabel("")
4701        self.sizer.Add(btn)
4702
4703        self.varsizer = wx.BoxSizer(wx.VERTICAL)
4704        self.sizer.Add(self.varsizer,1,wx.ALL|wx.EXPAND,1)
4705       
4706        self.doclbl = wx.StaticBox(self, wx.ID_ANY, "")
4707        self.doclblsizr = wx.StaticBoxSizer(self.doclbl)
4708        self.docinfo = wx.StaticText(self,  wx.ID_ANY, "")
4709        self.doclblsizr.Add(self.docinfo, 0, wx.ALIGN_LEFT|wx.ALL, 5)
4710        self.sizer.Add(self.doclblsizr, 0, wx.ALIGN_LEFT|wx.EXPAND|wx.ALL, 5)
4711        btnsizer = wx.BoxSizer(wx.HORIZONTAL)
4712        self.saveBtn = wx.Button(self,-1,"Save current settings")
4713        btnsizer.Add(self.saveBtn, 0, wx.ALL, 2) 
4714        self.saveBtn.Bind(wx.EVT_BUTTON, self.OnSave)
4715        self.saveBtn.Enable(False)
4716        self.applyBtn = wx.Button(self,-1,"Use current (no save)")
4717        btnsizer.Add(self.applyBtn, 0, wx.ALL, 2) 
4718        self.applyBtn.Bind(wx.EVT_BUTTON, self.OnApplyChanges)
4719        self.applyBtn.Enable(False)
4720       
4721        btn = wx.Button(self,wx.ID_CANCEL)
4722        btnsizer.Add(btn, 0, wx.ALL, 2) 
4723        self.sizer.Add(btnsizer, 0, wx.ALIGN_CENTRE|wx.ALL, 5) 
4724               
4725        self.SetSizer(self.sizer)
4726        self.sizer.Fit(self)
4727        self.CenterOnParent()
4728       
4729    def OnChange(self,event=None):
4730        ''' Check if anything been changed. Turn the save button on/off.
4731        '''
4732        for var in self.vars:
4733            if self.vars[var][0] is None and self.vars[var][1] is not None:
4734                # make blank strings into None, if that is the default
4735                if self.vars[var][1].strip() == '': self.vars[var][1] = None
4736            if self.vars[var][1] != self.vars[var][2]:
4737                #print 'changed',var,self.vars[var][:3]
4738                self.saveBtn.Enable(True)
4739                self.applyBtn.Enable(True)
4740                break
4741        else:
4742            self.saveBtn.Enable(False)
4743            self.applyBtn.Enable(False)
4744        try:
4745            self.resetBtn.Enable(True)
4746        except:
4747            pass
4748       
4749    def OnApplyChanges(self,event=None):
4750        'Set config variables to match the current settings'
4751        GSASIIpath.SetConfigValue(self.vars)
4752        self.EndModal(wx.ID_OK)
4753        import GSASIImpsubs as G2mp
4754        G2mp.ResetMP()
4755       
4756    def OnSave(self,event):
4757        '''Write the config variables to config.py and then set them
4758        as the current settings
4759        '''
4760        if not SaveConfigVars(self.vars,parent=self):
4761            self.OnApplyChanges() # force a reload of the config settings
4762        else:
4763            self.EndModal(wx.ID_OK)
4764
4765    def OnBoolSelect(self,event):
4766        'Respond to a change in a True/False variable'
4767        rb = event.GetEventObject()
4768        var = self.choice[0]
4769        self.vars[var][1] = (rb.GetSelection() == 0)
4770        self.OnChange()
4771        wx.CallAfter(self.OnSelection)
4772       
4773    def onSelDir(self,event):
4774        'Select a directory from a menu'
4775        dlg = wx.DirDialog(self, "Choose a directory:",style=wx.DD_DEFAULT_STYLE)
4776        if dlg.ShowModal() == wx.ID_OK:
4777            var = self.choice[0]
4778            self.vars[var][1] = dlg.GetPath()
4779            self.strEd.SetValue(self.vars[var][1])
4780            self.OnChange()
4781        dlg.Destroy()
4782       
4783    def OnSelection(self):
4784        'show a selected variable'
4785        def OnNewColorBar(event):
4786            self.vars['Contour_color'][1] = self.colSel.GetValue()
4787            self.OnChange(event)
4788
4789        if 'phoenix' in wx.version():
4790            self.varsizer.Clear(True)
4791        else:
4792            self.varsizer.DeleteWindows()
4793        var = self.choice[0]
4794        showdef = True
4795        if var not in self.vars:
4796            raise Exception("How did this happen?")
4797        if type(self.vars[var][0]) is int:
4798            ed = ValidatedTxtCtrl(self,self.vars[var],1,typeHint=int,OKcontrol=self.OnChange)
4799            self.varsizer.Add(ed, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
4800        elif type(self.vars[var][0]) is float:
4801            ed = ValidatedTxtCtrl(self,self.vars[var],1,typeHint=float,OKcontrol=self.OnChange)
4802            self.varsizer.Add(ed, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
4803        elif type(self.vars[var][0]) is bool:
4804            showdef = False
4805            lbl = "value for "+var
4806            ch = []
4807            for i,v in enumerate((True,False)):
4808                s = str(v)
4809                if v == self.vars[var][0]:
4810                    defopt = i
4811                    s += ' (default)'
4812                ch += [s]
4813            rb = wx.RadioBox(self, wx.ID_ANY, lbl, wx.DefaultPosition, wx.DefaultSize,
4814                ch, 1, wx.RA_SPECIFY_COLS)
4815            # set initial value
4816            if self.vars[var][1] is None:
4817                rb.SetSelection(defopt)
4818            elif self.vars[var][1]:
4819                rb.SetSelection(0)
4820            else:
4821                rb.SetSelection(1)
4822            rb.Bind(wx.EVT_RADIOBOX,self.OnBoolSelect)
4823            self.varsizer.Add(rb, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
4824        else:
4825            if var.endswith('_directory') or var.endswith('_location'):
4826                btn = wx.Button(self,wx.ID_ANY,'Select from dialog...')
4827                sz = (400,-1)
4828            else:
4829                btn = None
4830                sz = (250,-1)
4831            if var == 'Contour_color':
4832                if self.vars[var][1] is None:
4833                    self.vars[var][1] = 'Paired'
4834                colorList = sorted([m for m in mpl.cm.datad.keys() ],key=lambda s: s.lower())   #if not m.endswith("_r")
4835                self.colSel = wx.ComboBox(self,value=self.vars[var][1],choices=colorList,
4836                    style=wx.CB_READONLY|wx.CB_DROPDOWN)
4837                self.colSel.Bind(wx.EVT_COMBOBOX, OnNewColorBar)
4838                self.varsizer.Add(self.colSel, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
4839            else:
4840                self.strEd = ValidatedTxtCtrl(self,self.vars[var],1,typeHint=str,
4841                    OKcontrol=self.OnChange,size=sz)
4842                if self.vars[var][1] is not None:
4843                    self.strEd.SetValue(self.vars[var][1])
4844                self.varsizer.Add(self.strEd, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
4845            if btn:
4846                btn.Bind(wx.EVT_BUTTON,self.onSelDir)
4847                self.varsizer.Add(btn, 0, wx.ALIGN_CENTRE|wx.ALL, 5) 
4848        # button for reset to default value
4849        lbl = "Reset to Default"
4850        if showdef: # spell out default when needed
4851            lbl += ' (='+str(self.vars[var][0])+')'
4852            #label = wx.StaticText(self,  wx.ID_ANY, 'Default value = '+str(self.vars[var][0]))
4853            #self.varsizer.Add(label, 0, wx.ALIGN_LEFT|wx.ALL, 5)
4854        self.resetBtn = wx.Button(self,-1,lbl)
4855        self.resetBtn.Bind(wx.EVT_BUTTON, self.OnClear)
4856        if self.vars[var][1] is not None and self.vars[var][1] != '': # show current value, if one
4857            #label = wx.StaticText(self,  wx.ID_ANY, 'Current value = '+str(self.vars[var][1]))
4858            #self.varsizer.Add(label, 0, wx.ALIGN_LEFT|wx.ALL, 5)
4859            self.resetBtn.Enable(True)
4860        else:
4861            self.resetBtn.Enable(False)
4862        self.varsizer.Add(self.resetBtn, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
4863        # show meaning, if defined
4864        self.doclbl.SetLabel("Description of "+str(var)) 
4865        if self.vars[var][3]:
4866            self.docinfo.SetLabel(self.vars[var][3])
4867        else:
4868            self.docinfo.SetLabel("(not documented)")
4869        self.sizer.Fit(self)
4870        self.CenterOnParent()
4871        wx.CallAfter(self.SendSizeEvent)
4872
4873    def OnClear(self, event):
4874        var = self.choice[0]
4875        self.vars[var][1] = self.vars[var][0]
4876        self.OnChange()
4877        wx.CallAfter(self.OnSelection)
4878       
4879################################################################################
4880class downdate(wx.Dialog):
4881    '''Dialog to allow a user to select a version of GSAS-II to install
4882    '''
4883    def __init__(self,parent=None):
4884        style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER
4885        wx.Dialog.__init__(self, parent, wx.ID_ANY, 'Select Version', style=style)
4886        pnl = wx.Panel(self)
4887        sizer = wx.BoxSizer(wx.VERTICAL)
4888        insver = GSASIIpath.svnGetRev(local=True)
4889        curver = int(GSASIIpath.svnGetRev(local=False))
4890        label = wx.StaticText(
4891            pnl,  wx.ID_ANY,
4892            'Select a specific GSAS-II version to install'
4893            )
4894        sizer.Add(label, 0, wx.ALIGN_CENTRE|wx.ALL, 5)
4895        sizer1 = wx.BoxSizer(wx.HORIZONTAL)
4896        sizer1.Add(
4897            wx.StaticText(pnl,  wx.ID_ANY,
4898                          'Currently installed version: '+str(insver)),
4899            0, wx.ALIGN_CENTRE|wx.ALL, 5)
4900        sizer.Add(sizer1)
4901        sizer1 = wx.BoxSizer(wx.HORIZONTAL)
4902        sizer1.Add(
4903            wx.StaticText(pnl,  wx.ID_ANY,
4904                          'Select GSAS-II version to install: '),
4905            0, wx.ALIGN_CENTRE|wx.ALL, 5)
4906        self.spin = wx.SpinCtrl(pnl, wx.ID_ANY,size=(150,-1))
4907        self.spin.SetRange(1, curver)
4908        self.spin.SetValue(curver)
4909        self.Bind(wx.EVT_SPINCTRL, self._onSpin, self.spin)
4910        self.Bind(wx.EVT_KILL_FOCUS, self._onSpin, self.spin)
4911        sizer1.Add(self.spin)
4912        sizer.Add(sizer1)
4913
4914        line = wx.StaticLine(pnl,-1, size=(-1,3), style=wx.LI_HORIZONTAL)
4915        sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.ALL, 10)
4916
4917        self.text = wx.StaticText(pnl,  wx.ID_ANY, "")
4918        sizer.Add(self.text, 0, wx.ALIGN_LEFT|wx.EXPAND|wx.ALL, 5)
4919
4920        line = wx.StaticLine(pnl,-1, size=(-1,3), style=wx.LI_HORIZONTAL)
4921        sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.ALL, 10)
4922        sizer.Add(
4923            wx.StaticText(
4924                pnl,  wx.ID_ANY,
4925                'If "Install" is pressed, your project will be saved;\n'
4926                'GSAS-II will exit; The specified version will be loaded\n'
4927                'and GSAS-II will restart. Press "Cancel" to abort.'),
4928            0, wx.EXPAND|wx.ALL, 10)
4929        btnsizer = wx.StdDialogButtonSizer()
4930        btn = wx.Button(pnl, wx.ID_OK, "Install")
4931        btn.SetDefault()
4932        btnsizer.AddButton(btn)
4933        btn = wx.Button(pnl, wx.ID_CANCEL)
4934        btnsizer.AddButton(btn)
4935        btnsizer.Realize()
4936        sizer.Add(btnsizer, 0, wx.ALIGN_CENTER|wx.ALL, 5)
4937        pnl.SetSizer(sizer)
4938        sizer.Fit(self)
4939        self.topsizer=sizer
4940        self.CenterOnParent()
4941        self._onSpin(None)
4942
4943    def _onSpin(self,event):
4944        'Called to load info about the selected version in the dialog'
4945        if event: event.Skip()
4946        ver = self.spin.GetValue()
4947        d = GSASIIpath.svnGetLog(version=ver)
4948        date = d.get('date','?').split('T')[0]
4949        s = '(Version '+str(ver)+' created '+date
4950        s += ' by '+d.get('author','?')+')'
4951        msg = d.get('msg')
4952        if msg: s += '\n\nComment: '+msg
4953        self.text.SetLabel(s)
4954        self.topsizer.Fit(self)
4955
4956    def getVersion(self):
4957        'Get the version number in the dialog'
4958        return self.spin.GetValue()
4959
4960################################################################################
4961#### Display Help information
4962################################################################################
4963# define some globals
4964htmlPanel = None
4965htmlFrame = None
4966htmlFirstUse = True
4967#helpLocDict = {}  # to be implemented if we ever split gsasii.html over multiple files
4968path2GSAS2 = os.path.dirname(os.path.realpath(__file__)) # save location of this file
4969def ShowHelp(helpType,frame):
4970    '''Called to bring up a web page for documentation.'''
4971    global htmlFirstUse,htmlPanel,htmlFrame
4972    # no defined link to use, create a default based on key
4973    helplink = 'gsasII.html'
4974    if helpType:
4975        helplink += '#'+helpType.replace(')','').replace('(','_').replace(' ','_')
4976    # determine if a web browser or the internal v