Changeset 225aca8 in sasview for src/sas/guiframe

Timestamp:

Jul 28, 2015 12:14:38 PM (9 years ago)

Author:

mathieu

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

a910c788

Parents:

ae2a197 (diff), d06c34c (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge pull request #3 from SasView?/standalone_cleanup

Standalone cleanup

Location:

src/sas/guiframe

Files:

• gui_manager.py (modified) (17 diffs)
• local_perspectives/data_loader/data_loader.py (modified) (1 diff)
• local_perspectives/plotting/plotting.py (modified) (1 diff)
• plugin_base.py (modified) (3 diffs)
• config.py (modified) (1 diff)
• data_processor.py (modified) (65 diffs)
• documentation_window.py (modified) (1 diff)
• local_perspectives/plotting/Plotter1D.py (modified) (1 diff)
• local_perspectives/plotting/Plotter2D.py (modified) (1 diff)
• local_perspectives/plotting/SimplePlot.py (modified) (2 diffs)
• media/BatchGridClassLayout.png (added)
• proxy.py (added)
• report_dialog.py (modified) (1 diff)

src/sas/guiframe/gui_manager.py

@@ -235 +235 @@
         Initialize the Frame object
         """
-
         PARENT_FRAME.__init__(self, parent=parent, title=title, pos=pos, size=size)
         # title
@@ -364 +363 @@
                     frame.SetIcon(icon)
                 except:
-                    pass
+                    logging.error("ViewerFrame.put_icon: could not set icon")
 
     def get_client_size(self):
@@ -752 +751 @@
             self._toolbar.Realize()
 
-
     def build_gui(self):
         """
@@ -778 +776 @@
         # Append item from plugin under menu file if necessary
         self._populate_file_menu()
-
 
         if not wx.VERSION_STRING >= '3.0.0.0':
@@ -822 +819 @@
         # Load panels
         self._load_panels()
-        self.set_default_perspective()
 
     def SetStatusText(self, *args, **kwds):
@@ -931 +927 @@
                         if hasattr(module, "PLUGIN_ID"):
                             try:
-                                plug = module.Plugin()
-                                if plug.set_default_perspective():
-                                    self._current_perspective = plug
-                                plugins.append(plug)
-
+                                plugins.append(module.Plugin())
                                 msg = "Found plug-in: %s" % module.PLUGIN_ID
                                 logging.info(msg)
@@ -1511 +1503 @@
                 for item in plugin.populate_file_menu():
                     m_name, m_hint, m_handler = item
-                    id = wx.NewId()
-                    self._file_menu.Append(id, m_name, m_hint)
-                    wx.EVT_MENU(self, id, m_handler)
+                    wx_id = wx.NewId()
+                    self._file_menu.Append(wx_id, m_name, m_hint)
+                    wx.EVT_MENU(self, wx_id, m_handler)
                 self._file_menu.AppendSeparator()
 
         style1 = self.__gui_style & GUIFRAME.MULTIPLE_APPLICATIONS
         if OPEN_SAVE_MENU:
-            id = wx.NewId()
+            wx_id = wx.NewId()
             hint_load_file = "read all analysis states saved previously"
-            self._save_appl_menu = self._file_menu.Append(id, '&Open Project', hint_load_file)
-            wx.EVT_MENU(self, id, self._on_open_state_project)
+            self._save_appl_menu = self._file_menu.Append(wx_id, '&Open Project', hint_load_file)
+            wx.EVT_MENU(self, wx_id, self._on_open_state_project)
 
         if style1 == GUIFRAME.MULTIPLE_APPLICATIONS:
@@ -1527 +1519 @@
             hint_load_file = "Read a status files and load"
             hint_load_file += " them into the analysis"
-            id = wx.NewId()
-            self._save_appl_menu = self._file_menu.Append(id,
+            wx_id = wx.NewId()
+            self._save_appl_menu = self._file_menu.Append(wx_id,
                                                           '&Open Analysis', hint_load_file)
-            wx.EVT_MENU(self, id, self._on_open_state_application)
+            wx.EVT_MENU(self, wx_id, self._on_open_state_application)
         if OPEN_SAVE_MENU:
             self._file_menu.AppendSeparator()
-            id = wx.NewId()
-            self._file_menu.Append(id, '&Save Project',
+            wx_id = wx.NewId()
+            self._file_menu.Append(wx_id, '&Save Project',
                                    'Save the state of the whole analysis')
-            wx.EVT_MENU(self, id, self._on_save_project)
+            wx.EVT_MENU(self, wx_id, self._on_save_project)
         if style1 == GUIFRAME.MULTIPLE_APPLICATIONS:
-            id = wx.NewId()
-            self._save_appl_menu = self._file_menu.Append(id, \
+            wx_id = wx.NewId()
+            self._save_appl_menu = self._file_menu.Append(wx_id, \
                 '&Save Analysis', 'Save state of the current active analysis panel')
-            wx.EVT_MENU(self, id, self._on_save_application)
+            wx.EVT_MENU(self, wx_id, self._on_save_application)
         if not sys.platform == 'darwin':
             self._file_menu.AppendSeparator()
-            id = wx.NewId()
-            self._file_menu.Append(id, '&Quit', 'Exit')
-            wx.EVT_MENU(self, id, self.Close)
+            wx_id = wx.NewId()
+            self._file_menu.Append(wx_id, '&Quit', 'Exit')
+            wx.EVT_MENU(self, wx_id, self.Close)
 
     def _add_menu_file(self):
@@ -1717 +1709 @@
         """
         """
-        message = ""
         log_msg = ''
-        output = []
-        error_message = ""
         basename = os.path.basename(path)
-        root, extension = os.path.splitext(basename)
+        _, extension = os.path.splitext(basename)
         if extension.lower() not in EXTENSIONS:
             log_msg = "File Loader cannot "
@@ -2224 +2213 @@
             if hasattr(item, "post_init"):
                 item.post_init()
-
-    def set_default_perspective(self):
-        """
-        Choose among the plugin the first plug-in that has
-        "set_default_perspective" method and its return value is True will be
-        as a default perspective when the welcome page is closed
-        """
-        for item in self.plugins:
-            if hasattr(item, "set_default_perspective"):
-                if item.set_default_perspective():
-                    item.on_perspective(event=None)
-                    return
 
     def set_perspective(self, panels):
@@ -2414 +2391 @@
             total_plot_list.append(theory_data)
         for new_plot in total_plot_list:
-            id = new_plot.id
             for group_id in new_plot.list_group_id:
-                wx.PostEvent(self, NewPlotEvent(id=id,
+                wx.PostEvent(self, NewPlotEvent(id=new_plot.id,
                                                 group_id=group_id,
                                                 action='remove'))
                 #remove res plot: Todo: improve
-                wx.CallAfter(self._remove_res_plot, id)
+                wx.CallAfter(self._remove_res_plot, new_plot.id)
         self._data_manager.delete_data(data_id=data_id,
                                        theory_id=theory_id)
@@ -2455 +2431 @@
             ext_num = dlg.GetFilterIndex()
             if ext_num == 0:
-                format = '.txt'
+                ext_format = '.txt'
             else:
-                format = '.xml'
-            path = os.path.splitext(path)[0] + format
+                ext_format = '.xml'
+            path = os.path.splitext(path)[0] + ext_format
             mypath = os.path.basename(path)
 
             #Instantiate a loader
             loader = Loader()
-            format = ".txt"
-            if os.path.splitext(mypath)[1].lower() == format:
+            ext_format = ".txt"
+            if os.path.splitext(mypath)[1].lower() == ext_format:
                 # Make sure the ext included in the file name
                 # especially on MAC
-                fName = os.path.splitext(path)[0] + format
+                fName = os.path.splitext(path)[0] + ext_format
                 self._onsaveTXT(data, fName)
-            format = ".xml"
-            if os.path.splitext(mypath)[1].lower() == format:
+            ext_format = ".xml"
+            if os.path.splitext(mypath)[1].lower() == ext_format:
                 # Make sure the ext included in the file name
                 # especially on MAC
-                fName = os.path.splitext(path)[0] + format
-                loader.save(fName, data, format)
+                fName = os.path.splitext(path)[0] + ext_format
+                loader.save(fName, data, ext_format)
             try:
                 self._default_save_location = os.path.dirname(path)
@@ -2598 +2574 @@
             ext_num = dlg.GetFilterIndex()
             if ext_num == 0:
-                format = '.dat'
+                ext_format = '.dat'
             else:
-                format = ''
-            path = os.path.splitext(path)[0] + format
+                ext_format = ''
+            path = os.path.splitext(path)[0] + ext_format
             mypath = os.path.basename(path)
 
@@ -2607 +2583 @@
             loader = Loader()
 
-            format = ".dat"
-            if os.path.splitext(mypath)[1].lower() == format:
+            ext_format = ".dat"
+            if os.path.splitext(mypath)[1].lower() == ext_format:
                 # Make sure the ext included in the file name
                 # especially on MAC
-                fileName = os.path.splitext(path)[0] + format
-                loader.save(fileName, data, format)
+                fileName = os.path.splitext(path)[0] + ext_format
+                loader.save(fileName, data, ext_format)
             try:
                 self._default_save_location = os.path.dirname(path)
@@ -3206 +3182 @@
 
 
-class ViewApp(wx.App):
+class SasViewApp(wx.App):
     """
-    Toy application to test this Frame
+    SasView application
     """
     def OnInit(self):
@@ -3294 +3270 @@
             if len(os.listdir(model_folder)) > 0:
                 try:
-                    for file in os.listdir(model_folder):
-                        file_path = os.path.join(model_folder, file)
+                    for filename in os.listdir(model_folder):
+                        file_path = os.path.join(model_folder, filename)
                         if os.path.isfile(file_path):
                             os.remove(file_path)
@@ -3314 +3290 @@
         """
         #try to load file at the start
-        try:
-            self.open_file()
-        except:
-            raise
+        self.open_file()
         self.frame.build_gui()
 

src/sas/guiframe/local_perspectives/data_loader/data_loader.py

@@ -41 +41 @@
 class Plugin(PluginBase):
 
-    def __init__(self, standalone=False):
-        PluginBase.__init__(self, name="DataLoader", standalone=standalone)
+    def __init__(self):
+        PluginBase.__init__(self, name="DataLoader")
         # Default location
         self._default_save_location = DEFAULT_OPEN_FOLDER

src/sas/guiframe/local_perspectives/plotting/plotting.py

@@ -36 +36 @@
     """
 
-    def __init__(self, standalone=False):
-        PluginBase.__init__(self, name="Plotting", standalone=standalone)
+    def __init__(self):
+        PluginBase.__init__(self, name="Plotting")
 
         ## Plot panels

src/sas/guiframe/plugin_base.py

@@ -34 +34 @@
     """
 
-    def __init__(self, name="Test_plugin", standalone=True):
+    def __init__(self, name="Test_plugin"):
         """
         Abstract class for gui_manager Plugins.
@@ -42 +42 @@
         ## Plug-in name. It will appear on the application menu.
         self.sub_menu = name
-        #standalone flag
-        self.standalone = standalone
         ## Reference to the parent window. Filled by get_panels() below.
         self.parent = None
@@ -263 +261 @@
         pass
 
-    def set_default_perspective(self):
-        """
-       Call back method that True to notify the parent that the current plug-in
-       can be set as default  perspective.
-       when returning False, the plug-in is not candidate for an automatic
-       default perspective setting
-        """
-        if self.standalone:
-            return True
-        return False
-
     def set_state(self, state=None, datainfo=None):    
         """

src/sas/guiframe/config.py

@@ -10 +10 @@
 __build__ = '1'
 __download_page__ = 'https://github.com/SasView/sasview/releases'
-__update_URL__ = ['raw.githubusercontent.com',
-                  '/SasView/sasview/master/sasview.latestversion']
+__update_URL__ = 'http://www.sasview.org/latestversion.json'
 
 

src/sas/guiframe/data_processor.py

@@ -1 +1 @@
 """
-Implement grid used to store data
+Implement grid used to store results of a batch fit.
+
+This is in Guiframe rather than fitting which is probably where it should be.
+Actually could be a generic framework implemented in fit gui module.  At this
+point however there this grid behaves independently of the fitting panel and
+only knows about information sent to it but not about the fits or fit panel and
+thus cannot feed back to the fitting panel.  This could change in the future.
+
+The organization of the classes goes as:
+
+.. image::  ../../user/guiframe/BatchGridClassLayout.png
+   :align:   center
+
 """
 import wx
@@ -26 +38 @@
     """
     Object describing a cell in  the grid.
-
     """
     def __init__(self):
+        """
+        Initialize attributes of class (label, value, col, row, object)
+        """
         self.label = ""
         self.value = None
@@ -39 +53 @@
     """
     Return a dictionary of column label and index or row selected
+
     :param sentence: String to parse
     :param list: list of columns label
+    :returns: col_dict
     """
+
     p2 = re.compile(r'\d+')
     p = re.compile(r'[\+\-\*\%\/]')
@@ -81 +98 @@
 
 class SPanel(ScrolledPanel):
+    """
+    ensure proper scrolling of GridPanel 
+    
+    Adds a SetupScrolling call to the normal ScrolledPanel init.    
+    GridPanel then subclasses this class
+    
+    """
     def __init__(self, parent, *args, **kwds):
+        """
+        initialize ScrolledPanel then force a call to SetupScrolling
+
+        """
         ScrolledPanel.__init__(self, parent, *args, **kwds)
         self.SetupScrolling()
@@ -87 +115 @@
 
 class GridCellEditor(sheet.CCellEditor):
-    """ Custom cell editor """
+    """
+    Custom cell editor
+
+    This subclasses the sheet.CCellEditor (itself a subclass of
+    grid.GridCellEditor) in order to override two of its methods:
+    PaintBackrgound and EndEdit.
+    
+    This is necessary as the sheet module is broken in wx 3.0.2 and
+    improperly subclasses grid.GridCellEditor
+    """
     def __init__(self, grid):
+        """
+        Override of CCellEditor init. Runs the grid.GridCellEditor init code
+        """
         super(GridCellEditor, self).__init__(grid)
 
+    def PaintBackground(self, dc, rect, attr):
+        """
+        Overrides wx.sheet.CCellEditor.PaintBackground which incorrectly calls
+        the base class method.
+
+        In wx3.0 all paint objects must explicitly
+        have a wxPaintDC (Device Context) object.  Thus the paint event which
+        generates a call to this method provides such a DC object and the
+        base class in grid expects to receive that object.  sheet was apparently
+        not updated to reflect this and hence fails.  This could thus
+        become obsolete in a future bug fix of wxPython.
+
+        Apart from adding a dc variable in the list of arguments in the def
+        and in the call to the base class the rest of this method is copied
+        as is from sheet.CCellEditor.PaintBackground
+
+        **From original GridCellEditor docs:**
+
+        Draws the part of the cell not occupied by the edit control.  The
+        base class version just fills it with background colour from the
+        attribute.
+
+        NOTE: There is no need to override this if you don't need
+        to do something out of the ordinary.
+
+        :param dc: the wxDC object for the paint
+        """
+        # Call base class method.
+        DC = dc
+        super(sheet.CCellEditor,self).PaintBackground(DC, rect, attr)
+
     def EndEdit(self, row, col, grid, previous):
-        """ 
-            Commit editing the current cell. Returns True if the value has changed.
-            @param previous: previous value in the cell
+        """
+        Commit editing the current cell. Returns True if the value has changed.
+
+        :param previous: previous value in the cell
         """
         changed = False                             # Assume value not changed
@@ -108 +180 @@
 class GridPage(sheet.CSheet):
     """
+    Class that receives the results of a batch fit.
+
+    GridPage displays the received results in a wx.grid using sheet.  This is
+    then used by GridPanel and GridFrame to present the full GUI.
     """
     def __init__(self, parent, panel=None):
         """
+        Initialize
+
+        Initialize all the attributes of GridPage, and the events. include
+        the init stuff from sheet.CSheet as well.
         """
         #sheet.CSheet.__init__(self, parent)
-        
+
         # The following is the __init__ from CSheet. ##########################
         # We re-write it here because the class is broken in wx 3.0,
@@ -139 +219 @@
 
         # Sink events
+        self.Bind(wx.grid.EVT_GRID_RANGE_SELECT, self.OnRangeSelect)
+        self.Bind(wx.grid.EVT_GRID_ROW_SIZE, self.OnRowSize)
+        self.Bind(wx.grid.EVT_GRID_COL_SIZE, self.OnColSize)
+        self.Bind(wx.grid.EVT_GRID_SELECT_CELL, self.OnGridSelectCell)
+        # NOTE: the following bind to standard sheet methods that are
+        # overriden in this subclassn - actually we have currently
+        # disabled the on_context_menu that would override the OnRightClick
+        self.Bind(wx.grid.EVT_GRID_CELL_CHANGE, self.OnCellChange)
         self.Bind(wx.grid.EVT_GRID_CELL_LEFT_CLICK, self.OnLeftClick)
         self.Bind(wx.grid.EVT_GRID_CELL_RIGHT_CLICK, self.OnRightClick)
         #self.Bind(wx.grid.EVT_GRID_CELL_LEFT_DCLICK, self.OnLeftDoubleClick)
-        self.Bind(wx.grid.EVT_GRID_RANGE_SELECT, self.OnRangeSelect)
-        self.Bind(wx.grid.EVT_GRID_ROW_SIZE, self.OnRowSize)
-        self.Bind(wx.grid.EVT_GRID_COL_SIZE, self.OnColSize)
-        self.Bind(wx.grid.EVT_GRID_CELL_CHANGE, self.OnCellChange)
-        self.Bind(wx.grid.EVT_GRID_SELECT_CELL, self.OnGridSelectCell)
         # This ends the __init__ section for CSheet. ##########################
+
+
+
+        # The following events must be bound even if CSheet is working 
+        # properly and does not need the above re-implementation of the
+        # CSheet init method.  Basically these override any intrinsic binding
+        self.Bind(wx.grid.EVT_GRID_LABEL_RIGHT_CLICK, self.on_right_click)
+        self.Bind(wx.grid.EVT_GRID_LABEL_LEFT_CLICK, self.on_left_click)
 
         self.AdjustScrollbars()
@@ -187 +278 @@
         if self.GetNumberCols() > 0:
             self.default_col_width = self.GetColSize(0)
+        # We have moved these to the top of the init section with the
+        # rest of the grid event bindings from the sheet init when
+        # appropriate
         #self.Bind(wx.grid.EVT_GRID_LABEL_LEFT_CLICK, self.on_left_click)
         #self.Bind(wx.grid.EVT_GRID_LABEL_RIGHT_CLICK, self.on_right_click)
@@ -194 +288 @@
 
     def OnLeftClick(self, event):
+        """
+        Overrides sheet.CSheet.OnLefClick.
+
+        Processes when a cell is selected by left clicking on that cell. First
+        process the base Sheet method then the current class specific method
+        """
         sheet.CSheet.OnLeftClick(self, event)
         self.on_selected_cell(event)
-        
-    def on_edit_cell(self, event):
-        """
+
+
+    def OnCellChange(self, event):
+        """
+        Overrides sheet.CSheet.OnCellChange.  
+
+        Processes when a cell has been edited by a cell editor. Checks for the
+        edited row being outside the max row to use attribute and if so updates
+        the last row.  Then calls the base handler using skip.
         """
         row, _ = event.GetRow(), event.GetCol()
@@ -209 +315 @@
     def on_selected_cell(self, event):
         """
-        Handler catching cell selection
-        """
+        Handler catching cell selection.
+
+        Called after calling base 'on left click' method.
+        """
+
         flag = event.CmdDown() or event.ControlDown()
         flag_shift = event.ShiftDown()
@@ -280 +389 @@
     def on_left_click(self, event):
         """
-        Catch the left click on label mouse event
-        """
+        Is triggered when the left mouse button is clicked while the mouse
+        is hovering over the column 'label.'
+
+        This processes the information on the selected column: the column name
+        (in row 0 of column) and the range of cells with a valid value to be
+        used by the GridPanel set_axis methods.
+        """
+
         flag = event.CmdDown() or event.ControlDown()
 
@@ -324 +439 @@
     def on_right_click(self, event):
         """
-        Catch the right click mouse
-        """
+        Is triggered when the right mouse button is clicked while the mouse
+        is hovering over the column 'label.'
+
+        This brings up a context menu that allows the deletion of the column,
+        or the insertion of a new column either to the right or left of the
+        current column.  If inserting a new column can insert a blank column or
+        choose a number of hidden columns.  By default all the error parameters
+        are in hidden columns so as to save space on the grid.  Also any other
+        intrinsic variables stored with the data such as Temperature, pressure,
+        time etc can be used to populate this menu.
+        """
+
         col = event.GetCol()
         row = event.GetRow()
@@ -360 +485 @@
     def insert_col_menu(self, menu, label, window):
         """
-        """
+        method called to populate the 'insert column before current column'
+        submenu.
+        """
+
         if self.data is None:
             return
@@ -380 +508 @@
     def insert_after_col_menu(self, menu, label, window):
         """
-        """
+        Method called to populate the 'insert column after current column'
+        submenu
+        """
+
         if self.data is None:
             return
@@ -401 +532 @@
     def on_remove_column(self, event=None):
         """
-        """
+        Called when user chooses remove from the column right click menu
+        Checks the columnn exists then calls the remove_column method
+        """
+
         if self.selected_cols is not None or len(self.selected_cols) > 0:
             col = self.selected_cols[0]
@@ -408 +542 @@
     def remove_column(self, col, numCols=1):
         """
-        Remove column to the current grid
-        """
+        Remove the col column from the current grid
+        """
+
         # add data to the grid    
         row = 0
@@ -429 +564 @@
     def on_insert_column(self, event):
         """
-        """
+        Called when user chooses insert 'column before' submenu
+        of the column context menu obtained when right clicking on a given
+        column header.
+
+        Sets up to insert column into the current grid before the current
+        highlighted column location and sets up what to populate that column
+        with.  Then calls insert_column method to actually do the insertion. 
+        """
+
         if self.selected_cols is not None or len(self.selected_cols) > 0:
             col = self.selected_cols[0]
@@ -442 +585 @@
     def on_insert_after_column(self, event):
         """
-        Insert the given column after the highlighted column
-        """
+        Called when user chooses insert 'column after' submenu
+        of the column context menu obtained when right clicking on a given
+        column header.
+
+        Sets up to insert column into the current grid after the current
+        highlighted column location and sets up what to populate that column
+        with.  Then calls insert_column method to actually do the insertion. 
+        """
+
         if self.selected_cols is not None or len(self.selected_cols) > 0:
             col = self.selected_cols[0] + 1
@@ -455 +605 @@
     def insert_column(self, col, col_name):
         """
-        """
+        Insert column at position col with data[col_name] into the current
+        grid.
+        """
+
         row = 0
         self.InsertCols(pos=col, numCols=1, updateLabels=True)
@@ -477 +630 @@
     def on_set_x_axis(self, event):
         """
-        """
+        Just calls the panel version of the method
+        """
+
         self.panel.set_xaxis(x=self.axis_value, label=self.axis_label)
 
     def on_set_y_axis(self, event):
         """
-        """
+        Just calls the panel version of the method
+        """
+
         self.panel.set_yaxis(y=self.axis_value, label=self.axis_label)
 
@@ -488 +645 @@
         """
         Add data to the grid
+
         :param data_inputs: data to use from the context menu of the grid
-        :param data_ouputs: default columns deplayed
-        """
+        :param data_ouputs: default columns displayed
+        """
+
         self.file_name = file_name
         self.details = details
@@ -527 +686 @@
         Set the values in grids
         """
+
         # add data to the grid
         row = 0
@@ -562 +722 @@
         Return value contained in the grid
         """
+
         grid_view = {}
         for col in xrange(self.GetNumberCols()):
@@ -584 +745 @@
     def onContextMenu(self, event):
         """
-        Default context menu
-        """
+        Method to handle cell right click context menu. 
+
+        THIS METHOD IS NOT CURRENTLY USED.  It is designed to provide a
+        cell pop up context by right clicking on a cell and gives the
+        option to cut, paste, and clear. This will probably be removed in
+        future versions and is being superceded by more traditional cut and
+        paste options.
+        """
+
         wx_id = wx.NewId()
         c_menu = wx.Menu()
@@ -620 +788 @@
     def on_copy(self, event):
         """
-        On copy event from the contextmenu
-        """
+        Called when copy is chosen from cell right click context menu
+
+        THIS METHOD IS NOT CURRENTLY USED.  it is part of right click cell
+        context menu which is being removed. This will probably be removed in
+        future versions and is being superceded by more traditional cut and
+        paste options
+        """
+
         self.Copy()
 
     def on_paste(self, event):
         """
-        On paste event from the contextmenu
-        """
+        Called when paste is chosen from cell right click context menu
+
+        THIS METHOD IS NOT CURRENTLY USED.  it is part of right click cell
+        context menu which is being removed. This will probably be removed in
+        future versions and is being superceded by more traditional cut and
+        paste options
+        """
+
         if self.data == None:
             self.data = {}
@@ -636 +816 @@
     def on_clear(self, event):
         """
-        Clear the cells selected
-        """
+        Called when clear cell is chosen from cell right click context menu
+
+        THIS METHOD IS NOT CURRENTLY USED.  it is part of right click cell
+        context menu which is being removed. This will probably be removed in
+        future versions and is being superceded by more traditional cut and
+        paste options
+        """
+
         self.Clear()
 
@@ -646 +832 @@
     ## Title to appear on top of the window
     """
+
     window_caption = "Notebook "
 
@@ -682 +869 @@
     def enable_close_button(self):
         """
-        display the close button on tab for more than 1 tabs else remove the
-        close button
-        """
+        display the close button on the tab if more than 1 tab exits.
+        Otherwise remove the close button
+        """
+
         if self.GetPageCount() <= 1:
             style = self.GetWindowStyleFlag()
@@ -700 +888 @@
     def on_edit_axis(self):
         """
-        Return the select cell of a given selected column. Check that all cells
-        are from the same column
-        """
+        Return the select cell range from a given selected column. Checks that
+        all cells are from the same column
+        """
+
         pos = self.GetSelection()
         grid = self.GetPage(pos)
@@ -732 +921 @@
         Add highlight rows
         """
+
         pos = self.GetSelection()
         grid = self.GetPage(pos)
@@ -759 +949 @@
     def get_column_labels(self):
         """
-        return dictionary of columns labels of the current page
-        """
+        return dictionary of columns labels on the current page
+        """
+
         pos = self.GetSelection()
         grid = self.GetPage(pos)
@@ -773 +964 @@
         """
         Receive a list of cells and  create a string presenting the selected
-        cells.
+        cells that can be used as data for one axis of a plot.
+
         :param cell_list: list of tuple
-
         """
         pos = self.GetSelection()
@@ -853 +1044 @@
         close the page
         """
+
         if self.GetPageCount() == 1:
             event.Veto()
@@ -858 +1050 @@
 
     def set_data(self, data_inputs, data_outputs, details="", file_name=None):
+        """
+        """
         if data_outputs is None or data_outputs == {}:
             return
@@ -880 +1074 @@
     def get_odered_results(self, inputs, outputs=None):
         """
-        Get ordered the results
-        """
+        Order a list of 'inputs.' Used to sort rows and columns to present
+        in batch results grid.
+        """
+
         # Let's re-order the data from the keys in 'Data' name.
         if outputs == None:
@@ -914 +1110 @@
         Append a new column to the grid
         """
+
+        # I Believe this is no longer used now that we have removed the 
+        # edit menu from the menubar - PDB July 12, 2015
         pos = self.GetSelection()
         grid = self.GetPage(pos)
@@ -922 +1121 @@
         Remove the selected column from the grid
         """
+        # I Believe this is no longer used now that we have removed the 
+        # edit menu from the menubar - PDB July 12, 2015
         pos = self.GetSelection()
         grid = self.GetPage(pos)
@@ -927 +1128 @@
 
 class GridPanel(SPanel):
+    """
+    A ScrolledPanel class that contains the grid sheet as well as a number of
+    widgets to create interesting plots and buttons for help etc.
+    """
+
     def __init__(self, parent, data_inputs=None,
                  data_outputs=None, *args, **kwds):
+        """
+        Initialize the GridPanel
+        """
+
         SPanel.__init__(self, parent, *args, **kwds)
 
@@ -990 +1200 @@
     def get_plot_axis(self, col, list):
         """
-
         """
         axis = []
@@ -1015 +1224 @@
     def on_view(self, event):
         """
-        Get object represented buy the given cell and plot them.
-        """
+        Get object represented by the given cells and plot them.  Basically
+        plot the colum in y vs the column in x.
+        """
+
         pos = self.notebook.GetSelection()
         grid = self.notebook.GetPage(pos)
@@ -1096 +1307 @@
         Evaluate the contains of textcrtl and plot result
         """
+
         pos = self.notebook.GetSelection()
         grid = self.notebook.GetPage(pos)
@@ -1203 +1415 @@
         running "file:///...."
 
-    :param evt: Triggers on clicking the help button
-    """
+        :param evt: Triggers on clicking the help button
+        """
+
         #import documentation window here to avoid circular imports
         #if put at top of file with rest of imports.
@@ -1218 +1431 @@
         Get sentence from dict
         """
+
         for tok, (col_name, list) in dict.iteritems():
             col = column_names[col_name]
@@ -1230 +1444 @@
     def layout_grid(self):
         """
-        Draw the area related to the grid
-        """
+        Draw the area related to the grid by adding it as the first element
+        in the panel's grid_sizer
+        """
+
         self.notebook = Notebook(parent=self)
         self.notebook.set_data(self._data_inputs, self._data_outputs)
@@ -1238 +1454 @@
     def layout_plotting_area(self):
         """
-        Draw area containing options to plot
-        """
+        Add the area containing all the plot options, buttons etc to a plotting
+        area sizer to later be added to the top level grid_sizer
+        """
+
         view_description = wx.StaticBox(self, -1, 'Plot Fits/Residuals')
         note = "To plot the fits (or residuals), click the 'View Fits' button"
@@ -1281 +1499 @@
                                    (self.plot_button, 0,
                                     wx.LEFT | wx.TOP | wx.BOTTOM, 12),
-                                   (self.help_button,0, 
+                                   (self.help_button,0,
                                     wx.LEFT | wx.TOP | wx.BOTTOM, 12)])
 
@@ -1316 +1534 @@
         Get the selected column on  the visible grid and set values for axis
         """
+
         try:
             cell_list = self.notebook.on_edit_axis()
@@ -1335 +1554 @@
         Receive a list of cells and  create a string presenting the selected
         cells.
+
         :param cell_list: list of tuple
-
-        """
+        """
+
         if self.notebook is not None:
             return self.notebook.create_axis_label(cell_list)
@@ -1345 +1565 @@
         get controls to modify
         """
+
         if label != None:
             tcrtl_label.SetValue(str(label))
@@ -1353 +1574 @@
         """
         """
+        # I Believe this is no longer used now that we have removed the
+        # edit menu from the menubar - PDB July 12, 2015
         if self.notebook is not None:
             self.notebook.add_column()
@@ -1359 +1582 @@
         """
         """
+        # I Believe this is no longer used now that we have removed the
+        # edit menu from the menubar - PDB July 12, 2015
         if self.notebook is not None:
             self.notebook.on_remove_column()
@@ -1364 +1589 @@
 
 class GridFrame(wx.Frame):
+    """
+    The main wx.Frame for the batch results grid
+    """
+
     def __init__(self, parent=None, data_inputs=None, data_outputs=None, id=-1,
-                 title="Grid Window", size=(800, 500)):
+                 title="Batch Fitting Results Panel", size=(800, 500)):
+        """
+        Initialize the Frame
+        """
+
         wx.Frame.__init__(self, parent=parent, id=id, title=title, size=size)
         self.parent = parent
@@ -1389 +1622 @@
         wx.EVT_MENU(self, self.save_menu.GetId(), self.on_save_page)
 
-        # To add the edit menu, call add_edit_menu() here.
-        self.edit = None
+        # We need to grab a WxMenu handle here, otherwise the next one to grab
+        # the handle will be treated as the Edit Menu handle when checking in
+        # on_menu_open event handler and thus raise an exception when it hits an 
+        # unitialized object.  Alternative is to comment out that whole section
+        # in on_menu_open, but that would make it more difficult to undo the
+        # hidding of the menu.   PDB  July 12, 2015.
+        #
+        # To enable the Edit menubar comment out next line and uncomment the
+        # following line.
+        self.edit = wx.Menu()
+        #self.add_edit_menu()
+
         self.Bind(wx.EVT_MENU_OPEN, self.on_menu_open)
-        
         self.Bind(wx.EVT_CLOSE, self.on_close)
 
     def add_edit_menu(self, menubar):
+        """
+        populates the edit menu on the menubar.  Not activated as of SasView
+        3.1.0
+        """
         self.edit = wx.Menu()
 
@@ -1429 +1675 @@
     def on_copy(self, event):
         """
-        On Copy
-        """
+        On Copy from the Edit menu item on the menubar
+        """
+        # I Believe this is no longer used now that we have removed the 
+        # edit menu from the menubar - PDB July 12, 2015
         if event != None:
             event.Skip()
@@ -1439 +1687 @@
     def on_paste(self, event):
         """
-        On Paste
-        """
+        On Paste from the Edit menu item on the menubar
+        """
+        # I Believe this is no longer used now that we have removed the 
+        # edit menu from the menubar - PDB July 12, 2015
         if event != None:
             event.Skip()
@@ -1449 +1699 @@
     def on_clear(self, event):
         """
-        On Clear
-        """
+        On Clear from the Edit menu item on the menubar
+        """
+        # I Believe this is no longer used now that we have removed the 
+        # edit menu from the menubar - PDB July 12, 2015
         pos = self.panel.notebook.GetSelection()
         grid = self.panel.notebook.GetPage(pos)
@@ -1466 +1718 @@
     def on_remove_column(self, event):
         """
-        On remove column
-        """
+        On remove column from the Edit menu Item on the menubar
+        """
+        # I Believe this is no longer used now that we have removed the 
+        # edit menu from the menubar - PDB July 12, 2015
         pos = self.panel.notebook.GetSelection()
         grid = self.panel.notebook.GetPage(pos)
@@ -1535 +1789 @@
     def on_save_page(self, event):
         """
-        """
+        Saves data in grid to a csv file.
+
+        At this time only the columns displayed get saved.  Thus any error
+        bars not inserted before saving will not be saved in the file
+        """
+
         if self.parent is not None:
             pos = self.panel.notebook.GetSelection()
@@ -1566 +1825 @@
     def on_open(self, event):
         """
-        Open file containg batch result
-        """
+        Open file containing batch result
+        """
+
         if self.parent is not None:
             self.parent.on_read_batch_tofile(self)
@@ -1575 +1835 @@
         open excel and display batch result in Excel
         """
+
         if self.parent is not None:
             pos = self.panel.notebook.GetSelection()
@@ -1625 +1886 @@
                  details="", *args, **kwds):
         """
+        Initialize dialog
+
         :param parent: Window instantiating this dialog
-        :param result: result to display in a grid or export to an external
+        :param result: result to display in a grid or export to an external\
                 application.
         """
+
         #kwds['style'] = wx.CAPTION|wx.SYSTEM_MENU
         wx.Frame.__init__(self, parent, *args, **kwds)
@@ -1651 +1915 @@
         Draw the content of the current dialog window
         """
+
         vbox = wx.BoxSizer(wx.VERTICAL)
         box_description = wx.StaticBox(self.panel, -1, str("Batch Outputs"))
@@ -1704 +1969 @@
         Get the user selection and display output to the selected application
         """
+
         if self.flag == 1:
             self.parent.open_with_localapp(data_inputs=self.data_inputs,
@@ -1715 +1981 @@
         close the Window
         """
+
         self.Close()
 
@@ -1721 +1988 @@
         Receive event and display data into third party application
         or save data to file.
-
         """
         if self.save_to_file.GetValue():

src/sas/guiframe/documentation_window.py

@@ -43 +43 @@
     (self, parent, dummy_id, path, url_instruction, title, size=(850, 540))
 
-    :param path: path to html file beginning AFTER /doc/ and ending in the
-    file.html
-    :param url_instructions: anchor string or other query e.g. '#MyAnchor
-    :param title - text to place in the title bar of the help panel
+    :param path: path to html file beginning AFTER /doc/ and ending in the\
+    file.html.
+    :param url_instructions: anchor string or other query e.g. '#MyAnchor'
+    :param title: text to place in the title bar of the help panel
     """
     def __init__(self, parent, dummy_id, path, url_instruction, title, size=(850, 540)):

src/sas/guiframe/local_perspectives/plotting/Plotter1D.py

@@ -564 +564 @@
             self._slicerpop.Append(wx_id, '&Print Image', 'Print image ')
             wx.EVT_MENU(self, wx_id, self.onPrint)
-            wx_id = wx.NewId()
-            self._slicerpop.Append(wx_id, '&Print Preview', 'Print preview')
-            wx.EVT_MENU(self, wx_id, self.onPrinterPreview)
 
             wx_id = wx.NewId()

src/sas/guiframe/local_perspectives/plotting/Plotter2D.py

@@ -300 +300 @@
 
         wx_id = wx.NewId()
-        slicerpop.Append(wx_id, '&Print Preview', 'Print preview')
-        wx.EVT_MENU(self, wx_id, self.onPrinterPreview)
-
-        wx_id = wx.NewId()
         slicerpop.Append(wx_id, '&Copy to Clipboard', 'Copy to the clipboard')
         wx.EVT_MENU(self, wx_id, self.OnCopyFigureMenu)

src/sas/guiframe/local_perspectives/plotting/SimplePlot.py

@@ -58 +58 @@
         slicerpop.Append(wx_id, '&Print Image', 'Print image')
         wx.EVT_MENU(self, wx_id, self.onPrint)
-
-        wx_id = wx.NewId()
-        slicerpop.Append(wx_id, '&Print Preview', 'Print preview')
-        wx.EVT_MENU(self, wx_id, self.onPrinterPreview)
 
         wx_id = wx.NewId()
@@ -234 +230 @@
         wx.EVT_MENU(self, id, self.on_print_image)
 
-        id = wx.NewId()
-        item = wx.MenuItem(menu, id, "&Print Preview")
-        item.SetBitmap(preview_bmp)
-        menu.AppendItem(item)
-        wx.EVT_MENU(self, id, self.on_print_preview)
-
         menu.AppendSeparator()
         id = wx.NewId()

src/sas/guiframe/report_dialog.py

@@ -66 +66 @@
         hbox.Add(button_close)
         button_close.SetFocus()
-
-        button_preview = wx.Button(self, wx.NewId(), "Preview")
-        button_preview.SetToolTipString("Print preview this report.")
-        button_preview.Bind(wx.EVT_BUTTON, self.onPreview,
-                            id=button_preview.GetId()) 
-        hbox.Add(button_preview)
 
         button_print = wx.Button(self, wx.NewId(), "Print")