Ignore:
Timestamp:
Dec 28, 2017 12:50:40 PM (4 years ago)
Author:
toby
Message:

Add simulation to scriptable & add to tutorial; add sphinx index to ctrlsGUI; remove path from RunGSASII.bat

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIctrlGUI.py

    r3207 r3209  
    1212---------------------------------------------
    1313
    14 A library of GUI controls for reuse throughout GSAS-II
     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:`MultiFloatDialog`          Dialog to obtain multiple float values from user,
     46                                   with optional range validation.
     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:`G2ColumnIDDialog`          A dialog for matching column data to desired items; some
     58                                   columns may be ignored.
     59:class:`G2HistoDataDialog`         A dialog for global edits to histogram data globally
     60:class:`OrderBox`                  Creates a wx.Panel with scrollbars where items can be
     61                                   ordered into columns.
     62:class:`HelpButton`                Creates a button labeled with a "?" that when pressed
     63                                   displays help text in a modal message window.
     64:func:`G2MessageBox`               Displays text typically used for errors or warnings.
     65:func:`HorizontalLine`             Places a line in a Frame or Dialog to separate sections.
     66:func:`SelectEdit1Var`             Select a variable from a list, then edit it and select
     67                                   histograms to copy it to.
     68:func:`ItemSelector`               Select a single item or multiple items from list of choices.
     69                                   Creates and then destroys a wx.Dialog and returns the
     70                                   selections(s).
     71:func:`GetItemOrder`               Creates a dialog for ordering items into columns
     72:func:`GetImportFile`              Gets one ore more file from the appropriate import
     73                                   directory, which can be overridden. Arguments follow those
     74                                   of :func:`wx.FileDialog`
     75:func:`Define_wxId`                Create a unique wx.Id symbol that is global to this
     76                                   module (:mod:`GSASIIctrlGUI`). Such symbols are needed
     77                                   when the menu item is defined in a different location
     78                                   from the wx.Bind that links the menu item to a function.
     79                                   This function allows menu Ids to be
     80                                   defined where they are first used rather than be placed
     81                                   yet a third location somewhere in this module.
     82================================  =================================================================
     83
     84Other miscellaneous routines that may be of use:
     85
     86================================  =================================================================
     87Function name                      Description
     88================================  =================================================================
     89:func:`StripIndents`               Regularizes the intentation from a string with multiple
     90                                   newline characters by removing spaces at the beginning
     91                                   of each line.
     92:func:`StripUnicode`               Removes unicode characters from strings
     93:func:`GetImportPath`              Determines the default location to use for importing files.
     94                                   Tries sequentially :attr:`G2frame.TutorialImportDir`,
     95                                   config var ``Import_directory`` and
     96                                   :attr:`G2frame.LastImportDir`.
     97:func:`GetExportPath`              Determines the default location to use for writing files.
     98                                   Tries sequentially :attr:`G2frame.LastExportDir` and
     99                                   :attr:`G2frame.LastGPXdir`
     100================================  =================================================================
     101
     102Documentation for all the routines in module :mod:`GSASIIctrlGUI`.
    15103
    16104'''
     
    10671155            self.onChoice()
    10681156
    1069 ############################################################### Custom checkbox that saves values into dict/list as used
     1157##############################################################
     1158# Custom checkbox that saves values into dict/list as used
    10701159class G2CheckBox(wx.CheckBox):
    10711160    '''A customized version of a CheckBox that automatically initializes
     
    26132702######################################################### Column-order selection dialog
    26142703def GetItemOrder(parent,keylist,vallookup,posdict):
    2615     '''Creates a panel where items can be ordered into columns
     2704    '''Creates a dialog where items can be ordered into columns
    26162705   
    26172706    :param list keylist: is a list of keys for column assignments
Note: See TracChangeset for help on using the changeset viewer.