sas.guiframe package

Subpackages

• sas.guiframe.local_perspectives package
  • Subpackages
    • sas.guiframe.local_perspectives.data_loader package
      • Submodules
      • sas.guiframe.local_perspectives.data_loader.data_loader module
      • sas.guiframe.local_perspectives.data_loader.load_thread module
      • Module contents
    • sas.guiframe.local_perspectives.plotting package
      • Submodules
      • sas.guiframe.local_perspectives.plotting.AnnulusSlicer module
      • sas.guiframe.local_perspectives.plotting.Arc module
      • sas.guiframe.local_perspectives.plotting.AzimutSlicer module
      • sas.guiframe.local_perspectives.plotting.BaseInteractor module
      • sas.guiframe.local_perspectives.plotting.Edge module
      • sas.guiframe.local_perspectives.plotting.Plotter1D module
      • sas.guiframe.local_perspectives.plotting.Plotter2D module
      • sas.guiframe.local_perspectives.plotting.SectorSlicer module
      • sas.guiframe.local_perspectives.plotting.SimplePlot module
      • sas.guiframe.local_perspectives.plotting.SlicerParameters module
      • sas.guiframe.local_perspectives.plotting.appearanceDialog module
      • sas.guiframe.local_perspectives.plotting.binder module
      • sas.guiframe.local_perspectives.plotting.boxMask module
      • sas.guiframe.local_perspectives.plotting.boxSlicer module
      • sas.guiframe.local_perspectives.plotting.boxSum module
      • sas.guiframe.local_perspectives.plotting.detector_dialog module
      • sas.guiframe.local_perspectives.plotting.graphAppearance module
      • sas.guiframe.local_perspectives.plotting.masking module
      • sas.guiframe.local_perspectives.plotting.plotting module
      • sas.guiframe.local_perspectives.plotting.profile_dialog module
      • sas.guiframe.local_perspectives.plotting.sector_mask module
      • sas.guiframe.local_perspectives.plotting.slicerpanel module
      • Module contents
  • Module contents

Submodules

sas.guiframe.CategoryInstaller module

Class for making sure all category stuff is installed and works fine.

Copyright (c) Institut Laue-Langevin 2012

@author kieranrcampbell@gmail.com @modified by NIST/MD sasview team

class sas.guiframe.CategoryInstaller.CategoryInstaller

Class for making sure all category stuff is installed

Note - class is entirely static!

static check_install(homedir=None, model_list=None)

the main method of this class makes sure serialized_cat.json exists and if not compile it and install :param homefile: Override the default home directory :param model_list: List of model names except customized models

static get_default_file()

returns the path of the default file e.g. blahblah/default_categories.json

static get_user_file()

returns the user data file, eg .sasview/serialized_cat.json

sas.guiframe.CategoryManager module

This software was developed by Institut Laue-Langevin as part of Distributed Data Analysis of Neutron Scattering Experiments (DANSE).

Copyright 2012 Institut Laue-Langevin

class sas.guiframe.CategoryManager.CategoryManager(parent, win_id, title)

Bases: wx._windows.Frame

A class for managing categories

dial_ok(dialog=None, model=None)

modify_dialog onclose

class sas.guiframe.CategoryManager.ChangeCat(parent, title, cat_list, current_cats)

Bases: wx._windows.Dialog

dialog for changing the categories of a model

get_category()

Returns a list of categories applying to this model

on_add(event)

Callback for new category added

on_existing(event)

Callback for existing category selected

on_newcat(event)

Callback for new category added

on_ok_mac(event)

On OK pressed (MAC only)

on_remove(event)

Callback for a category removed

class sas.guiframe.CategoryManager.CheckListCtrl(parent, callback_func)

Bases: wx._controls.ListCtrl, wx.lib.mixins.listctrl.CheckListCtrlMixin, wx.lib.mixins.listctrl.ListCtrlAutoWidthMixin

Taken from http://zetcode.com/wxpython/advanced/

OnCheckItem(index, flag)

When the user checks the item we need to save that state

sas.guiframe.CategoryManager.IS_MAC = False

Notes The category manager mechanism works from 3 data structures used: - self.master_category_dict: keys are the names of categories, the values are lists of tuples, the first being the model names (the models belonging to that category), the second a boolean of whether or not the model is enabled - self.by_model_dict: keys are model names, values are a list of categories belonging to that model - self.model_enabled_dict: keys are model names, values are bools of whether the model is enabled use self._regenerate_model_dict() to create the latter two structures from the former use self._regenerate_master_dict() to create the first structure from the latter two

The need for so many data structures comes from the fact sometimes we need fast access to all the models in a category (eg user selection from the gui) and sometimes we need access to all the categories corresponding to a model (eg user modification of model categories)

sas.guiframe.aboutbox module

class sas.guiframe.aboutbox.DialogAbout(*args, **kwds)

Bases: wx._windows.Dialog

“About” Dialog

Shows product name, current version, authors, and link to the product page. Current version is taken from version.py

onDanseLogo(event)

onEssLogo(event)

onIllLogo(event)

onIsisLogo(event)

onNistLogo(event)

onNsfLogo(event)

onSnsLogo(event)

onUTLogo(event)

onUmdLogo(event)

class sas.guiframe.aboutbox.MyApp(redirect=False, filename=None, useBestVisual=False, clearSigInt=True)

Bases: wx._core.App

OnInit()

sas.guiframe.aboutbox.launchBrowser(url)

Launches browser and opens specified url

In some cases may require BROWSER environment variable to be set up.

Parameters:url – URL to open

sas.guiframe.acknowledgebox module

Created on Feb 18, 2015

@author: jkrzywon

class sas.guiframe.acknowledgebox.DialogAcknowledge(*args, **kwds)

Bases: wx._windows.Dialog

“Acknowledgement” Dialog Box

Shows the current method for acknowledging SasView in scholarly publications.

class sas.guiframe.acknowledgebox.MyApp(redirect=False, filename=None, useBestVisual=False, clearSigInt=True)

Bases: wx._core.App

Class for running module as stand alone for testing

OnInit()

Defines an init when running as standalone

sas.guiframe.config module

Application settings

sas.guiframe.config.printEVT(message)

:TODO - need method documentation

sas.guiframe.custom_pstats module

class sas.guiframe.custom_pstats.CustomPstats(*args, **kwds)

Bases: pstats.Stats

write_stats(*amount)

sas.guiframe.custom_pstats.f8(x)

sas.guiframe.custom_pstats.func_std_string(func_name)

sas.guiframe.custom_pstats.profile(fn, name='profile.txt', *args, **kw)

sas.guiframe.customdir module

class sas.guiframe.customdir.SetupCustom

Bases: object

implement custom config dir

find_dir()

setup_dir(path)

sas.guiframe.dataFitting module

Adapters for fitting module

class sas.guiframe.dataFitting.Data1D(x=None, y=None, dx=None, dy=None)

Bases: sas.plottools.plottables.Data1D, sas.dataloader.data_info.Data1D

copy_from_datainfo(data1d)

copy values of Data1D of type DataLaoder.Data_info

class sas.guiframe.dataFitting.Data2D(image=None, err_image=None, qx_data=None, qy_data=None, q_data=None, mask=None, dqx_data=None, dqy_data=None, xmin=None, xmax=None, ymin=None, ymax=None, zmin=None, zmax=None)

Bases: sas.plottools.plottables.Data2D, sas.dataloader.data_info.Data2D

copy_from_datainfo(data2d)

copy value of Data2D of type DataLoader.data_info

class sas.guiframe.dataFitting.Theory1D(x=None, y=None, dy=None)

Bases: sas.plottools.plottables.Theory1D, sas.dataloader.data_info.Data1D

copy_from_datainfo(data1d)

copy values of Data1D of type DataLaoder.Data_info

sas.guiframe.dataFitting.check_data_validity(data)

Return True is data is valid enough to compute chisqr, else False

sas.guiframe.data_manager module

This module manages all data loaded into the application. Data_manager makes available all data loaded for the current perspective.

All modules “creating Data” posts their data to data_manager . Data_manager make these new data available for all other perspectives.

class sas.guiframe.data_manager.DataManager

Bases: object

Manage a list of data

add_data(data_list)

receive a list of

create_gui_data(data, path=None)

Receive data from loader and create a data to use for guiframe

delete_by_id(id_list=None)

save data and path

delete_by_name(name_list=None)

save data and path

delete_data(data_id, theory_id=None, delete_all=False)

delete_theory(data_id, theory_id)

freeze(theory_id)

freeze_theory(data_id, theory_id)

get_all_data()

return list of all available data

get_by_id(id_list=None)

get_by_name(name_list=None)

return a list of data given a list of data names

get_data_state(data_id)

Send list of selected data

get_message()

return message

rename(name)

rename data

update_data(prev_data, new_data)

update_theory(theory, data_id=None, state=None)

sas.guiframe.data_panel module

This module provides Graphic interface for the data_manager module.

class sas.guiframe.data_panel.DataDialog(data_list, parent=None, text='', *args, **kwds)

Bases: wx._windows.Dialog

Allow file selection at loading time

get_data()

return the selected data

class sas.guiframe.data_panel.DataFrame(parent=None, owner=None, manager=None, size=(300, 800), list_of_perspective=[], list=[], *args, **kwds)

Bases: wx._windows.Frame

Data Frame

ALWAYS_ON = True

load_data_list(list=[])

Fill the list inside its panel

window_caption = 'Data Panel'

window_name = 'Data Panel'

class sas.guiframe.data_panel.DataPanel(parent, list=None, size=(235, 700), id=-1, list_of_perspective=None, manager=None, *args, **kwds)

Bases: wx.lib.scrolledpanel.ScrolledPanel, sas.guiframe.panel_base.PanelBase

This panel displays data available in the application and widgets to interact with data.

append_theory(state_id, theory_list)

append theory object under data from a state of id = state_id replace that theory if already displayed

append_theory_helper(tree, root, state_id, theory_list)

Append theory helper

check_theory_to_freeze()

Check_theory_to_freeze

define_panel_structure()

Define the skeleton of the panel

disable_app_combo(enable)

Disable app combo box

do_layout()

Create the panel layout

enable_append()

enable or disable append button

enable_freeze()

enable or disable the freeze button

enable_import()

enable or disable send button

enable_plot()

enable or disable plot button

enable_remove()

enable or disable remove button

enable_remove_plot()

enable remove plot button if there is a plot panel on focus

enable_selection()

enable or disable combobo box selection

fill_cbox_analysis(plugin)

fill the combobox with analysis name

get_frame()

layout_batch()

Set up batch mode options

layout_button()

Layout widgets related to buttons

layout_data_list()

Add a listcrtl in the panel

layout_selection()

Create selection option combo box

load_data_list(list)

add need data with its theory under the tree

load_error(error=None)

Pop up an error message.

Parameters:error – details error message to be displayed

onContextMenu(event)

Retrieve the state selected state

on_append_plot(event=None)

append plot to plot panel on focus

on_batch_mode(event)

Change to batch mode :param event: UI event

on_check_item(event)

On check item

on_close(event)

On close event

on_close_page(event=None)

On close

on_close_plot(event)

clseo the panel on focus

on_data_info(event)

Data Info panel

on_edit_data(event)

Pop Up Data Editor

on_freeze(event)

On freeze to make a theory to a data set

on_import(event=None)

Get all select data and set them to the current active perspetive

on_plot(event=None)

Send a list of data names to plot

on_plot_3d(event)

Frozen image of 3D

on_quick_plot(event)

Frozen plot

on_remove(event)

Get a list of item checked and remove them from the treectrl Ask the parent to remove reference to this item

on_right_click_data(event)

Allow Editing Data

on_right_click_theory(event)

On click theory data

on_save_as(event)

Save data as a file

on_single_mode(event)

Change to single mode :param event: UI event

remove_by_id(id)

Remove_dat by id

set_active_perspective(name)

set the active perspective

set_data_helper()

Set data helper

set_frame(frame)

set_panel_on_focus(name=None)

set the plot panel on focus

set_plot_unfocus()

Unfocus plot

set_schedule_full_draw(panel=None, func='del')

Send full draw to guimanager

show_data_button()

show load data and remove data button if dataloader on else hide them

window_caption = 'Data Explorer'

window_name = 'Data Panel'

window_type = 'Data Panel'

class sas.guiframe.data_panel.DataTreeCtrl(parent, *args, **kwds)

Bases: wx.lib.agw.customtreectrl.CustomTreeCtrl

Check list control to be used for Data Panel

OnCompareItems(item1, item2)

Overrides OnCompareItems in wx.TreeCtrl. Used by the SortChildren method.

class sas.guiframe.data_panel.State

DataPanel State

sas.guiframe.data_panel.set_data_state(data=None, path=None, theory=None, state=None)

Set data state

sas.guiframe.data_processor module

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:

class sas.guiframe.data_processor.BatchCell

Bases: object

Object describing a cell in the grid.

class sas.guiframe.data_processor.BatchOutputFrame(parent, data_inputs, data_outputs, file_name='', details='', *args, **kwds)

Bases: wx._windows.Frame

Allow to select where the result of batch will be displayed or stored

on_apply(event)

Get the user selection and display output to the selected application

on_close(event)

close the Window

onselect(event=None)

Receive event and display data into third party application or save data to file.

class sas.guiframe.data_processor.GridCellEditor(grid)

Bases: wx.lib.sheet.CCellEditor

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

EndEdit(row, col, grid, previous)

Commit editing the current cell. Returns True if the value has changed.

Parameters:previous – previous value in the cell

PaintBackground(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.

Parameters:dc – the wxDC object for the paint

class sas.guiframe.data_processor.GridFrame(parent=None, data_inputs=None, data_outputs=None, id=-1, title='Batch Fitting Results Panel', size=(800, 500))

Bases: wx._windows.Frame

The main wx.Frame for the batch results grid

GetLabelText(id)

Get Label Text

add_edit_menu(menubar)

populates the edit menu on the menubar. Not activated as of SasView 3.1.0

add_table(event)

Add a new table

on_append_column(event)

Append a new column to the grid

on_clear(event)

On Clear from the Edit menu item on the menubar

on_close(event)

on_copy(event)

On Copy from the Edit menu item on the menubar

on_menu_open(event)

On menu open

on_open(event)

Open file containing batch result

on_paste(event)

On Paste from the Edit menu item on the menubar

on_remove_column(event)

On remove column from the Edit menu Item on the menubar

on_save_page(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

open_with_excel(event)

open excel and display batch result in Excel

set_data(data_inputs, data_outputs, details='', file_name=None)

Set data

class sas.guiframe.data_processor.GridPage(parent, panel=None)

Bases: wx.lib.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.

OnCellChange(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.

OnLeftClick(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

get_grid_view()

Return value contained in the grid

get_nofrows()

Return number of total rows

insert_after_col_menu(menu, label, window)

Method called to populate the ‘insert column after current column’ submenu

insert_col_menu(menu, label, window)

method called to populate the ‘insert column before current column’ submenu.

insert_column(col, col_name)

Insert column at position col with data[col_name] into the current grid.

onContextMenu(event)

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.

on_clear(event)

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

on_copy(event)

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

on_insert_after_column(event)

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.

on_insert_column(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.

on_left_click(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.

on_paste(event)

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

on_remove_column(event=None)

Called when user chooses remove from the column right click menu Checks the columnn exists then calls the remove_column method

on_right_click(event)

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.

on_selected_cell(event)

Handler catching cell selection.

Called after calling base ‘on left click’ method.

on_set_x_axis(event)

Just calls the panel version of the method

on_set_y_axis(event)

Just calls the panel version of the method

remove_column(col, numCols=1)

Remove the col column from the current grid

set_data(data_inputs, data_outputs, details, file_name)

Add data to the grid

Parameters:

• data_inputs – data to use from the context menu of the grid
• data_ouputs – default columns displayed

set_grid_values()

Set the values in grids

class sas.guiframe.data_processor.GridPanel(parent, data_inputs=None, data_outputs=None, *args, **kwds)

Bases: sas.guiframe.data_processor.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.

add_column()

create_axis_label(cell_list)

Receive a list of cells and create a string presenting the selected cells.

Parameters:cell_list – list of tuple

edit_axis_helper(tcrtl_label, tcrtl_title, label, title)

get controls to modify

get_plot_axis(col, list)

get_sentence(dict, sentence, column_names)

Get sentence from dict

layout_grid()

Draw the area related to the grid by adding it as the first element in the panel’s grid_sizer

layout_plotting_area()

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

on_edit_axis(event)

Get the selected column on the visible grid and set values for axis

on_help(event)

Bring up the Batch Grid Panel Usage Documentation whenever the HELP button is clicked.

Calls DocumentationWindow with the path of the location within the documentation tree (after /doc/ ....”. Note that when using old versions of Wx (before 2.9) and thus not the release version of installers, the help comes up at the top level of the file as webbrowser does not pass anything past the # to the browser when it is running “file:///....”

Parameters:evt – Triggers on clicking the help button

on_plot(event)

Evaluate the contains of textcrtl and plot result

on_remove_column()

on_view(event)

Get object represented by the given cells and plot them. Basically plot the colum in y vs the column in x.

set_dyaxis(label='', dy=None)

set_xaxis(label='', x=None)

set_yaxis(label='', y=None)

class sas.guiframe.data_processor.Notebook(parent, manager=None, data=None, *args, **kwargs)

Bases: wx.aui.AuiNotebook, sas.guiframe.panel_base.PanelBase

## Internal name for the AUI manager window_name = “Fit panel” ## Title to appear on top of the window

add_column()

Append a new column to the grid

add_empty_page()

create_axis_label(cell_list)

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.

Parameters:cell_list – list of tuple

enable_close_button()

display the close button on the tab if more than 1 tab exits. Otherwise remove the close button

get_column_labels()

return dictionary of columns labels on the current page

get_highlighted_row(is_number=True)

Add highlight rows

get_odered_results(inputs, outputs=None)

Order a list of ‘inputs.’ Used to sort rows and columns to present in batch results grid.

on_close_page(event)

close the page

on_edit_axis()

Return the select cell range from a given selected column. Checks that all cells are from the same column

on_remove_column()

Remove the selected column from the grid

set_data(data_inputs, data_outputs, details='', file_name=None)

window_caption = 'Notebook '

class sas.guiframe.data_processor.SPanel(parent, *args, **kwds)

Bases: wx.lib.scrolledpanel.ScrolledPanel

ensure proper scrolling of GridPanel

Adds a SetupScrolling call to the normal ScrolledPanel init. GridPanel then subclasses this class

sas.guiframe.data_processor.parse_string(sentence, list)

Return a dictionary of column label and index or row selected

Parameters:

• sentence – String to parse
• list – list of columns label

Returns:

col_dict

sas.guiframe.data_state module

class sas.guiframe.data_state.DataState(data=None, parent=None)

Bases: object

Store information about data

clone()

get_data()

get_message()

return message

get_name()

get_path()

return the path of the loaded data

get_theory()

set_data(data)

set_name(name)

set_path(path)

Set the path of the loaded data

set_theory(theory_data, theory_state=None)

sas.guiframe.documentation_window module

documentation module provides a simple means to add help throughout the application. It checks for the existence of html2 package needed to support fully html panel which supports css. The class defined here takes a title for the particular help panel, a pointer to the html documentation file of interest within the documentation tree along with a ‘command’ string such as a page anchor or a query string etc. The path to the doc directory is retrieved automatically by the class itself. Thus with these three pieces of information the class generates a panel with the appropriate title bar and help file formatted according the style sheets called in the html file. Finally, if an old version of Python is running and the html2 package is not available the class brings up the default browser and passes the file:/// string to it. In this case however the instruction portion is usually not passed for security reasons.

class sas.guiframe.documentation_window.DocumentationWindow(parent, dummy_id, path, url_instruction, title, size=(850, 540))

Bases: wx._windows.Frame

DocumentationWindow inherits from wx.Frame and provides a centralized coherent framework for all help documentation. Help files must be html files stored in an properly organized tree below the top ‘doc’ folder. In order to display the appropriate help file from anywhere in the gui, the code simply needs to know the location below the top level where the help file resides along with the name of the help file. called (self, parent, dummy_id, path, url_instruction, title, size=(850, 540))

Parameters:

• path – path to html file beginning AFTER /doc/ and ending in the file.html.
• url_instructions – anchor string or other query e.g. ‘#MyAnchor’
• title – text to place in the title bar of the help panel

sas.guiframe.documentation_window.main()

main loop function if running alone for testing.

sas.guiframe.dummyapp module

sas.guiframe.events module

sas.guiframe.gui_manager module

Gui manager: manages the widgets making up an application

class sas.guiframe.gui_manager.DefaultPanel(parent, *args, **kwds)

Bases: wx._windows.Panel, sas.guiframe.panel_base.PanelBase

Defines the API for a panels to work with the GUI manager

CENTER_PANE = True

window_caption = 'Welcome panel'

window_name = 'default'

class sas.guiframe.gui_manager.MDIFrame(parent, panel, title='Untitled', size=(300, 200))

Bases: wx._windows.MDIChildFrame

Frame for panels

OnClose(event)

On Close event

set_panel(panel)

set_panel_focus(event)

show_data_panel(action)

Turns on the data panel

The the data panel is optional. Most of its functions can be performed from the menu bar and from the plots.

class sas.guiframe.gui_manager.SasViewApp(redirect=False, filename=None, useBestVisual=False, clearSigInt=True)

Bases: wx._core.App

SasView application

OnInit()

When initialised

add_perspective(perspective)

Manually add a perspective to the application GUI

build_gui()

Build the GUI

clean_plugin_models(path)

Delete plugin models in app folder

Parameters:path – path of the plugin_models folder in app

display_splash_screen(parent, path='C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\sasview\\images\\SVwelcome_mini.png')

Displays the splash screen. It will exactly cover the main frame.

maximize_win()

Maximize the window after the frame shown

on_close_splash_screen(event)

When the splash screen is closed.

open_file()

open a state file at the start of the application

set_manager(manager)

Sets a reference to the application manager of the GUI manager (Frame)

set_welcome_panel(panel_class)

Set the welcome panel

Parameters:panel_class – class of the welcome panel to be instantiated

window_placement(size)

Determines the position and size of the application frame such that it fits on the user’s screen without obstructing (or being obstructed by) the Windows task bar. The maximum initial size in pixels is bounded by WIDTH x HEIGHT. For most monitors, the application will be centered on the screen; for very large monitors it will be placed on the left side of the screen.

class sas.guiframe.gui_manager.ViewerFrame(parent, title, size=(-1, -1), gui_style=381, style=541072960, pos=wx.Point(-1, -1))

Bases: wx._windows.MDIParentFrame

Main application frame

Close(event=None)

Quit the application

PopStatusText(*args, **kwds)

PushStatusText(*args, **kwds)

SetStatusText(*args, **kwds)

WindowClose(event=None)

Quit the application from x icon

add_data(data_list)

receive a dictionary of data from loader store them its data manager if possible send to data the current active perspective if the data panel is not active. :param data_list: dictionary of data’s ID and value Data

add_data_helper(data_list)

add_icon()

get list of child and attempt to add the default icon

add_perspective(plugin)

Add a perspective if it doesn’t already exist.

append_bookmark(event=None)

Bookmark available information of the panel on focus

build_gui()

Build the GUI by setting up the toolbar, menu and layout.

check_multimode(perspective=None)

Check the perspective have batch mode capablitity

create_gui_data(data, path=None)

delete_data(data)

Delete the data.

delete_panel(uid)

delete panel given uid

disable_app_menu(p_panel=None)

Disables all menus in the menubar

enable_add_data(new_plot)

Enable append data on a plot panel

enable_bookmark()

Bookmark

enable_copy()

enable copy related control

enable_drag(event=None)

drag

enable_edit_menu()

enable menu item under edit menu depending on the panel on focus

enable_paste()

enable paste

enable_preview()

preview

enable_print()

print

enable_redo()

enable redo

enable_reset()

reset the current panel

enable_save()

save

enable_undo()

enable undo related control

enable_zoom()

zoom

enable_zoom_in()

zoom in

enable_zoom_out()

zoom out

freeze(data_id, theory_id)

Saves theory/model and passes to data loader.

..warning:: This seems to be the exact same code as the next function called simply freeze. This probably needs fixing

full_draw()

Draw the panels with axes in the schedule to full dwar list

get_client_size()

return client size tuple

get_context_menu(plotpanel=None)

Get the context menu items made available by the different plug-ins. This function is used by the plotting module

get_current_context_menu(plotpanel=None)

Get the context menu items made available by the current plug-in. This function is used by the plotting module

get_current_perspective()

return the current perspective

get_data(path)

get_data_manager()

return the data manager.

get_paneinfo(name)

Get pane Caption from window_name

Parameters:name – window_name in AuiPaneInfo Returns:AuiPaneInfo of the name

get_save_location()

return the _default_save_location

get_schedule()

Get schedule

get_style()

Return the gui style

get_toolbar()

return the toolbar.

get_toolbar_height()

get_window_size()

Get window size

Returns:size Return type:tuple

load_data(path)

load data from command line

load_folder(path)

Load entire folder

load_from_cmd(path)

load data from cmd or application

load_state(path, is_project=False)

load data from command line or application

on_batch_selection(event=None)

Parameters:event – contains parameter enable. When enable is set to True the application is in Batch mode otherwise the application is in Single mode.

on_bookmark_panel(event=None)

bookmark panel

on_category_panel(event)

On cat panel

on_change_caption(name, old_caption, new_caption)

Change the panel caption

Parameters:

• name – window_name of the pane
• old_caption – current caption [string]
• new_caption – new caption [string]

on_change_categories(evt)

on_close_welcome_panel()

Close the welcome panel

on_color_selection(event)

Parameters:event – contains parameters for id and color

on_copy_panel(event=None)

copy the last panel on focus if possible

on_drag_panel(event=None)

drag apply to the panel on focus

on_load_data(event)

received an event to trigger load from data plugin

on_panel_close(event)

Gets called when the close event for a panel runs. This will check which panel has been closed and delete it.

on_paste_panel(event=None)

paste clipboard to the last panel on focus

on_preview_panel(event=None)

preview information on the panel on focus

on_print_panel(event=None)

print available information on the last panel on focus

on_read_batch_tofile(base)

Open a file dialog , extract the file to read and display values into a grid

on_redo_panel(event=None)

redo the last cancel action done on the last panel on focus

on_reset_panel(event=None)

reset the current panel

on_save_helper(doc, reader, panel, path)

Save state into a file

on_save_panel(event=None)

save possible information on the current panel

on_set_batch_result(data_outputs, data_inputs=None, plugin_name='')

Display data into a grid in batch mode and show the grid

on_set_plot_focus(panel)

Set focus on a plot panel

on_undo_panel(event=None)

undo previous action of the last panel on focus if possible

on_view(evt)

A panel was selected to be shown. If it’s not already shown, display it.

Parameters:evt – menu event

on_zoom_in_panel(event=None)

zoom in of the panel on focus

on_zoom_out_panel(event=None)

zoom out on the panel on focus

on_zoom_panel(event=None)

zoom on the current panel if possible

onfreeze(theory_id)

Saves theory/model and passes to data loader.

..warning:: This seems to be the exact same code as the next function called simply freeze. This probably needs fixing

open_with_externalapp(data, file_name, details='')

Display data in the another application , by default Excel

open_with_localapp(data_inputs=None, details='', file_name=None, data_outputs=None)

Display value of data into the application grid :param data: dictionary of string and list of items

plot_data(state_id, data_id=None, theory_id=None, append=False)

send a list of data to plot

popup_panel(p)

Add a panel object to the AUI manager

Parameters:p – panel object to add to the AUI manager Returns:ID of the event associated with the new panel [int]

post_init()

This initialization method is called after the GUI has been created and all plug-ins loaded. It calls the post_init() method of each plug-in (if it exists) so that final initialization can be done.

put_icon(frame)

Put icon on the tap of a panel

quit_guiframe()

Pop up message to make sure the user wants to quit the application

read_batch_tofile(file_name)

Extract value from file name and Display them into a grid

remove_data(data_id, theory_id=None)

Delete data state if data_id is provide delete theory created with data of id data_id if theory_id is provide if delete all true: delete the all state else delete theory

reset_bookmark_menu(panel)

Reset Bookmark menu list

: param panel: a control panel or tap where the bookmark is

save_data1d(data, fname)

Save data dialog

save_data2d(data, fname)

Save data2d dialog

send_focus_to_datapanel(name)

Send focusing on ID to data explorer

set_current_perspective(perspective)

set the current active perspective

set_custom_default_perspective()

Set default starting perspective

set_data(data_id, theory_id=None)

set data to current perspective

set_input_file(input_file)

Parameters:input_file – file to read

set_manager(manager)

Sets the application manager for this frame

Parameters:manager – frame manager

set_panel_on_focus(event)

Store reference to the last panel on focus update the toolbar if available update edit menu if available

set_panel_on_focus_helper()

Helper for panel on focus with data_panel

set_perspective(panels)

Sets the perspective of the GUI. Opens all the panels in the list, and closes all the others.

Parameters:panels – list of panels

set_plot_unfocus()

Un focus all plot panels

set_schedule(schedule=False)

Set schedule

set_schedule_full_draw(panel=None, func='del')

Add/subtract the schedule full draw list with the panel given

Parameters:

• panel – plot panel
• func – append or del [string]

set_theory(state_id, theory_id=None)

setup_custom_conf()

Set up custom configuration if exists

show_batch_frame(event=None)

show the grid of result

show_data1d(data, name)

Show data dialog

show_data2d(data, name)

Show data dialog

show_data_panel(event=None, action=True)

show the data panel

show_welcome_panel(event)

Display the welcome panel

update_data(prev_data, new_data)

Update the data.

update_theory(data_id, theory, state=None)

Update the theory

write_batch_tofile(data, file_name, details='')

Helper to write result from batch into cvs file

sas.guiframe.gui_manager.get_app_dir()

The application directory is the one where the default custom_config.py file resides.

Returns:app_path - the path to the applicatin directory

sas.guiframe.gui_manager.get_user_directory()

Returns the user’s home directory

sas.guiframe.gui_statusbar module

Defines and draws the status bar that should appear along the bottom of the main SasView window.

class sas.guiframe.gui_statusbar.Console(parent=None, status='', *args, **kwds)

Bases: wx._windows.Frame

The main class defining the Console window.

Close(event)

Calling close on the panel will hide the panel.

Parameters:event – A wx event.

set_message(status, event=None)

Exposing the base ConsolePanel set_message

Parameters:

• status – A status message to be sent to the console log.
• event – A wx event.

set_multiple_messages(messages=[])

Method to send an arbitrary number of messages to the console log

Parameters:messages – A list of strings to be sent to the console log.

class sas.guiframe.gui_statusbar.ConsolePanel(parent, *args, **kwargs)

Bases: wx._windows.Panel

Interaction class for adding messages to the Console log.

set_message(status='', event=None)

Adds a message to the console log as well as the main sasview.log

Parameters:

• status – A status message to be sent to the console log.
• event – A wx event.

class sas.guiframe.gui_statusbar.SPageStatusbar(parent, timeout=None, *args, **kwds)

Bases: wx._windows.StatusBar

class sas.guiframe.gui_statusbar.StatusBar(parent, id)

Bases: wx._windows.StatusBar

Application status bar

PopStatusText(*args, **kwds)

Override status bar

PushStatusText(*args, **kwds)

SetStatusText(text='', number=1, event=None)

Set the text that will be displayed in the status bar.

clear_gauge(msg='')

Hide the gauge

enable_clear_gauge()

clear the progress bar

get_msg_position()

Get the last known message that was displayed on the console window.

on_idle(event)

When the window is idle, check if the window has been resized

on_size(evt)

If the window is resized, redraw the window.

reposition()

Place the various fields in their proper position

set_dialog(event)

Display dialogbox

set_gauge(event)

change the state of the gauge according the state of the current job

set_icon(event)

Display icons related to the type of message sent to the statusbar when available. No icon is displayed if the message is empty

set_message(event)

display received message on the statusbar

set_status(event)

Update the status bar .

Parameters:

• type – type of message send. type must be in [“start”,”progress”,”update”,”stop”]
• msg – the message itself as string
• thread – if updatting using a thread status

sas.guiframe.gui_style module

Provide the style for guiframe

class sas.guiframe.gui_style.GUIFRAME

CALCULATOR_ON = 256

DATALOADER_ON = 16

DEFAULT_STYLE = 92

FIXED_PANEL = 4

FLOATING_PANEL = 2

MANAGER_ON = 1

MULTIPLE_APPLICATIONS = 92

PLOTTING_ON = 8

SINGLE_APPLICATION = 64

TOOLBAR_ON = 32

WELCOME_PANEL_ON = 128

class sas.guiframe.gui_style.GUIFRAME_ICON

BOOKMARK_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750368> >

BOOKMARK_ICON_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\bookmark.png'

COPY_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750348> >

COPY_ICON_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\copy.png'

DRAG_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x67503a8> >

DRAG_ID_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\drag_hand.png'

FRAME_ICON_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\ball.ico'

HIDE_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x67503f8> >

HIDE_ID_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\hide.png'

PASTE_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750358> >

PASTE_ICON_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\paste.png'

PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images'

PREVIEW_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x67503d8> >

PREVIEW_ID_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\report.png'

PRINT_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x67503e8> >

PRINT_ID_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\printer.png'

REDO_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750338> >

REDO_ICON_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\redo.png'

REPORT_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x67503c8> >

RESET_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x67503b8> >

RESET_ID_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\reset.png'

SAVE_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750318> >

SAVE_ICON_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\save.png'

UNDO_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750328> >

UNDO_ICON_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\undo.png'

ZOOM_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750398> >

ZOOM_ID_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\search_pan.png'

ZOOM_IN_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750378> >

ZOOM_IN_ID_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\zoom_in.png'

ZOOM_OUT_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x6750388> >

ZOOM_OUT_ID_PATH = 'C:\\jenkins\\workspace\\SasView_Win7_Ver2_py2.7_wxpython3.0_Git_Master\\build\\lib.win32-2.7\\sas\\guiframe\\images\\zoom_out.png'

class sas.guiframe.gui_style.GUIFRAME_ID

BOOKMARK_ID = 104

COPYAS_ID = 116

COPYEX_ID = 114

COPYLAT_ID = 115

COPY_ID = 102

CURRENT_APPLICATION = 113

CURVE_SYMBOL_NUM = 13

DRAG_ID = 109

PASTE_ID = 103

PREVIEW_ID = 111

PRINT_ID = 112

REDO_ID = 101

RESET_ID = 110

SAVE_ID = 105

UNDO_ID = 100

ZOOM_ID = 108

ZOOM_IN_ID = 106

ZOOM_OUT_ID = 107

sas.guiframe.gui_toolbar module

class sas.guiframe.gui_toolbar.GUIToolBar(parent, *args, **kwds)

Bases: wx._controls.ToolBar

Implement toolbar for guiframe

ID_BOOKMARK = 138

add_bookmark_default()

Add default items in bookmark menu

append_bookmark(event)

receive item to append on the toolbar button bookmark

append_bookmark_item(id, label)

Append a item in bookmark

do_layout()

enable_bookmark(panel)

enable_copy(panel)

enable_paste(panel)

enable_preview(panel)

enable_print(panel)

enable_redo(panel)

enable_reset(panel)

enable_save(panel)

enable_undo(panel)

enable_zoom(panel)

enable_zoom_in(panel)

enable_zoom_out(panel)

get_bookmark_items()

Get bookmark menu items

on_bind_button()

Bind the buttons

on_bookmark(event)

add book mark

remove_bookmark_item(item)

Remove a bookmark item

update_button(application_name='', panel_name='')

update_toolbar(panel=None)

sas.guiframe.gui_toolbar.clear_image(image)

sas.guiframe.panel_base module

class sas.guiframe.panel_base.PanelBase(parent=None)

Defines the API for a panels to work with the ViewerFrame toolbar and menu bar

get_bookmark_flag()

Get the bookmark flag to update appropriately the tool bar

get_copy_flag()

Get the copy flag to update appropriately the tool bar

get_data()

return list of current data

get_drag_flag()

Get the drag flag to update appropriately the tool bar

get_frame()

get_manager()

get_paste_flag()

Get the copy flag to update appropriately the tool bar

get_preview_flag()

Get the preview flag to update appropriately the tool bar

get_print_flag()

Get the print flag to update appropriately the tool bar

get_redo_flag()

Get the redo flag to update appropriately the tool bar

get_reset_flag()

Get the reset flag to update appropriately the tool bar

get_save_flag()

Get the save flag to update appropriately the tool bar

get_state()

return the current state

get_undo_flag()

Get the undo flag to update appropriately the tool bar

get_zoom_flag()

Get the zoom flag to update appropriately the tool bar

get_zoom_in_flag()

Get the zoom in flag to update appropriately the tool bar

get_zoom_out_flag()

Get the zoom out flag to update appropriately the tool bar

group_id = None

has_changed()

on_batch_selection(event)

Parameters:event – contains parameter enable. When enable is set to True the application is in Batch mode otherwise the application is in Single mode.

on_bookmark(event)

The derivative class is on bookmark mode if implemented

on_close(event)

Close event. Hide the whole window.

on_copy(event)

The copy action if possible

on_drag(event)

The derivative class allows dragging motion if implemented

on_kill_focus(event=None)

The derivative class is on unfocus if implemented

on_paste(event)

The paste action if possible

on_preview(event)

Display a printable version of the class derivative

on_redo(event)

The previous action is restored if possible

on_reset(event)

The derivative class state is restored

on_save(event)

The state of the derivative class is restored

on_set_focus(event=None)

The derivative class is on focus if implemented

on_tap_focus()

Update menu on clicking the panel tap

on_undo(event)

The current action is canceled

on_zoom(event)

The derivative class is on zoom mode (using pane) if zoom mode is implemented

on_zoom_in(event)

The derivative class is on zoom in mode if implemented

on_zoom_out(event)

The derivative class is on zoom out mode if implemented

save_project(doc=None)

return an xml node containing state of the panel that guiframe can write to file

set_manager(manager)

uid = None

sas.guiframe.pdfview module

class sas.guiframe.pdfview.PDFFrame(parent, id, title, path)

Bases: wx._windows.Frame

Frame for PDF panel

class sas.guiframe.pdfview.PDFPanel(parent, path=None)

Bases: wx._windows.Panel

Panel that contains the pdf reader

OnClose(event)

Close panel

OnLoad(event=None, path=None)

Load a pdf file

: Param path: full path to the file

OnNextPageButton(event)

Goes to Next page

OnOpenButton(event)

Open file button

OnPrevPageButton(event)

Goes to Previous page

class sas.guiframe.pdfview.TextFrame(parent, id, title, text)

Bases: wx._windows.Frame

Frame for PDF panel

class sas.guiframe.pdfview.TextPanel(parent, text=None)

Bases: wx.lib.scrolledpanel.ScrolledPanel

Panel that contains the text

OnClose(event)

Close panel

class sas.guiframe.pdfview.ViewApp(redirect=False, filename=None, useBestVisual=False, clearSigInt=True)

Bases: wx._core.App

OnInit()

sas.guiframe.plugin_base module

Defines the interface for a Plugin class that can be used by the gui_manager.

class sas.guiframe.plugin_base.PluginBase(name='Test_plugin')

Bases: object

This class defines the interface for a Plugin class that can be used by the gui_manager.

Plug-ins should be placed in a sub-directory called “perspectives”. For example, a plug-in called Foo should be place in “perspectives/Foo”. That directory contains at least two files:

1. perspectives/Foo/__init__.py contains two lines:

   PLUGIN_ID = "Foo plug-in 1.0"
   from Foo import *
   

2. perspectives/Foo/Foo.py contains the definition of the Plugin class for the Foo plug-in. The interface of that Plugin class should follow the interface of the class you are looking at.

See dummyapp.py for a plugin example.

add_color(color, id)

Adds color to a plugin

can_load_data()

if return True, then call handler to laod data

clear_panel()

clear all related panels

delete_data(data_id)

Delete all references of data which id are in data_list.

get_batch_capable()

Check if the plugin has a batch capability

get_context_menu(plotpanel=None)

This method is optional.

When the context menu of a plot is rendered, the get_context_menu method will be called to give you a chance to add a menu item to the context menu.

A ref to a plotpanel object is passed so that you can investigate the plot content and decide whether you need to add items to the context menu.

This method returns a list of menu items. Each item is itself a list defining the text to appear in the menu, a tool-tip help text, and a call-back method.

Parameters:graph – the Graph object to which we attach the context menu Returns:a list of menu items with call-back function

get_extensions()

return state reader and its extensions

get_frame()

Returns MDIChildFrame

get_panels(parent)

Create and return the list of wx.Panels for your plug-in. Define the plug-in perspective.

Panels should inherit from DefaultPanel defined below, or should present the same interface. They must define “window_caption” and “window_name”.

Parameters:parent – parent window Returns:list of panels

get_perspective()

Get the list of panel names for this perspective

get_tools()

Returns a set of menu entries for tools

is_always_active()

return True is this plugin is always active and it is local to guiframe even if the user is switching between perspectives

is_in_use(data_id)

get a data id a list of data name if data data is

currently used by the plugin and the name of the plugin

data_name = ‘None’ in_use = False example [(data_name, self.sub_menu)]

load_data(event)

Load data

load_folder(event)

Load entire folder

on_batch_selection(flag)

need to be overwritten by the derivated class

on_perspective(event=None)

Call back function for the perspective menu item. We notify the parent window that the perspective has changed.

Parameters:event – menu event

on_set_state_helper(event)

update state

populate_file_menu()

Append menu item under file menu item of the frame

populate_menu(parent)

Create and return the list of application menu items for the plug-in.

Parameters:parent – parent window Returns:plug-in menu

post_init()

Post initialization call back to close the loose ends

set_batch_selection(flag)

the plugin to its batch state if flag is True

set_data(data_list=None)

receive a list of data and use it in the current perspective

set_is_active(active=False)

Set if the perspective is always active

set_state(state=None, datainfo=None)

update state

set_theory(theory_list=None)

Parameters:theory_list – list of information related to available theory state

use_data()

return True if these plugin use data

sas.guiframe.proxy module

class sas.guiframe.proxy.Connection(url, timeout)

Bases: object

connect()

Performs the request and gets a response from self.url @return: response object from urllib2.urlopen

sas.guiframe.report_dialog module

Base class for reports. Child classes will need to implement the onSave() method.

class sas.guiframe.report_dialog.BaseReportDialog(report_list, *args, **kwds)

Bases: wx._windows.Dialog

HTML2PDF(data, filename)

Create a PDF file from html source string. Returns True is the file creation was successful. : data: html string : filename: name of file to be saved

OnClose(event=None)

Close the Dialog : event: Close button event

onPreview(event=None)

Preview : event: Preview button event

onPrint(event=None)

Print : event: Print button event

sas.guiframe.startup_configuration module

sas.guiframe.startup_configuration.PANEL_HEIGHT = 215

Dialog to set Appication startup configuration

class sas.guiframe.startup_configuration.StartupConfiguration(parent, gui, id=-1, title='Startup Setting')

Bases: wx._windows.Dialog

Dialog for Startup Configuration

OnCurrent(event=None)

Set to curent setup

OnDefault(event=None)

Set to default

write_custom_config()

Write custom configuration

write_string(fname, strings)

Write and Save file

sas.guiframe.utils module

Contains common classes and functions

class sas.guiframe.utils.IdList

Create a list of wx ids that can be reused.

Ids for items need to be unique within their context. In a dynamic application where the number of ids needed different each time the form is created, depending for example, on the number of items that need to be shown in the context menu, you cannot preallocate the ids that you are going to use for the form. Instead, you can use an IdList, which will reuse ids from context to context, adding new ones if the new context requires more than a previous context.

IdList is set up as an iterator, which returns new ids forever or until it runs out. This makes it pretty useful for defining menus:

class Form(wx.Dialog):
    _form_id_pool = IdList()
    def __init__(self):
        ...
        menu = wx.Menu()
        for item, wx_id in zip(menu_items, self._form_id_pool):
            name, description, callback = item
            menu.Append(wx_id, name, description)
            wx.EVT_MENU(self, wx_id, callback)
        ...

It is a little unusual to use an iterator outside of a loop, but it is supported. For example, when defining a form, your class definition might look something like:

class Form(wx.Dialog):
    _form_id_pool = IdList()
    def __init__(self, pairs, ...):
        ids = iter(_form_id_pool)
        ...
        wx.StaticText(self, ids.next(), "Some key-value pairs")
        for name, value in pairs:
            label = wx.StaticText(self, ids.next(), name)
            input = wx.TextCtrl(self, ids.next(), value=str(value))
            ...
        ...

If the dialog is really dynamic, and not defined all in one place, then save the id list iterator as self._ids = iter(_form_id_pool) in the constructor.

The wx documentation is not clear on whether ids need to be unique. Clearly different dialogs can use the same ids, as this is done for the standard button ids such as wx.ID_HELP. Presumably each widget on the form needs its own id, but whether these ids can match the ids of menu items is not indicated, or whether different submenus need their own ids. Using different id lists for menu items and widgets is safest, but probably not necessary. And what about notebook tabs. Do the ids need to be unique across all tabs?

class sas.guiframe.utils.PanelMenu(*args, **kwargs)

Bases: wx._core.Menu

graph = None

plots = None

set_graph(graph)

set_plots(plots)

sas.guiframe.utils.check_float(item)

Parameters:item – txtcrtl containing a value

sas.guiframe.utils.format_number(value, high=False)

Return a float in a standardized, human-readable formatted string

sas.guiframe.utils.look_for_tag(string1, begin, end=None)

this method remove the begin and end tags given by the user from the string .

Parameters:

• begin – the initial tag
• end – the final tag
• string – the string to check

Returns:

begin_flag==True if begin was found, end_flag==if end was found else return false, false

sas.guiframe.utils.parse_name(name, expression)

remove “_” in front of a name

sas.guiframe.utils.split_list(separator, mylist, n=0)

returns a list of string without white space of separator

Parameters:separator – the string to remove

sas.guiframe.utils.split_text(separator, string1, n=0)

return a list of string without white space of separator

Parameters:separator – the string to remove

Module contents

sas.guiframe.data_files()

Return the data files associated with guiframe images .

The format is a list of (directory, [files...]) pairs which can be used directly in setup(...,data_files=...) for setup.py.

sas.guiframe.get_data_path(media)

sas.guiframe.get_media_path(media)