-                      ra12c0a6
+                      r44d20af
 The organization of the classes goes as:
+.. image::  media/BatchGridClassLayout.png
+.. image::  ../../user/guiframe/BatchGridClassLayout.png
    :align:   center
 …
     """
     Object describing a cell in  the grid.
     """
     def __init__(self):
         """
         Initialize attributes of class (label, value, col, row, object)
         """
         self.label = ""
 …
     """
     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
     """
 …
 class GridCellEditor(sheet.CCellEditor):
     """
+    """
     Custom cell editor
     This subclasses the sheet.CCellEditor (itself a subclass of
     grid.GridCellEditor) in order to override two of its methods:
 …
     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
 …
         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
         :param dc: the wxDC object for the paint
+        -------
+        **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
 …
         to do something out of the ordinary.
+        :param dc: the wxDC object for the paint
         """
         # Call base class method.
 …
     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
         """
         changed = False                             # Assume value not changed
 …
     """
     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,
 …
         # 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.Bind(wx.grid.EVT_GRID_LABEL_LEFT_CLICK, self.on_left_click)
         self.AdjustScrollbars()
 …
         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
+        # 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)
 …
         """
         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 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.
+        the last row.  Then calls the base handler using skip.
         """
         row, _ = event.GetRow(), event.GetCol()
 …
         """
         Handler catching cell selection.
         Called after calling base 'on left click' method.
         """
 …
         """
         Is triggered when the left mouse button is clicked while the mouse
         is hovering over the column 'label.'
+        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()
 …
         """
         Is triggered when the right mouse button is clicked while the mouse
         is hovering over the column 'label.'
+        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
+        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
 …
         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()
 …
         method called to populate the 'insert column before current column'
         submenu.
+        """
+        """
         if self.data is None:
             return
 …
         Method called to populate the 'insert column after current column'
         submenu
+        """
+        """
         if self.data is None:
             return
 …
         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]
 …
         """
         Remove the col column from the current grid
+        """
+        """
         # add data to the grid
         row = 0
 …
         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]
 …
         Called when user chooses insert 'column after' submenu
         of the column context menu obtained when right clicking on a given
         column header.
+        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
 …
         Insert column at position col with data[col_name] into the current
         grid.
+        """
+        """
         row = 0
         self.InsertCols(pos=col, numCols=1, updateLabels=True)
 …
         """
         Just calls the panel version of the method
+        """
+        """
         self.panel.set_xaxis(x=self.axis_value, label=self.axis_label)
 …
         """
         Just calls the panel version of the method
+        """
+        """
         self.panel.set_yaxis(y=self.axis_value, label=self.axis_label)
 …
         """
         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
 …
         """
         Set the values in grids
+        """
+        """
         # add data to the grid
         row = 0
 …
         """
         Return value contained in the grid
+        """
+        """
         grid_view = {}
         for col in xrange(self.GetNumberCols()):
 …
         """
         Return number of total rows
         """
         return self._rows
 …
         """
         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
 …
         future versions and is being superceded by more traditional cut and
         paste options.
+        """
+        """
         wx_id = wx.NewId()
         c_menu = wx.Menu()
 …
         future versions and is being superceded by more traditional cut and
         paste options
         """
 …
         """
         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
         """
 …
         future versions and is being superceded by more traditional cut and
         paste options
         """
 …
     window_name = "Fit panel"
     ## Title to appear on top of the window
     """
     window_caption = "Notebook "
 …
         display the close button on the tab if more than 1 tab exits.
         Otherwise remove the close button
         """
 …
         Return the select cell range from a given selected column. Checks that
         all cells are from the same column
         """
 …
         """
         Add highlight rows
         """
 …
         """
         return dictionary of columns labels on the current page
         """
 …
         Receive a list of cells and  create a string presenting the selected
         cells that can be used as data for one axis of a plot.
         :param cell_list: list of tuple
         """
         pos = self.GetSelection()
 …
         """
         close the page
         """
 …
         Order a list of 'inputs.' Used to sort rows and columns to present
         in batch results grid.
         """
 …
         """
         Append a new column to the grid
         """
 …
         """
         Remove the selected column from the grid
         """
         # I Believe this is no longer used now that we have removed the
 …
     """
     A ScrolledPanel class that contains the grid sheet as well as a number of
+    widgets to create interesting plots and buttons for help etc.
+    widgets to create interesting plots and buttons for help etc.
     """
 …
         """
         Initialize the GridPanel
         """
 …
         Get object represented by the given cells and plot them.  Basically
         plot the colum in y vs the column in x.
         """
 …
         """
         Evaluate the contains of textcrtl and plot result
         """
 …
         :param evt: Triggers on clicking the help button
         """
 …
         """
         Get sentence from dict
         """
 …
         Draw the area related to the grid by adding it as the first element
         in the panel's grid_sizer
         """
 …
         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
         """
 …
                                    (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)])
 …
         """
         Get the selected column on  the visible grid and set values for axis
         """
 …
         :param cell_list: list of tuple
         """
 …
         """
         get controls to modify
         """
 …
         """
         """
         # I Believe this is no longer used now that we have removed the
+        # 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:
 …
         """
         """
         # I Believe this is no longer used now that we have removed the
+        # 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:
 …
     """
     The main wx.Frame for the batch results grid
     """
 …
         """
         Initialize the Frame
         """
 …
         populates the edit menu on the menubar.  Not activated as of SasView
 .1.0
         """
         self.edit = wx.Menu()
 …
     def on_copy(self, event):
         """
+        On Copy from the Edit menu item on the menubar
+        On Copy from the Edit menu item on the menubar
         """
         # I Believe this is no longer used now that we have removed the
 …
         """
         On Paste from the Edit menu item on the menubar
         """
         # I Believe this is no longer used now that we have removed the
 …
         """
         On Clear from the Edit menu item on the menubar
         """
         # I Believe this is no longer used now that we have removed the
 …
         """
         Get Label Text
         """
         for item in self.insert_before_menu.GetMenuItems():
 …
         """
         On remove column from the Edit menu Item on the menubar
         """
         # I Believe this is no longer used now that we have removed the
 …
         """
         On menu open
         """
         if self.file == event.GetMenu():
 …
         """
         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
         """
 …
         """
         Open file containing batch result
         """
 …
         """
         open excel and display batch result in Excel
         """
 …
         """
         Append a new column to the grid
         """
         self.panel.add_column()
 …
         """
         Set data
         """
         self.panel.notebook.set_data(data_inputs=data_inputs,
 …
         """
         Add a new table
         """
         # DO not event.Skip(): it will make 2 pages
 …
     """
     Allow to select where the result of batch will be displayed or stored
     """
     def __init__(self, parent, data_inputs, data_outputs, file_name="",
 …
         :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.
         """
 …
         """
         Draw the content of the current dialog window
         """
 …
         """
         Get the user selection and display output to the selected application
         """
 …
         """
         close the Window
         """
 …
         Receive event and display data into third party application
         or save data to file.
         """
         if self.save_to_file.GetValue():

Note: See TracChangeset for help on using the changeset viewer.

SasView

Changeset 44d20af in sasview for src/sas

Legend:

src/sas/guiframe/data_processor.py

Download in other formats: