source: sasview/dev/api/sas.guiframe.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 239.3 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.guiframe package &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../index.html" />
28    <link rel="up" title="sas package" href="sas.html" />
29    <link rel="next" title="sas.guiframe.local_perspectives package" href="sas.guiframe.local_perspectives.html" />
30    <link rel="prev" title="sas.fit package" href="sas.fit.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="../../genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="../../py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="sas.guiframe.local_perspectives.html" title="sas.guiframe.local_perspectives package"
44             accesskey="N">next</a> |</li>
45        <li class="right" >
46          <a href="sas.fit.html" title="sas.fit package"
47             accesskey="P">previous</a> |</li>
48        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
49          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
50          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
51          <li><a href="sas.html" accesskey="U">sas package</a> &raquo;</li> 
52      </ul>
53    </div> 
54
55    <div class="document">
56      <div class="documentwrapper">
57        <div class="bodywrapper">
58          <div class="body">
59           
60  <div class="section" id="sas-guiframe-package">
61<h1>sas.guiframe package</h1>
62<div class="section" id="subpackages">
63<h2>Subpackages</h2>
64<div class="toctree-wrapper compound">
65<ul>
66<li class="toctree-l1"><a class="reference internal" href="sas.guiframe.local_perspectives.html">sas.guiframe.local_perspectives package</a><ul>
67<li class="toctree-l2"><a class="reference internal" href="sas.guiframe.local_perspectives.html#subpackages">Subpackages</a><ul>
68<li class="toctree-l3"><a class="reference internal" href="sas.guiframe.local_perspectives.data_loader.html">sas.guiframe.local_perspectives.data_loader package</a><ul>
69<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.data_loader.html#submodules">Submodules</a></li>
70<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.data_loader.html#module-sas.guiframe.local_perspectives.data_loader.data_loader">sas.guiframe.local_perspectives.data_loader.data_loader module</a></li>
71<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.data_loader.html#module-sas.guiframe.local_perspectives.data_loader.help_panel">sas.guiframe.local_perspectives.data_loader.help_panel module</a></li>
72<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.data_loader.html#module-sas.guiframe.local_perspectives.data_loader.load_thread">sas.guiframe.local_perspectives.data_loader.load_thread module</a></li>
73<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.data_loader.html#module-sas.guiframe.local_perspectives.data_loader">Module contents</a></li>
74</ul>
75</li>
76<li class="toctree-l3"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html">sas.guiframe.local_perspectives.plotting package</a><ul>
77<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#submodules">Submodules</a></li>
78<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.AnnulusSlicer">sas.guiframe.local_perspectives.plotting.AnnulusSlicer module</a></li>
79<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.Arc">sas.guiframe.local_perspectives.plotting.Arc module</a></li>
80<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.AzimutSlicer">sas.guiframe.local_perspectives.plotting.AzimutSlicer module</a></li>
81<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.BaseInteractor">sas.guiframe.local_perspectives.plotting.BaseInteractor module</a></li>
82<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.Edge">sas.guiframe.local_perspectives.plotting.Edge module</a></li>
83<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.Plotter1D">sas.guiframe.local_perspectives.plotting.Plotter1D module</a></li>
84<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.Plotter2D">sas.guiframe.local_perspectives.plotting.Plotter2D module</a></li>
85<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.SectorSlicer">sas.guiframe.local_perspectives.plotting.SectorSlicer module</a></li>
86<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.SimplePlot">sas.guiframe.local_perspectives.plotting.SimplePlot module</a></li>
87<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.SlicerParameters">sas.guiframe.local_perspectives.plotting.SlicerParameters module</a></li>
88<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.appearanceDialog">sas.guiframe.local_perspectives.plotting.appearanceDialog module</a></li>
89<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.binder">sas.guiframe.local_perspectives.plotting.binder module</a></li>
90<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.boxMask">sas.guiframe.local_perspectives.plotting.boxMask module</a></li>
91<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.boxSlicer">sas.guiframe.local_perspectives.plotting.boxSlicer module</a></li>
92<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.boxSum">sas.guiframe.local_perspectives.plotting.boxSum module</a></li>
93<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.detector_dialog">sas.guiframe.local_perspectives.plotting.detector_dialog module</a></li>
94<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.graphAppearance">sas.guiframe.local_perspectives.plotting.graphAppearance module</a></li>
95<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.help_panel">sas.guiframe.local_perspectives.plotting.help_panel module</a></li>
96<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.masking">sas.guiframe.local_perspectives.plotting.masking module</a></li>
97<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.plotting">sas.guiframe.local_perspectives.plotting.plotting module</a></li>
98<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.profile_dialog">sas.guiframe.local_perspectives.plotting.profile_dialog module</a></li>
99<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.sectorMask">sas.guiframe.local_perspectives.plotting.sectorMask module</a></li>
100<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting.slicerpanel">sas.guiframe.local_perspectives.plotting.slicerpanel module</a></li>
101<li class="toctree-l4"><a class="reference internal" href="sas.guiframe.local_perspectives.plotting.html#module-sas.guiframe.local_perspectives.plotting">Module contents</a></li>
102</ul>
103</li>
104</ul>
105</li>
106<li class="toctree-l2"><a class="reference internal" href="sas.guiframe.local_perspectives.html#module-sas.guiframe.local_perspectives">Module contents</a></li>
107</ul>
108</li>
109</ul>
110</div>
111</div>
112<div class="section" id="submodules">
113<h2>Submodules</h2>
114</div>
115<div class="section" id="module-sas.guiframe.CategoryInstaller">
116<span id="sas-guiframe-categoryinstaller-module"></span><h2>sas.guiframe.CategoryInstaller module</h2>
117<p>Class for making sure all category stuff is installed
118and works fine.</p>
119<p>Copyright (c) Institut Laue-Langevin 2012</p>
120<p>&#64;author <a class="reference external" href="mailto:kieranrcampbell&#37;&#52;&#48;gmail&#46;com">kieranrcampbell<span>&#64;</span>gmail<span>&#46;</span>com</a>
121&#64;modified by NIST/MD sasview team</p>
122<dl class="class">
123<dt id="sas.guiframe.CategoryInstaller.CategoryInstaller">
124<em class="property">class </em><tt class="descclassname">sas.guiframe.CategoryInstaller.</tt><tt class="descname">CategoryInstaller</tt><a class="reference internal" href="../../_modules/sas/guiframe/CategoryInstaller.html#CategoryInstaller"><span class="viewcode-link">[source]</span></a></dt>
125<dd><p>Class for making sure all category stuff is installed</p>
126<p>Note - class is entirely static!</p>
127<dl class="staticmethod">
128<dt id="sas.guiframe.CategoryInstaller.CategoryInstaller.check_install">
129<em class="property">static </em><tt class="descname">check_install</tt><big>(</big><em>homedir=None</em>, <em>model_list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryInstaller.html#CategoryInstaller.check_install"><span class="viewcode-link">[source]</span></a></dt>
130<dd><p>the main method of this class
131makes sure serialized_cat.json exists and if not
132compile it and install
133:param homefile: Override the default home directory
134:param model_list: List of model names except customized models</p>
135</dd></dl>
136
137<dl class="staticmethod">
138<dt id="sas.guiframe.CategoryInstaller.CategoryInstaller.get_default_file">
139<em class="property">static </em><tt class="descname">get_default_file</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryInstaller.html#CategoryInstaller.get_default_file"><span class="viewcode-link">[source]</span></a></dt>
140<dd><p>returns the path of the default file
141e.g. blahblah/default_categories.json</p>
142</dd></dl>
143
144<dl class="staticmethod">
145<dt id="sas.guiframe.CategoryInstaller.CategoryInstaller.get_user_file">
146<em class="property">static </em><tt class="descname">get_user_file</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryInstaller.html#CategoryInstaller.get_user_file"><span class="viewcode-link">[source]</span></a></dt>
147<dd><p>returns the user data file, eg .sasview/serialized_cat.json</p>
148</dd></dl>
149
150</dd></dl>
151
152</div>
153<div class="section" id="module-sas.guiframe.CategoryManager">
154<span id="sas-guiframe-categorymanager-module"></span><h2>sas.guiframe.CategoryManager module</h2>
155<p>This software was developed by Institut Laue-Langevin as part of
156Distributed Data Analysis of Neutron Scattering Experiments (DANSE).</p>
157<p>Copyright 2012 Institut Laue-Langevin</p>
158<dl class="class">
159<dt id="sas.guiframe.CategoryManager.CategoryManager">
160<em class="property">class </em><tt class="descclassname">sas.guiframe.CategoryManager.</tt><tt class="descname">CategoryManager</tt><big>(</big><em>parent</em>, <em>win_id</em>, <em>title</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#CategoryManager"><span class="viewcode-link">[source]</span></a></dt>
161<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
162<p>A class for managing categories</p>
163<dl class="method">
164<dt id="sas.guiframe.CategoryManager.CategoryManager.dial_ok">
165<tt class="descname">dial_ok</tt><big>(</big><em>dialog=None</em>, <em>model=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#CategoryManager.dial_ok"><span class="viewcode-link">[source]</span></a></dt>
166<dd><p>modify_dialog onclose</p>
167</dd></dl>
168
169</dd></dl>
170
171<dl class="class">
172<dt id="sas.guiframe.CategoryManager.ChangeCat">
173<em class="property">class </em><tt class="descclassname">sas.guiframe.CategoryManager.</tt><tt class="descname">ChangeCat</tt><big>(</big><em>parent</em>, <em>title</em>, <em>cat_list</em>, <em>current_cats</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#ChangeCat"><span class="viewcode-link">[source]</span></a></dt>
174<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
175<p>dialog for changing the categories of a model</p>
176<dl class="method">
177<dt id="sas.guiframe.CategoryManager.ChangeCat.get_category">
178<tt class="descname">get_category</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#ChangeCat.get_category"><span class="viewcode-link">[source]</span></a></dt>
179<dd><p>Returns a list of categories applying to this model</p>
180</dd></dl>
181
182<dl class="method">
183<dt id="sas.guiframe.CategoryManager.ChangeCat.on_add">
184<tt class="descname">on_add</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#ChangeCat.on_add"><span class="viewcode-link">[source]</span></a></dt>
185<dd><p>Callback for new category added</p>
186</dd></dl>
187
188<dl class="method">
189<dt id="sas.guiframe.CategoryManager.ChangeCat.on_existing">
190<tt class="descname">on_existing</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#ChangeCat.on_existing"><span class="viewcode-link">[source]</span></a></dt>
191<dd><p>Callback for existing category selected</p>
192</dd></dl>
193
194<dl class="method">
195<dt id="sas.guiframe.CategoryManager.ChangeCat.on_newcat">
196<tt class="descname">on_newcat</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#ChangeCat.on_newcat"><span class="viewcode-link">[source]</span></a></dt>
197<dd><p>Callback for new category added</p>
198</dd></dl>
199
200<dl class="method">
201<dt id="sas.guiframe.CategoryManager.ChangeCat.on_ok_mac">
202<tt class="descname">on_ok_mac</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#ChangeCat.on_ok_mac"><span class="viewcode-link">[source]</span></a></dt>
203<dd><p>On OK pressed (MAC only)</p>
204</dd></dl>
205
206<dl class="method">
207<dt id="sas.guiframe.CategoryManager.ChangeCat.on_remove">
208<tt class="descname">on_remove</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#ChangeCat.on_remove"><span class="viewcode-link">[source]</span></a></dt>
209<dd><p>Callback for a category removed</p>
210</dd></dl>
211
212</dd></dl>
213
214<dl class="class">
215<dt id="sas.guiframe.CategoryManager.CheckListCtrl">
216<em class="property">class </em><tt class="descclassname">sas.guiframe.CategoryManager.</tt><tt class="descname">CheckListCtrl</tt><big>(</big><em>parent</em>, <em>callback_func</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#CheckListCtrl"><span class="viewcode-link">[source]</span></a></dt>
217<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._controls.ListCtrl</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.mixins.listctrl.CheckListCtrlMixin</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.mixins.listctrl.ListCtrlAutoWidthMixin</span></tt></p>
218<p>Taken from
219<a class="reference external" href="http://zetcode.com/wxpython/advanced/">http://zetcode.com/wxpython/advanced/</a></p>
220<dl class="method">
221<dt id="sas.guiframe.CategoryManager.CheckListCtrl.OnCheckItem">
222<tt class="descname">OnCheckItem</tt><big>(</big><em>index</em>, <em>flag</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/CategoryManager.html#CheckListCtrl.OnCheckItem"><span class="viewcode-link">[source]</span></a></dt>
223<dd><p>When the user checks the item we need to save that state</p>
224</dd></dl>
225
226</dd></dl>
227
228<dl class="data">
229<dt id="sas.guiframe.CategoryManager.IS_MAC">
230<tt class="descclassname">sas.guiframe.CategoryManager.</tt><tt class="descname">IS_MAC</tt><em class="property"> = True</em></dt>
231<dd><p>Notes
232The category manager mechanism works from 3 data structures used:
233- self.master_category_dict: keys are the names of categories,
234the values are lists of tuples,
235the first being the model names (the models belonging to that
236category), the second a boolean
237of whether or not the model is enabled
238- self.by_model_dict: keys are model names, values are a list
239of categories belonging to that model
240- self.model_enabled_dict: keys are model names, values are
241bools of whether the model is enabled
242use self._regenerate_model_dict() to create the latter two
243structures from the former
244use self._regenerate_master_dict() to create the first
245structure from the latter two</p>
246<p>The need for so many data structures comes from the fact
247sometimes we need fast access
248to all the models in a category (eg user selection from the gui)
249and sometimes we need access to all the categories
250corresponding to a model (eg user modification of model categories)</p>
251</dd></dl>
252
253</div>
254<div class="section" id="module-sas.guiframe.aboutbox">
255<span id="sas-guiframe-aboutbox-module"></span><h2>sas.guiframe.aboutbox module</h2>
256<dl class="class">
257<dt id="sas.guiframe.aboutbox.DialogAbout">
258<em class="property">class </em><tt class="descclassname">sas.guiframe.aboutbox.</tt><tt class="descname">DialogAbout</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout"><span class="viewcode-link">[source]</span></a></dt>
259<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
260<p>&#8220;About&#8221; Dialog</p>
261<p>Shows product name, current version, authors, and link to the product page.
262Current version is taken from version.py</p>
263<dl class="method">
264<dt id="sas.guiframe.aboutbox.DialogAbout.onDanseLogo">
265<tt class="descname">onDanseLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onDanseLogo"><span class="viewcode-link">[source]</span></a></dt>
266<dd></dd></dl>
267
268<dl class="method">
269<dt id="sas.guiframe.aboutbox.DialogAbout.onEssLogo">
270<tt class="descname">onEssLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onEssLogo"><span class="viewcode-link">[source]</span></a></dt>
271<dd></dd></dl>
272
273<dl class="method">
274<dt id="sas.guiframe.aboutbox.DialogAbout.onIllLogo">
275<tt class="descname">onIllLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onIllLogo"><span class="viewcode-link">[source]</span></a></dt>
276<dd></dd></dl>
277
278<dl class="method">
279<dt id="sas.guiframe.aboutbox.DialogAbout.onIsisLogo">
280<tt class="descname">onIsisLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onIsisLogo"><span class="viewcode-link">[source]</span></a></dt>
281<dd></dd></dl>
282
283<dl class="method">
284<dt id="sas.guiframe.aboutbox.DialogAbout.onNistLogo">
285<tt class="descname">onNistLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onNistLogo"><span class="viewcode-link">[source]</span></a></dt>
286<dd></dd></dl>
287
288<dl class="method">
289<dt id="sas.guiframe.aboutbox.DialogAbout.onNsfLogo">
290<tt class="descname">onNsfLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onNsfLogo"><span class="viewcode-link">[source]</span></a></dt>
291<dd></dd></dl>
292
293<dl class="method">
294<dt id="sas.guiframe.aboutbox.DialogAbout.onSnsLogo">
295<tt class="descname">onSnsLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onSnsLogo"><span class="viewcode-link">[source]</span></a></dt>
296<dd></dd></dl>
297
298<dl class="method">
299<dt id="sas.guiframe.aboutbox.DialogAbout.onUTLogo">
300<tt class="descname">onUTLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onUTLogo"><span class="viewcode-link">[source]</span></a></dt>
301<dd></dd></dl>
302
303<dl class="method">
304<dt id="sas.guiframe.aboutbox.DialogAbout.onUmdLogo">
305<tt class="descname">onUmdLogo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#DialogAbout.onUmdLogo"><span class="viewcode-link">[source]</span></a></dt>
306<dd></dd></dl>
307
308</dd></dl>
309
310<dl class="class">
311<dt id="sas.guiframe.aboutbox.MyApp">
312<em class="property">class </em><tt class="descclassname">sas.guiframe.aboutbox.</tt><tt class="descname">MyApp</tt><big>(</big><em>redirect=False</em>, <em>filename=None</em>, <em>useBestVisual=False</em>, <em>clearSigInt=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#MyApp"><span class="viewcode-link">[source]</span></a></dt>
313<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.App</span></tt></p>
314<dl class="method">
315<dt id="sas.guiframe.aboutbox.MyApp.OnInit">
316<tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#MyApp.OnInit"><span class="viewcode-link">[source]</span></a></dt>
317<dd></dd></dl>
318
319</dd></dl>
320
321<dl class="function">
322<dt id="sas.guiframe.aboutbox.launchBrowser">
323<tt class="descclassname">sas.guiframe.aboutbox.</tt><tt class="descname">launchBrowser</tt><big>(</big><em>url</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/aboutbox.html#launchBrowser"><span class="viewcode-link">[source]</span></a></dt>
324<dd><p>Launches browser and opens specified url</p>
325<p>In some cases may require BROWSER environment variable to be set up.</p>
326<table class="docutils field-list" frame="void" rules="none">
327<col class="field-name" />
328<col class="field-body" />
329<tbody valign="top">
330<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>url</strong> &#8211; URL to open</td>
331</tr>
332</tbody>
333</table>
334</dd></dl>
335
336</div>
337<div class="section" id="module-sas.guiframe.config">
338<span id="sas-guiframe-config-module"></span><h2>sas.guiframe.config module</h2>
339<p>Application settings</p>
340<dl class="function">
341<dt id="sas.guiframe.config.printEVT">
342<tt class="descclassname">sas.guiframe.config.</tt><tt class="descname">printEVT</tt><big>(</big><em>message</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/config.html#printEVT"><span class="viewcode-link">[source]</span></a></dt>
343<dd></dd></dl>
344
345</div>
346<div class="section" id="module-sas.guiframe.custom_pstats">
347<span id="sas-guiframe-custom-pstats-module"></span><h2>sas.guiframe.custom_pstats module</h2>
348<dl class="class">
349<dt id="sas.guiframe.custom_pstats.CustomPstats">
350<em class="property">class </em><tt class="descclassname">sas.guiframe.custom_pstats.</tt><tt class="descname">CustomPstats</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/custom_pstats.html#CustomPstats"><span class="viewcode-link">[source]</span></a></dt>
351<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">pstats.Stats</span></tt></p>
352<dl class="method">
353<dt id="sas.guiframe.custom_pstats.CustomPstats.write_stats">
354<tt class="descname">write_stats</tt><big>(</big><em>*amount</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/custom_pstats.html#CustomPstats.write_stats"><span class="viewcode-link">[source]</span></a></dt>
355<dd></dd></dl>
356
357</dd></dl>
358
359<dl class="function">
360<dt id="sas.guiframe.custom_pstats.f8">
361<tt class="descclassname">sas.guiframe.custom_pstats.</tt><tt class="descname">f8</tt><big>(</big><em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/custom_pstats.html#f8"><span class="viewcode-link">[source]</span></a></dt>
362<dd></dd></dl>
363
364<dl class="function">
365<dt id="sas.guiframe.custom_pstats.func_std_string">
366<tt class="descclassname">sas.guiframe.custom_pstats.</tt><tt class="descname">func_std_string</tt><big>(</big><em>func_name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/custom_pstats.html#func_std_string"><span class="viewcode-link">[source]</span></a></dt>
367<dd></dd></dl>
368
369<dl class="function">
370<dt id="sas.guiframe.custom_pstats.profile">
371<tt class="descclassname">sas.guiframe.custom_pstats.</tt><tt class="descname">profile</tt><big>(</big><em>fn</em>, <em>name='profile.txt'</em>, <em>*args</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/custom_pstats.html#profile"><span class="viewcode-link">[source]</span></a></dt>
372<dd></dd></dl>
373
374</div>
375<div class="section" id="module-sas.guiframe.customdir">
376<span id="sas-guiframe-customdir-module"></span><h2>sas.guiframe.customdir module</h2>
377<dl class="class">
378<dt id="sas.guiframe.customdir.SetupCustom">
379<em class="property">class </em><tt class="descclassname">sas.guiframe.customdir.</tt><tt class="descname">SetupCustom</tt><a class="reference internal" href="../../_modules/sas/guiframe/customdir.html#SetupCustom"><span class="viewcode-link">[source]</span></a></dt>
380<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
381<p>implement custom config dir</p>
382<dl class="method">
383<dt id="sas.guiframe.customdir.SetupCustom.find_dir">
384<tt class="descname">find_dir</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/customdir.html#SetupCustom.find_dir"><span class="viewcode-link">[source]</span></a></dt>
385<dd></dd></dl>
386
387<dl class="method">
388<dt id="sas.guiframe.customdir.SetupCustom.setup_dir">
389<tt class="descname">setup_dir</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/customdir.html#SetupCustom.setup_dir"><span class="viewcode-link">[source]</span></a></dt>
390<dd></dd></dl>
391
392</dd></dl>
393
394</div>
395<div class="section" id="module-sas.guiframe.dataFitting">
396<span id="sas-guiframe-datafitting-module"></span><h2>sas.guiframe.dataFitting module</h2>
397<p>Adapters for fitting module</p>
398<dl class="class">
399<dt id="sas.guiframe.dataFitting.Data1D">
400<em class="property">class </em><tt class="descclassname">sas.guiframe.dataFitting.</tt><tt class="descname">Data1D</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dataFitting.html#Data1D"><span class="viewcode-link">[source]</span></a></dt>
401<dd><p>Bases: <a class="reference internal" href="sas.plottools.html#sas.plottools.plottables.Data1D" title="sas.plottools.plottables.Data1D"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Data1D</span></tt></a>, <a class="reference internal" href="sas.dataloader.html#sas.dataloader.data_info.Data1D" title="sas.dataloader.data_info.Data1D"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.data_info.Data1D</span></tt></a></p>
402<dl class="method">
403<dt id="sas.guiframe.dataFitting.Data1D.copy_from_datainfo">
404<tt class="descname">copy_from_datainfo</tt><big>(</big><em>data1d</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dataFitting.html#Data1D.copy_from_datainfo"><span class="viewcode-link">[source]</span></a></dt>
405<dd><p>copy values of Data1D of type DataLaoder.Data_info</p>
406</dd></dl>
407
408</dd></dl>
409
410<dl class="class">
411<dt id="sas.guiframe.dataFitting.Data2D">
412<em class="property">class </em><tt class="descclassname">sas.guiframe.dataFitting.</tt><tt class="descname">Data2D</tt><big>(</big><em>image=None</em>, <em>err_image=None</em>, <em>qx_data=None</em>, <em>qy_data=None</em>, <em>q_data=None</em>, <em>mask=None</em>, <em>dqx_data=None</em>, <em>dqy_data=None</em>, <em>xmin=None</em>, <em>xmax=None</em>, <em>ymin=None</em>, <em>ymax=None</em>, <em>zmin=None</em>, <em>zmax=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dataFitting.html#Data2D"><span class="viewcode-link">[source]</span></a></dt>
413<dd><p>Bases: <a class="reference internal" href="sas.plottools.html#sas.plottools.plottables.Data2D" title="sas.plottools.plottables.Data2D"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Data2D</span></tt></a>, <a class="reference internal" href="sas.dataloader.html#sas.dataloader.data_info.Data2D" title="sas.dataloader.data_info.Data2D"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.data_info.Data2D</span></tt></a></p>
414<dl class="method">
415<dt id="sas.guiframe.dataFitting.Data2D.copy_from_datainfo">
416<tt class="descname">copy_from_datainfo</tt><big>(</big><em>data2d</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dataFitting.html#Data2D.copy_from_datainfo"><span class="viewcode-link">[source]</span></a></dt>
417<dd><p>copy value of Data2D of type DataLoader.data_info</p>
418</dd></dl>
419
420</dd></dl>
421
422<dl class="class">
423<dt id="sas.guiframe.dataFitting.Theory1D">
424<em class="property">class </em><tt class="descclassname">sas.guiframe.dataFitting.</tt><tt class="descname">Theory1D</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dataFitting.html#Theory1D"><span class="viewcode-link">[source]</span></a></dt>
425<dd><p>Bases: <a class="reference internal" href="sas.plottools.html#sas.plottools.plottables.Theory1D" title="sas.plottools.plottables.Theory1D"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Theory1D</span></tt></a>, <a class="reference internal" href="sas.dataloader.html#sas.dataloader.data_info.Data1D" title="sas.dataloader.data_info.Data1D"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.data_info.Data1D</span></tt></a></p>
426<dl class="method">
427<dt id="sas.guiframe.dataFitting.Theory1D.copy_from_datainfo">
428<tt class="descname">copy_from_datainfo</tt><big>(</big><em>data1d</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dataFitting.html#Theory1D.copy_from_datainfo"><span class="viewcode-link">[source]</span></a></dt>
429<dd><p>copy values of Data1D of type DataLaoder.Data_info</p>
430</dd></dl>
431
432</dd></dl>
433
434<dl class="function">
435<dt id="sas.guiframe.dataFitting.check_data_validity">
436<tt class="descclassname">sas.guiframe.dataFitting.</tt><tt class="descname">check_data_validity</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dataFitting.html#check_data_validity"><span class="viewcode-link">[source]</span></a></dt>
437<dd><p>Return True is data is valid enough to compute chisqr, else False</p>
438</dd></dl>
439
440</div>
441<div class="section" id="module-sas.guiframe.data_manager">
442<span id="sas-guiframe-data-manager-module"></span><h2>sas.guiframe.data_manager module</h2>
443<p>This module manages all data loaded into the application. Data_manager makes
444available all data loaded  for the current perspective.</p>
445<p>All modules &#8220;creating Data&#8221; posts their data to data_manager .
446Data_manager  make these new data available for all other perspectives.</p>
447<dl class="class">
448<dt id="sas.guiframe.data_manager.DataManager">
449<em class="property">class </em><tt class="descclassname">sas.guiframe.data_manager.</tt><tt class="descname">DataManager</tt><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager"><span class="viewcode-link">[source]</span></a></dt>
450<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
451<p>Manage a list of data</p>
452<dl class="method">
453<dt id="sas.guiframe.data_manager.DataManager.add_data">
454<tt class="descname">add_data</tt><big>(</big><em>data_list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.add_data"><span class="viewcode-link">[source]</span></a></dt>
455<dd><p>receive a list of</p>
456</dd></dl>
457
458<dl class="method">
459<dt id="sas.guiframe.data_manager.DataManager.create_gui_data">
460<tt class="descname">create_gui_data</tt><big>(</big><em>data</em>, <em>path=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.create_gui_data"><span class="viewcode-link">[source]</span></a></dt>
461<dd><p>Receive data from loader and create a data to use for guiframe</p>
462</dd></dl>
463
464<dl class="method">
465<dt id="sas.guiframe.data_manager.DataManager.delete_by_id">
466<tt class="descname">delete_by_id</tt><big>(</big><em>id_list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.delete_by_id"><span class="viewcode-link">[source]</span></a></dt>
467<dd><p>save data and path</p>
468</dd></dl>
469
470<dl class="method">
471<dt id="sas.guiframe.data_manager.DataManager.delete_by_name">
472<tt class="descname">delete_by_name</tt><big>(</big><em>name_list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.delete_by_name"><span class="viewcode-link">[source]</span></a></dt>
473<dd><p>save data and path</p>
474</dd></dl>
475
476<dl class="method">
477<dt id="sas.guiframe.data_manager.DataManager.delete_data">
478<tt class="descname">delete_data</tt><big>(</big><em>data_id</em>, <em>theory_id=None</em>, <em>delete_all=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.delete_data"><span class="viewcode-link">[source]</span></a></dt>
479<dd></dd></dl>
480
481<dl class="method">
482<dt id="sas.guiframe.data_manager.DataManager.delete_theory">
483<tt class="descname">delete_theory</tt><big>(</big><em>data_id</em>, <em>theory_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.delete_theory"><span class="viewcode-link">[source]</span></a></dt>
484<dd></dd></dl>
485
486<dl class="method">
487<dt id="sas.guiframe.data_manager.DataManager.freeze">
488<tt class="descname">freeze</tt><big>(</big><em>theory_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.freeze"><span class="viewcode-link">[source]</span></a></dt>
489<dd></dd></dl>
490
491<dl class="method">
492<dt id="sas.guiframe.data_manager.DataManager.freeze_theory">
493<tt class="descname">freeze_theory</tt><big>(</big><em>data_id</em>, <em>theory_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.freeze_theory"><span class="viewcode-link">[source]</span></a></dt>
494<dd></dd></dl>
495
496<dl class="method">
497<dt id="sas.guiframe.data_manager.DataManager.get_all_data">
498<tt class="descname">get_all_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.get_all_data"><span class="viewcode-link">[source]</span></a></dt>
499<dd><p>return list of all available data</p>
500</dd></dl>
501
502<dl class="method">
503<dt id="sas.guiframe.data_manager.DataManager.get_by_id">
504<tt class="descname">get_by_id</tt><big>(</big><em>id_list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.get_by_id"><span class="viewcode-link">[source]</span></a></dt>
505<dd></dd></dl>
506
507<dl class="method">
508<dt id="sas.guiframe.data_manager.DataManager.get_by_name">
509<tt class="descname">get_by_name</tt><big>(</big><em>name_list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.get_by_name"><span class="viewcode-link">[source]</span></a></dt>
510<dd><p>return a list of data given a list of data names</p>
511</dd></dl>
512
513<dl class="method">
514<dt id="sas.guiframe.data_manager.DataManager.get_data_state">
515<tt class="descname">get_data_state</tt><big>(</big><em>data_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.get_data_state"><span class="viewcode-link">[source]</span></a></dt>
516<dd><p>Send list of selected data</p>
517</dd></dl>
518
519<dl class="method">
520<dt id="sas.guiframe.data_manager.DataManager.get_message">
521<tt class="descname">get_message</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.get_message"><span class="viewcode-link">[source]</span></a></dt>
522<dd><p>return message</p>
523</dd></dl>
524
525<dl class="method">
526<dt id="sas.guiframe.data_manager.DataManager.rename">
527<tt class="descname">rename</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.rename"><span class="viewcode-link">[source]</span></a></dt>
528<dd><p>rename data</p>
529</dd></dl>
530
531<dl class="method">
532<dt id="sas.guiframe.data_manager.DataManager.update_data">
533<tt class="descname">update_data</tt><big>(</big><em>prev_data</em>, <em>new_data</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.update_data"><span class="viewcode-link">[source]</span></a></dt>
534<dd></dd></dl>
535
536<dl class="method">
537<dt id="sas.guiframe.data_manager.DataManager.update_theory">
538<tt class="descname">update_theory</tt><big>(</big><em>theory</em>, <em>data_id=None</em>, <em>state=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_manager.html#DataManager.update_theory"><span class="viewcode-link">[source]</span></a></dt>
539<dd></dd></dl>
540
541</dd></dl>
542
543</div>
544<div class="section" id="module-sas.guiframe.data_panel">
545<span id="sas-guiframe-data-panel-module"></span><h2>sas.guiframe.data_panel module</h2>
546<p>This module provides Graphic interface for the data_manager module.</p>
547<dl class="class">
548<dt id="sas.guiframe.data_panel.DataDialog">
549<em class="property">class </em><tt class="descclassname">sas.guiframe.data_panel.</tt><tt class="descname">DataDialog</tt><big>(</big><em>data_list</em>, <em>parent=None</em>, <em>text=''</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataDialog"><span class="viewcode-link">[source]</span></a></dt>
550<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
551<p>Allow file selection at loading time</p>
552<dl class="method">
553<dt id="sas.guiframe.data_panel.DataDialog.get_data">
554<tt class="descname">get_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataDialog.get_data"><span class="viewcode-link">[source]</span></a></dt>
555<dd><p>return the selected data</p>
556</dd></dl>
557
558</dd></dl>
559
560<dl class="class">
561<dt id="sas.guiframe.data_panel.DataFrame">
562<em class="property">class </em><tt class="descclassname">sas.guiframe.data_panel.</tt><tt class="descname">DataFrame</tt><big>(</big><em>parent=None</em>, <em>owner=None</em>, <em>manager=None</em>, <em>size=(300</em>, <em>800)</em>, <em>list_of_perspective=[]</em>, <em>list=[]</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataFrame"><span class="viewcode-link">[source]</span></a></dt>
563<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
564<p>Data Frame</p>
565<dl class="attribute">
566<dt id="sas.guiframe.data_panel.DataFrame.ALWAYS_ON">
567<tt class="descname">ALWAYS_ON</tt><em class="property"> = True</em></dt>
568<dd></dd></dl>
569
570<dl class="method">
571<dt id="sas.guiframe.data_panel.DataFrame.load_data_list">
572<tt class="descname">load_data_list</tt><big>(</big><em>list=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataFrame.load_data_list"><span class="viewcode-link">[source]</span></a></dt>
573<dd><p>Fill the list inside its panel</p>
574</dd></dl>
575
576<dl class="attribute">
577<dt id="sas.guiframe.data_panel.DataFrame.window_caption">
578<tt class="descname">window_caption</tt><em class="property"> = 'Data Panel'</em></dt>
579<dd></dd></dl>
580
581<dl class="attribute">
582<dt id="sas.guiframe.data_panel.DataFrame.window_name">
583<tt class="descname">window_name</tt><em class="property"> = 'Data Panel'</em></dt>
584<dd></dd></dl>
585
586</dd></dl>
587
588<dl class="class">
589<dt id="sas.guiframe.data_panel.DataPanel">
590<em class="property">class </em><tt class="descclassname">sas.guiframe.data_panel.</tt><tt class="descname">DataPanel</tt><big>(</big><em>parent</em>, <em>list=None</em>, <em>size=(255</em>, <em>750)</em>, <em>id=-1</em>, <em>list_of_perspective=None</em>, <em>manager=None</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel"><span class="viewcode-link">[source]</span></a></dt>
591<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.scrolledpanel.ScrolledPanel</span></tt>, <a class="reference internal" href="#sas.guiframe.panel_base.PanelBase" title="sas.guiframe.panel_base.PanelBase"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.panel_base.PanelBase</span></tt></a></p>
592<p>This panel displays data available in the application and widgets to
593interact with data.</p>
594<dl class="method">
595<dt id="sas.guiframe.data_panel.DataPanel.append_theory">
596<tt class="descname">append_theory</tt><big>(</big><em>state_id</em>, <em>theory_list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.append_theory"><span class="viewcode-link">[source]</span></a></dt>
597<dd><p>append theory object under data from a state of id = state_id
598replace that theory if  already displayed</p>
599</dd></dl>
600
601<dl class="method">
602<dt id="sas.guiframe.data_panel.DataPanel.append_theory_helper">
603<tt class="descname">append_theory_helper</tt><big>(</big><em>tree</em>, <em>root</em>, <em>state_id</em>, <em>theory_list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.append_theory_helper"><span class="viewcode-link">[source]</span></a></dt>
604<dd><p>Append theory helper</p>
605</dd></dl>
606
607<dl class="method">
608<dt id="sas.guiframe.data_panel.DataPanel.check_theory_to_freeze">
609<tt class="descname">check_theory_to_freeze</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.check_theory_to_freeze"><span class="viewcode-link">[source]</span></a></dt>
610<dd><p>Check_theory_to_freeze</p>
611</dd></dl>
612
613<dl class="method">
614<dt id="sas.guiframe.data_panel.DataPanel.define_panel_structure">
615<tt class="descname">define_panel_structure</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.define_panel_structure"><span class="viewcode-link">[source]</span></a></dt>
616<dd><p>Define the skeleton of the panel</p>
617</dd></dl>
618
619<dl class="method">
620<dt id="sas.guiframe.data_panel.DataPanel.disable_app_combo">
621<tt class="descname">disable_app_combo</tt><big>(</big><em>enable</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.disable_app_combo"><span class="viewcode-link">[source]</span></a></dt>
622<dd><p>Disable app combo box</p>
623</dd></dl>
624
625<dl class="method">
626<dt id="sas.guiframe.data_panel.DataPanel.do_layout">
627<tt class="descname">do_layout</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.do_layout"><span class="viewcode-link">[source]</span></a></dt>
628<dd><p>Create the panel layout</p>
629</dd></dl>
630
631<dl class="method">
632<dt id="sas.guiframe.data_panel.DataPanel.enable_append">
633<tt class="descname">enable_append</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.enable_append"><span class="viewcode-link">[source]</span></a></dt>
634<dd><p>enable or disable append button</p>
635</dd></dl>
636
637<dl class="method">
638<dt id="sas.guiframe.data_panel.DataPanel.enable_freeze">
639<tt class="descname">enable_freeze</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.enable_freeze"><span class="viewcode-link">[source]</span></a></dt>
640<dd><p>enable or disable the freeze button</p>
641</dd></dl>
642
643<dl class="method">
644<dt id="sas.guiframe.data_panel.DataPanel.enable_import">
645<tt class="descname">enable_import</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.enable_import"><span class="viewcode-link">[source]</span></a></dt>
646<dd><p>enable or disable send button</p>
647</dd></dl>
648
649<dl class="method">
650<dt id="sas.guiframe.data_panel.DataPanel.enable_plot">
651<tt class="descname">enable_plot</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.enable_plot"><span class="viewcode-link">[source]</span></a></dt>
652<dd><p>enable or disable plot button</p>
653</dd></dl>
654
655<dl class="method">
656<dt id="sas.guiframe.data_panel.DataPanel.enable_remove">
657<tt class="descname">enable_remove</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.enable_remove"><span class="viewcode-link">[source]</span></a></dt>
658<dd><p>enable or disable remove button</p>
659</dd></dl>
660
661<dl class="method">
662<dt id="sas.guiframe.data_panel.DataPanel.enable_remove_plot">
663<tt class="descname">enable_remove_plot</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.enable_remove_plot"><span class="viewcode-link">[source]</span></a></dt>
664<dd><p>enable remove plot button if there is a plot panel on focus</p>
665</dd></dl>
666
667<dl class="method">
668<dt id="sas.guiframe.data_panel.DataPanel.enable_selection">
669<tt class="descname">enable_selection</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.enable_selection"><span class="viewcode-link">[source]</span></a></dt>
670<dd><p>enable or disable combobo box selection</p>
671</dd></dl>
672
673<dl class="method">
674<dt id="sas.guiframe.data_panel.DataPanel.fill_cbox_analysis">
675<tt class="descname">fill_cbox_analysis</tt><big>(</big><em>plugin</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.fill_cbox_analysis"><span class="viewcode-link">[source]</span></a></dt>
676<dd><p>fill the combobox with analysis name</p>
677</dd></dl>
678
679<dl class="method">
680<dt id="sas.guiframe.data_panel.DataPanel.get_frame">
681<tt class="descname">get_frame</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.get_frame"><span class="viewcode-link">[source]</span></a></dt>
682<dd></dd></dl>
683
684<dl class="method">
685<dt id="sas.guiframe.data_panel.DataPanel.layout_batch">
686<tt class="descname">layout_batch</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.layout_batch"><span class="viewcode-link">[source]</span></a></dt>
687<dd><p>Set up batch mode options</p>
688</dd></dl>
689
690<dl class="method">
691<dt id="sas.guiframe.data_panel.DataPanel.layout_button">
692<tt class="descname">layout_button</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.layout_button"><span class="viewcode-link">[source]</span></a></dt>
693<dd><p>Layout widgets related to buttons</p>
694</dd></dl>
695
696<dl class="method">
697<dt id="sas.guiframe.data_panel.DataPanel.layout_data_list">
698<tt class="descname">layout_data_list</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.layout_data_list"><span class="viewcode-link">[source]</span></a></dt>
699<dd><p>Add a listcrtl in the panel</p>
700</dd></dl>
701
702<dl class="method">
703<dt id="sas.guiframe.data_panel.DataPanel.layout_selection">
704<tt class="descname">layout_selection</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.layout_selection"><span class="viewcode-link">[source]</span></a></dt>
705<dd><p>Create selection option combo box</p>
706</dd></dl>
707
708<dl class="method">
709<dt id="sas.guiframe.data_panel.DataPanel.load_data_list">
710<tt class="descname">load_data_list</tt><big>(</big><em>list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.load_data_list"><span class="viewcode-link">[source]</span></a></dt>
711<dd><p>add need data with its theory under the tree</p>
712</dd></dl>
713
714<dl class="method">
715<dt id="sas.guiframe.data_panel.DataPanel.load_error">
716<tt class="descname">load_error</tt><big>(</big><em>error=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.load_error"><span class="viewcode-link">[source]</span></a></dt>
717<dd><p>Pop up an error message.</p>
718<table class="docutils field-list" frame="void" rules="none">
719<col class="field-name" />
720<col class="field-body" />
721<tbody valign="top">
722<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error</strong> &#8211; details error message to be displayed</td>
723</tr>
724</tbody>
725</table>
726</dd></dl>
727
728<dl class="method">
729<dt id="sas.guiframe.data_panel.DataPanel.onContextMenu">
730<tt class="descname">onContextMenu</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.onContextMenu"><span class="viewcode-link">[source]</span></a></dt>
731<dd><p>Retrieve the state selected state</p>
732</dd></dl>
733
734<dl class="method">
735<dt id="sas.guiframe.data_panel.DataPanel.on_append_plot">
736<tt class="descname">on_append_plot</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_append_plot"><span class="viewcode-link">[source]</span></a></dt>
737<dd><p>append plot to plot panel on focus</p>
738</dd></dl>
739
740<dl class="method">
741<dt id="sas.guiframe.data_panel.DataPanel.on_batch_mode">
742<tt class="descname">on_batch_mode</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_batch_mode"><span class="viewcode-link">[source]</span></a></dt>
743<dd><p>Change to batch mode
744:param event: UI event</p>
745</dd></dl>
746
747<dl class="method">
748<dt id="sas.guiframe.data_panel.DataPanel.on_check_item">
749<tt class="descname">on_check_item</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_check_item"><span class="viewcode-link">[source]</span></a></dt>
750<dd><p>On check item</p>
751</dd></dl>
752
753<dl class="method">
754<dt id="sas.guiframe.data_panel.DataPanel.on_close">
755<tt class="descname">on_close</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_close"><span class="viewcode-link">[source]</span></a></dt>
756<dd><p>On close event</p>
757</dd></dl>
758
759<dl class="method">
760<dt id="sas.guiframe.data_panel.DataPanel.on_close_page">
761<tt class="descname">on_close_page</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_close_page"><span class="viewcode-link">[source]</span></a></dt>
762<dd><p>On close</p>
763</dd></dl>
764
765<dl class="method">
766<dt id="sas.guiframe.data_panel.DataPanel.on_close_plot">
767<tt class="descname">on_close_plot</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_close_plot"><span class="viewcode-link">[source]</span></a></dt>
768<dd><p>clseo the panel on focus</p>
769</dd></dl>
770
771<dl class="method">
772<dt id="sas.guiframe.data_panel.DataPanel.on_data_info">
773<tt class="descname">on_data_info</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_data_info"><span class="viewcode-link">[source]</span></a></dt>
774<dd><p>Data Info panel</p>
775</dd></dl>
776
777<dl class="method">
778<dt id="sas.guiframe.data_panel.DataPanel.on_edit_data">
779<tt class="descname">on_edit_data</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_edit_data"><span class="viewcode-link">[source]</span></a></dt>
780<dd><p>Pop Up Data Editor</p>
781</dd></dl>
782
783<dl class="method">
784<dt id="sas.guiframe.data_panel.DataPanel.on_freeze">
785<tt class="descname">on_freeze</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_freeze"><span class="viewcode-link">[source]</span></a></dt>
786<dd><p>On freeze to make a theory to a data set</p>
787</dd></dl>
788
789<dl class="method">
790<dt id="sas.guiframe.data_panel.DataPanel.on_import">
791<tt class="descname">on_import</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_import"><span class="viewcode-link">[source]</span></a></dt>
792<dd><p>Get all select data and set them to the current active perspetive</p>
793</dd></dl>
794
795<dl class="method">
796<dt id="sas.guiframe.data_panel.DataPanel.on_plot">
797<tt class="descname">on_plot</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_plot"><span class="viewcode-link">[source]</span></a></dt>
798<dd><p>Send a list of data names to plot</p>
799</dd></dl>
800
801<dl class="method">
802<dt id="sas.guiframe.data_panel.DataPanel.on_plot_3d">
803<tt class="descname">on_plot_3d</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_plot_3d"><span class="viewcode-link">[source]</span></a></dt>
804<dd><p>Frozen image of 3D</p>
805</dd></dl>
806
807<dl class="method">
808<dt id="sas.guiframe.data_panel.DataPanel.on_quick_plot">
809<tt class="descname">on_quick_plot</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_quick_plot"><span class="viewcode-link">[source]</span></a></dt>
810<dd><p>Frozen plot</p>
811</dd></dl>
812
813<dl class="method">
814<dt id="sas.guiframe.data_panel.DataPanel.on_remove">
815<tt class="descname">on_remove</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_remove"><span class="viewcode-link">[source]</span></a></dt>
816<dd><p>Get a list of item checked and remove them from the treectrl
817Ask the parent to remove reference to this item</p>
818</dd></dl>
819
820<dl class="method">
821<dt id="sas.guiframe.data_panel.DataPanel.on_right_click_data">
822<tt class="descname">on_right_click_data</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_right_click_data"><span class="viewcode-link">[source]</span></a></dt>
823<dd><p>Allow Editing Data</p>
824</dd></dl>
825
826<dl class="method">
827<dt id="sas.guiframe.data_panel.DataPanel.on_right_click_theory">
828<tt class="descname">on_right_click_theory</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_right_click_theory"><span class="viewcode-link">[source]</span></a></dt>
829<dd><p>On click theory data</p>
830</dd></dl>
831
832<dl class="method">
833<dt id="sas.guiframe.data_panel.DataPanel.on_save_as">
834<tt class="descname">on_save_as</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_save_as"><span class="viewcode-link">[source]</span></a></dt>
835<dd><p>Save data as a file</p>
836</dd></dl>
837
838<dl class="method">
839<dt id="sas.guiframe.data_panel.DataPanel.on_single_mode">
840<tt class="descname">on_single_mode</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.on_single_mode"><span class="viewcode-link">[source]</span></a></dt>
841<dd><p>Change to single mode
842:param event: UI event</p>
843</dd></dl>
844
845<dl class="method">
846<dt id="sas.guiframe.data_panel.DataPanel.remove_by_id">
847<tt class="descname">remove_by_id</tt><big>(</big><em>id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.remove_by_id"><span class="viewcode-link">[source]</span></a></dt>
848<dd><p>Remove_dat by id</p>
849</dd></dl>
850
851<dl class="method">
852<dt id="sas.guiframe.data_panel.DataPanel.set_active_perspective">
853<tt class="descname">set_active_perspective</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.set_active_perspective"><span class="viewcode-link">[source]</span></a></dt>
854<dd><p>set the active perspective</p>
855</dd></dl>
856
857<dl class="method">
858<dt id="sas.guiframe.data_panel.DataPanel.set_data_helper">
859<tt class="descname">set_data_helper</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.set_data_helper"><span class="viewcode-link">[source]</span></a></dt>
860<dd><p>Set data helper</p>
861</dd></dl>
862
863<dl class="method">
864<dt id="sas.guiframe.data_panel.DataPanel.set_frame">
865<tt class="descname">set_frame</tt><big>(</big><em>frame</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.set_frame"><span class="viewcode-link">[source]</span></a></dt>
866<dd></dd></dl>
867
868<dl class="method">
869<dt id="sas.guiframe.data_panel.DataPanel.set_panel_on_focus">
870<tt class="descname">set_panel_on_focus</tt><big>(</big><em>name=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.set_panel_on_focus"><span class="viewcode-link">[source]</span></a></dt>
871<dd><p>set the plot panel on focus</p>
872</dd></dl>
873
874<dl class="method">
875<dt id="sas.guiframe.data_panel.DataPanel.set_plot_unfocus">
876<tt class="descname">set_plot_unfocus</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.set_plot_unfocus"><span class="viewcode-link">[source]</span></a></dt>
877<dd><p>Unfocus plot</p>
878</dd></dl>
879
880<dl class="method">
881<dt id="sas.guiframe.data_panel.DataPanel.set_schedule_full_draw">
882<tt class="descname">set_schedule_full_draw</tt><big>(</big><em>panel=None</em>, <em>func='del'</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.set_schedule_full_draw"><span class="viewcode-link">[source]</span></a></dt>
883<dd><p>Send full draw to guimanager</p>
884</dd></dl>
885
886<dl class="method">
887<dt id="sas.guiframe.data_panel.DataPanel.show_data_button">
888<tt class="descname">show_data_button</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataPanel.show_data_button"><span class="viewcode-link">[source]</span></a></dt>
889<dd><p>show load data and remove data button if
890dataloader on else hide them</p>
891</dd></dl>
892
893<dl class="attribute">
894<dt id="sas.guiframe.data_panel.DataPanel.window_caption">
895<tt class="descname">window_caption</tt><em class="property"> = 'Data Explorer'</em></dt>
896<dd></dd></dl>
897
898<dl class="attribute">
899<dt id="sas.guiframe.data_panel.DataPanel.window_name">
900<tt class="descname">window_name</tt><em class="property"> = 'Data Panel'</em></dt>
901<dd></dd></dl>
902
903<dl class="attribute">
904<dt id="sas.guiframe.data_panel.DataPanel.window_type">
905<tt class="descname">window_type</tt><em class="property"> = 'Data Panel'</em></dt>
906<dd></dd></dl>
907
908</dd></dl>
909
910<dl class="class">
911<dt id="sas.guiframe.data_panel.DataTreeCtrl">
912<em class="property">class </em><tt class="descclassname">sas.guiframe.data_panel.</tt><tt class="descname">DataTreeCtrl</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataTreeCtrl"><span class="viewcode-link">[source]</span></a></dt>
913<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.agw.customtreectrl.CustomTreeCtrl</span></tt></p>
914<p>Check list control to be used for Data Panel</p>
915<dl class="method">
916<dt id="sas.guiframe.data_panel.DataTreeCtrl.OnCompareItems">
917<tt class="descname">OnCompareItems</tt><big>(</big><em>item1</em>, <em>item2</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#DataTreeCtrl.OnCompareItems"><span class="viewcode-link">[source]</span></a></dt>
918<dd><p>Overrides OnCompareItems in wx.TreeCtrl.
919Used by the SortChildren method.</p>
920</dd></dl>
921
922</dd></dl>
923
924<dl class="class">
925<dt id="sas.guiframe.data_panel.State">
926<em class="property">class </em><tt class="descclassname">sas.guiframe.data_panel.</tt><tt class="descname">State</tt><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#State"><span class="viewcode-link">[source]</span></a></dt>
927<dd><p>DataPanel State</p>
928</dd></dl>
929
930<dl class="function">
931<dt id="sas.guiframe.data_panel.set_data_state">
932<tt class="descclassname">sas.guiframe.data_panel.</tt><tt class="descname">set_data_state</tt><big>(</big><em>data=None</em>, <em>path=None</em>, <em>theory=None</em>, <em>state=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_panel.html#set_data_state"><span class="viewcode-link">[source]</span></a></dt>
933<dd><p>Set data state</p>
934</dd></dl>
935
936</div>
937<div class="section" id="module-sas.guiframe.data_processor">
938<span id="sas-guiframe-data-processor-module"></span><h2>sas.guiframe.data_processor module</h2>
939<p>Implement grid used to store data</p>
940<dl class="class">
941<dt id="sas.guiframe.data_processor.BatchCell">
942<em class="property">class </em><tt class="descclassname">sas.guiframe.data_processor.</tt><tt class="descname">BatchCell</tt><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#BatchCell"><span class="viewcode-link">[source]</span></a></dt>
943<dd><p>Object describing a cell in  the grid.</p>
944</dd></dl>
945
946<dl class="class">
947<dt id="sas.guiframe.data_processor.BatchOutputFrame">
948<em class="property">class </em><tt class="descclassname">sas.guiframe.data_processor.</tt><tt class="descname">BatchOutputFrame</tt><big>(</big><em>parent</em>, <em>data_inputs</em>, <em>data_outputs</em>, <em>file_name=''</em>, <em>details=''</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#BatchOutputFrame"><span class="viewcode-link">[source]</span></a></dt>
949<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
950<p>Allow to select where the result of batch will be displayed or stored</p>
951<dl class="method">
952<dt id="sas.guiframe.data_processor.BatchOutputFrame.on_apply">
953<tt class="descname">on_apply</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#BatchOutputFrame.on_apply"><span class="viewcode-link">[source]</span></a></dt>
954<dd><p>Get the user selection and display output to the selected application</p>
955</dd></dl>
956
957<dl class="method">
958<dt id="sas.guiframe.data_processor.BatchOutputFrame.on_close">
959<tt class="descname">on_close</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#BatchOutputFrame.on_close"><span class="viewcode-link">[source]</span></a></dt>
960<dd><p>close the Window</p>
961</dd></dl>
962
963<dl class="method">
964<dt id="sas.guiframe.data_processor.BatchOutputFrame.onselect">
965<tt class="descname">onselect</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#BatchOutputFrame.onselect"><span class="viewcode-link">[source]</span></a></dt>
966<dd><p>Receive event and display data into third party application
967or save data to file.</p>
968</dd></dl>
969
970</dd></dl>
971
972<dl class="class">
973<dt id="sas.guiframe.data_processor.GridFrame">
974<em class="property">class </em><tt class="descclassname">sas.guiframe.data_processor.</tt><tt class="descname">GridFrame</tt><big>(</big><em>parent=None</em>, <em>data_inputs=None</em>, <em>data_outputs=None</em>, <em>id=-1</em>, <em>title='Grid Window'</em>, <em>size=(800</em>, <em>500)</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame"><span class="viewcode-link">[source]</span></a></dt>
975<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
976<dl class="method">
977<dt id="sas.guiframe.data_processor.GridFrame.GetLabelText">
978<tt class="descname">GetLabelText</tt><big>(</big><em>id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.GetLabelText"><span class="viewcode-link">[source]</span></a></dt>
979<dd><p>Get Label Text</p>
980</dd></dl>
981
982<dl class="method">
983<dt id="sas.guiframe.data_processor.GridFrame.add_table">
984<tt class="descname">add_table</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.add_table"><span class="viewcode-link">[source]</span></a></dt>
985<dd><p>Add a new table</p>
986</dd></dl>
987
988<dl class="method">
989<dt id="sas.guiframe.data_processor.GridFrame.on_append_column">
990<tt class="descname">on_append_column</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_append_column"><span class="viewcode-link">[source]</span></a></dt>
991<dd><p>Append a new column to the grid</p>
992</dd></dl>
993
994<dl class="method">
995<dt id="sas.guiframe.data_processor.GridFrame.on_clear">
996<tt class="descname">on_clear</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_clear"><span class="viewcode-link">[source]</span></a></dt>
997<dd><p>On Clear</p>
998</dd></dl>
999
1000<dl class="method">
1001<dt id="sas.guiframe.data_processor.GridFrame.on_close">
1002<tt class="descname">on_close</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_close"><span class="viewcode-link">[source]</span></a></dt>
1003<dd></dd></dl>
1004
1005<dl class="method">
1006<dt id="sas.guiframe.data_processor.GridFrame.on_copy">
1007<tt class="descname">on_copy</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_copy"><span class="viewcode-link">[source]</span></a></dt>
1008<dd><p>On Copy</p>
1009</dd></dl>
1010
1011<dl class="method">
1012<dt id="sas.guiframe.data_processor.GridFrame.on_menu_open">
1013<tt class="descname">on_menu_open</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_menu_open"><span class="viewcode-link">[source]</span></a></dt>
1014<dd><p>On menu open</p>
1015</dd></dl>
1016
1017<dl class="method">
1018<dt id="sas.guiframe.data_processor.GridFrame.on_open">
1019<tt class="descname">on_open</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_open"><span class="viewcode-link">[source]</span></a></dt>
1020<dd><p>Open file containg batch result</p>
1021</dd></dl>
1022
1023<dl class="method">
1024<dt id="sas.guiframe.data_processor.GridFrame.on_paste">
1025<tt class="descname">on_paste</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_paste"><span class="viewcode-link">[source]</span></a></dt>
1026<dd><p>On Paste</p>
1027</dd></dl>
1028
1029<dl class="method">
1030<dt id="sas.guiframe.data_processor.GridFrame.on_remove_column">
1031<tt class="descname">on_remove_column</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_remove_column"><span class="viewcode-link">[source]</span></a></dt>
1032<dd><p>On remove column</p>
1033</dd></dl>
1034
1035<dl class="method">
1036<dt id="sas.guiframe.data_processor.GridFrame.on_save_page">
1037<tt class="descname">on_save_page</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.on_save_page"><span class="viewcode-link">[source]</span></a></dt>
1038<dd></dd></dl>
1039
1040<dl class="method">
1041<dt id="sas.guiframe.data_processor.GridFrame.open_with_excel">
1042<tt class="descname">open_with_excel</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.open_with_excel"><span class="viewcode-link">[source]</span></a></dt>
1043<dd><p>open excel and display batch result in Excel</p>
1044</dd></dl>
1045
1046<dl class="method">
1047<dt id="sas.guiframe.data_processor.GridFrame.set_data">
1048<tt class="descname">set_data</tt><big>(</big><em>data_inputs</em>, <em>data_outputs</em>, <em>details=''</em>, <em>file_name=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridFrame.set_data"><span class="viewcode-link">[source]</span></a></dt>
1049<dd><p>Set data</p>
1050</dd></dl>
1051
1052</dd></dl>
1053
1054<dl class="class">
1055<dt id="sas.guiframe.data_processor.GridPage">
1056<em class="property">class </em><tt class="descclassname">sas.guiframe.data_processor.</tt><tt class="descname">GridPage</tt><big>(</big><em>parent</em>, <em>panel=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage"><span class="viewcode-link">[source]</span></a></dt>
1057<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.sheet.CSheet</span></tt></p>
1058<dl class="method">
1059<dt id="sas.guiframe.data_processor.GridPage.get_grid_view">
1060<tt class="descname">get_grid_view</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.get_grid_view"><span class="viewcode-link">[source]</span></a></dt>
1061<dd><p>Return value contained in the grid</p>
1062</dd></dl>
1063
1064<dl class="method">
1065<dt id="sas.guiframe.data_processor.GridPage.get_nofrows">
1066<tt class="descname">get_nofrows</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.get_nofrows"><span class="viewcode-link">[source]</span></a></dt>
1067<dd><p>Return number of total rows</p>
1068</dd></dl>
1069
1070<dl class="method">
1071<dt id="sas.guiframe.data_processor.GridPage.insert_after_col_menu">
1072<tt class="descname">insert_after_col_menu</tt><big>(</big><em>menu</em>, <em>label</em>, <em>window</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.insert_after_col_menu"><span class="viewcode-link">[source]</span></a></dt>
1073<dd></dd></dl>
1074
1075<dl class="method">
1076<dt id="sas.guiframe.data_processor.GridPage.insert_col_menu">
1077<tt class="descname">insert_col_menu</tt><big>(</big><em>menu</em>, <em>label</em>, <em>window</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.insert_col_menu"><span class="viewcode-link">[source]</span></a></dt>
1078<dd></dd></dl>
1079
1080<dl class="method">
1081<dt id="sas.guiframe.data_processor.GridPage.insert_column">
1082<tt class="descname">insert_column</tt><big>(</big><em>col</em>, <em>col_name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.insert_column"><span class="viewcode-link">[source]</span></a></dt>
1083<dd></dd></dl>
1084
1085<dl class="method">
1086<dt id="sas.guiframe.data_processor.GridPage.onContextMenu">
1087<tt class="descname">onContextMenu</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.onContextMenu"><span class="viewcode-link">[source]</span></a></dt>
1088<dd><p>Default context menu</p>
1089</dd></dl>
1090
1091<dl class="method">
1092<dt id="sas.guiframe.data_processor.GridPage.on_clear">
1093<tt class="descname">on_clear</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_clear"><span class="viewcode-link">[source]</span></a></dt>
1094<dd><p>Clear the cells selected</p>
1095</dd></dl>
1096
1097<dl class="method">
1098<dt id="sas.guiframe.data_processor.GridPage.on_copy">
1099<tt class="descname">on_copy</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_copy"><span class="viewcode-link">[source]</span></a></dt>
1100<dd><p>On copy event from the contextmenu</p>
1101</dd></dl>
1102
1103<dl class="method">
1104<dt id="sas.guiframe.data_processor.GridPage.on_edit_cell">
1105<tt class="descname">on_edit_cell</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_edit_cell"><span class="viewcode-link">[source]</span></a></dt>
1106<dd></dd></dl>
1107
1108<dl class="method">
1109<dt id="sas.guiframe.data_processor.GridPage.on_insert_after_column">
1110<tt class="descname">on_insert_after_column</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_insert_after_column"><span class="viewcode-link">[source]</span></a></dt>
1111<dd><p>Insert the given column after the highlighted column</p>
1112</dd></dl>
1113
1114<dl class="method">
1115<dt id="sas.guiframe.data_processor.GridPage.on_insert_column">
1116<tt class="descname">on_insert_column</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_insert_column"><span class="viewcode-link">[source]</span></a></dt>
1117<dd></dd></dl>
1118
1119<dl class="method">
1120<dt id="sas.guiframe.data_processor.GridPage.on_left_click">
1121<tt class="descname">on_left_click</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_left_click"><span class="viewcode-link">[source]</span></a></dt>
1122<dd><p>Catch the left click on label mouse event</p>
1123</dd></dl>
1124
1125<dl class="method">
1126<dt id="sas.guiframe.data_processor.GridPage.on_paste">
1127<tt class="descname">on_paste</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_paste"><span class="viewcode-link">[source]</span></a></dt>
1128<dd><p>On paste event from the contextmenu</p>
1129</dd></dl>
1130
1131<dl class="method">
1132<dt id="sas.guiframe.data_processor.GridPage.on_remove_column">
1133<tt class="descname">on_remove_column</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_remove_column"><span class="viewcode-link">[source]</span></a></dt>
1134<dd></dd></dl>
1135
1136<dl class="method">
1137<dt id="sas.guiframe.data_processor.GridPage.on_right_click">
1138<tt class="descname">on_right_click</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_right_click"><span class="viewcode-link">[source]</span></a></dt>
1139<dd><p>Catch the right click mouse</p>
1140</dd></dl>
1141
1142<dl class="method">
1143<dt id="sas.guiframe.data_processor.GridPage.on_selected_cell">
1144<tt class="descname">on_selected_cell</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_selected_cell"><span class="viewcode-link">[source]</span></a></dt>
1145<dd><p>Handler catching cell selection</p>
1146</dd></dl>
1147
1148<dl class="method">
1149<dt id="sas.guiframe.data_processor.GridPage.on_set_x_axis">
1150<tt class="descname">on_set_x_axis</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_set_x_axis"><span class="viewcode-link">[source]</span></a></dt>
1151<dd></dd></dl>
1152
1153<dl class="method">
1154<dt id="sas.guiframe.data_processor.GridPage.on_set_y_axis">
1155<tt class="descname">on_set_y_axis</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.on_set_y_axis"><span class="viewcode-link">[source]</span></a></dt>
1156<dd></dd></dl>
1157
1158<dl class="method">
1159<dt id="sas.guiframe.data_processor.GridPage.remove_column">
1160<tt class="descname">remove_column</tt><big>(</big><em>col</em>, <em>numCols=1</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.remove_column"><span class="viewcode-link">[source]</span></a></dt>
1161<dd><p>Remove column to the current grid</p>
1162</dd></dl>
1163
1164<dl class="method">
1165<dt id="sas.guiframe.data_processor.GridPage.set_data">
1166<tt class="descname">set_data</tt><big>(</big><em>data_inputs</em>, <em>data_outputs</em>, <em>details</em>, <em>file_name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.set_data"><span class="viewcode-link">[source]</span></a></dt>
1167<dd><p>Add data to the grid
1168:param data_inputs: data to use from the context menu of the grid
1169:param data_ouputs: default columns deplayed</p>
1170</dd></dl>
1171
1172<dl class="method">
1173<dt id="sas.guiframe.data_processor.GridPage.set_grid_values">
1174<tt class="descname">set_grid_values</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPage.set_grid_values"><span class="viewcode-link">[source]</span></a></dt>
1175<dd><p>Set the values in grids</p>
1176</dd></dl>
1177
1178</dd></dl>
1179
1180<dl class="class">
1181<dt id="sas.guiframe.data_processor.GridPanel">
1182<em class="property">class </em><tt class="descclassname">sas.guiframe.data_processor.</tt><tt class="descname">GridPanel</tt><big>(</big><em>parent</em>, <em>data_inputs=None</em>, <em>data_outputs=None</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel"><span class="viewcode-link">[source]</span></a></dt>
1183<dd><p>Bases: <a class="reference internal" href="#sas.guiframe.data_processor.SPanel" title="sas.guiframe.data_processor.SPanel"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.data_processor.SPanel</span></tt></a></p>
1184<dl class="method">
1185<dt id="sas.guiframe.data_processor.GridPanel.add_column">
1186<tt class="descname">add_column</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.add_column"><span class="viewcode-link">[source]</span></a></dt>
1187<dd></dd></dl>
1188
1189<dl class="method">
1190<dt id="sas.guiframe.data_processor.GridPanel.create_axis_label">
1191<tt class="descname">create_axis_label</tt><big>(</big><em>cell_list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.create_axis_label"><span class="viewcode-link">[source]</span></a></dt>
1192<dd><p>Receive a list of cells and  create a string presenting the selected
1193cells.
1194:param cell_list: list of tuple</p>
1195</dd></dl>
1196
1197<dl class="method">
1198<dt id="sas.guiframe.data_processor.GridPanel.edit_axis_helper">
1199<tt class="descname">edit_axis_helper</tt><big>(</big><em>tcrtl_label</em>, <em>tcrtl_title</em>, <em>label</em>, <em>title</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.edit_axis_helper"><span class="viewcode-link">[source]</span></a></dt>
1200<dd><p>get controls to modify</p>
1201</dd></dl>
1202
1203<dl class="method">
1204<dt id="sas.guiframe.data_processor.GridPanel.get_plot_axis">
1205<tt class="descname">get_plot_axis</tt><big>(</big><em>col</em>, <em>list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.get_plot_axis"><span class="viewcode-link">[source]</span></a></dt>
1206<dd></dd></dl>
1207
1208<dl class="method">
1209<dt id="sas.guiframe.data_processor.GridPanel.get_sentence">
1210<tt class="descname">get_sentence</tt><big>(</big><em>dict</em>, <em>sentence</em>, <em>column_names</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.get_sentence"><span class="viewcode-link">[source]</span></a></dt>
1211<dd><p>Get sentence from dict</p>
1212</dd></dl>
1213
1214<dl class="method">
1215<dt id="sas.guiframe.data_processor.GridPanel.layout_grid">
1216<tt class="descname">layout_grid</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.layout_grid"><span class="viewcode-link">[source]</span></a></dt>
1217<dd><p>Draw the area related to the grid</p>
1218</dd></dl>
1219
1220<dl class="method">
1221<dt id="sas.guiframe.data_processor.GridPanel.layout_plotting_area">
1222<tt class="descname">layout_plotting_area</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.layout_plotting_area"><span class="viewcode-link">[source]</span></a></dt>
1223<dd><p>Draw area containing options to plot</p>
1224</dd></dl>
1225
1226<dl class="method">
1227<dt id="sas.guiframe.data_processor.GridPanel.on_edit_axis">
1228<tt class="descname">on_edit_axis</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.on_edit_axis"><span class="viewcode-link">[source]</span></a></dt>
1229<dd><p>Get the selected column on  the visible grid and set values for axis</p>
1230</dd></dl>
1231
1232<dl class="method">
1233<dt id="sas.guiframe.data_processor.GridPanel.on_plot">
1234<tt class="descname">on_plot</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.on_plot"><span class="viewcode-link">[source]</span></a></dt>
1235<dd><p>Evaluate the contains of textcrtl and plot result</p>
1236</dd></dl>
1237
1238<dl class="method">
1239<dt id="sas.guiframe.data_processor.GridPanel.on_remove_column">
1240<tt class="descname">on_remove_column</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.on_remove_column"><span class="viewcode-link">[source]</span></a></dt>
1241<dd></dd></dl>
1242
1243<dl class="method">
1244<dt id="sas.guiframe.data_processor.GridPanel.on_view">
1245<tt class="descname">on_view</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.on_view"><span class="viewcode-link">[source]</span></a></dt>
1246<dd><p>Get object represented buy the given cell and plot them.</p>
1247</dd></dl>
1248
1249<dl class="method">
1250<dt id="sas.guiframe.data_processor.GridPanel.set_dyaxis">
1251<tt class="descname">set_dyaxis</tt><big>(</big><em>label=''</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.set_dyaxis"><span class="viewcode-link">[source]</span></a></dt>
1252<dd></dd></dl>
1253
1254<dl class="method">
1255<dt id="sas.guiframe.data_processor.GridPanel.set_xaxis">
1256<tt class="descname">set_xaxis</tt><big>(</big><em>label=''</em>, <em>x=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.set_xaxis"><span class="viewcode-link">[source]</span></a></dt>
1257<dd></dd></dl>
1258
1259<dl class="method">
1260<dt id="sas.guiframe.data_processor.GridPanel.set_yaxis">
1261<tt class="descname">set_yaxis</tt><big>(</big><em>label=''</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#GridPanel.set_yaxis"><span class="viewcode-link">[source]</span></a></dt>
1262<dd></dd></dl>
1263
1264</dd></dl>
1265
1266<dl class="class">
1267<dt id="sas.guiframe.data_processor.Notebook">
1268<em class="property">class </em><tt class="descclassname">sas.guiframe.data_processor.</tt><tt class="descname">Notebook</tt><big>(</big><em>parent</em>, <em>manager=None</em>, <em>data=None</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook"><span class="viewcode-link">[source]</span></a></dt>
1269<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.aui.AuiNotebook</span></tt>, <a class="reference internal" href="#sas.guiframe.panel_base.PanelBase" title="sas.guiframe.panel_base.PanelBase"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.panel_base.PanelBase</span></tt></a></p>
1270<p>## Internal name for the AUI manager
1271window_name = &#8220;Fit panel&#8221;
1272## Title to appear on top of the window</p>
1273<dl class="method">
1274<dt id="sas.guiframe.data_processor.Notebook.add_column">
1275<tt class="descname">add_column</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.add_column"><span class="viewcode-link">[source]</span></a></dt>
1276<dd><p>Append a new column to the grid</p>
1277</dd></dl>
1278
1279<dl class="method">
1280<dt id="sas.guiframe.data_processor.Notebook.add_empty_page">
1281<tt class="descname">add_empty_page</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.add_empty_page"><span class="viewcode-link">[source]</span></a></dt>
1282<dd></dd></dl>
1283
1284<dl class="method">
1285<dt id="sas.guiframe.data_processor.Notebook.create_axis_label">
1286<tt class="descname">create_axis_label</tt><big>(</big><em>cell_list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.create_axis_label"><span class="viewcode-link">[source]</span></a></dt>
1287<dd><p>Receive a list of cells and  create a string presenting the selected
1288cells.
1289:param cell_list: list of tuple</p>
1290</dd></dl>
1291
1292<dl class="method">
1293<dt id="sas.guiframe.data_processor.Notebook.enable_close_button">
1294<tt class="descname">enable_close_button</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.enable_close_button"><span class="viewcode-link">[source]</span></a></dt>
1295<dd><p>display the close button on tab for more than 1 tabs else remove the
1296close button</p>
1297</dd></dl>
1298
1299<dl class="method">
1300<dt id="sas.guiframe.data_processor.Notebook.get_column_labels">
1301<tt class="descname">get_column_labels</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.get_column_labels"><span class="viewcode-link">[source]</span></a></dt>
1302<dd><p>return dictionary of columns labels of the current page</p>
1303</dd></dl>
1304
1305<dl class="method">
1306<dt id="sas.guiframe.data_processor.Notebook.get_highlighted_row">
1307<tt class="descname">get_highlighted_row</tt><big>(</big><em>is_number=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.get_highlighted_row"><span class="viewcode-link">[source]</span></a></dt>
1308<dd><p>Add highlight rows</p>
1309</dd></dl>
1310
1311<dl class="method">
1312<dt id="sas.guiframe.data_processor.Notebook.get_odered_results">
1313<tt class="descname">get_odered_results</tt><big>(</big><em>inputs</em>, <em>outputs=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.get_odered_results"><span class="viewcode-link">[source]</span></a></dt>
1314<dd><p>Get ordered the results</p>
1315</dd></dl>
1316
1317<dl class="method">
1318<dt id="sas.guiframe.data_processor.Notebook.on_close_page">
1319<tt class="descname">on_close_page</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.on_close_page"><span class="viewcode-link">[source]</span></a></dt>
1320<dd><p>close the page</p>
1321</dd></dl>
1322
1323<dl class="method">
1324<dt id="sas.guiframe.data_processor.Notebook.on_edit_axis">
1325<tt class="descname">on_edit_axis</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.on_edit_axis"><span class="viewcode-link">[source]</span></a></dt>
1326<dd><p>Return the select cell of a given selected column. Check that all cells
1327are from the same column</p>
1328</dd></dl>
1329
1330<dl class="method">
1331<dt id="sas.guiframe.data_processor.Notebook.on_remove_column">
1332<tt class="descname">on_remove_column</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.on_remove_column"><span class="viewcode-link">[source]</span></a></dt>
1333<dd><p>Remove the selected column from the grid</p>
1334</dd></dl>
1335
1336<dl class="method">
1337<dt id="sas.guiframe.data_processor.Notebook.set_data">
1338<tt class="descname">set_data</tt><big>(</big><em>data_inputs</em>, <em>data_outputs</em>, <em>details=''</em>, <em>file_name=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#Notebook.set_data"><span class="viewcode-link">[source]</span></a></dt>
1339<dd></dd></dl>
1340
1341<dl class="attribute">
1342<dt id="sas.guiframe.data_processor.Notebook.window_caption">
1343<tt class="descname">window_caption</tt><em class="property"> = 'Notebook '</em></dt>
1344<dd></dd></dl>
1345
1346</dd></dl>
1347
1348<dl class="class">
1349<dt id="sas.guiframe.data_processor.SPanel">
1350<em class="property">class </em><tt class="descclassname">sas.guiframe.data_processor.</tt><tt class="descname">SPanel</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#SPanel"><span class="viewcode-link">[source]</span></a></dt>
1351<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.scrolledpanel.ScrolledPanel</span></tt></p>
1352</dd></dl>
1353
1354<dl class="function">
1355<dt id="sas.guiframe.data_processor.parse_string">
1356<tt class="descclassname">sas.guiframe.data_processor.</tt><tt class="descname">parse_string</tt><big>(</big><em>sentence</em>, <em>list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_processor.html#parse_string"><span class="viewcode-link">[source]</span></a></dt>
1357<dd><p>Return a dictionary of column label and index or row selected
1358:param sentence: String to parse
1359:param list: list of columns label</p>
1360</dd></dl>
1361
1362</div>
1363<div class="section" id="module-sas.guiframe.data_state">
1364<span id="sas-guiframe-data-state-module"></span><h2>sas.guiframe.data_state module</h2>
1365<dl class="class">
1366<dt id="sas.guiframe.data_state.DataState">
1367<em class="property">class </em><tt class="descclassname">sas.guiframe.data_state.</tt><tt class="descname">DataState</tt><big>(</big><em>data=None</em>, <em>parent=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState"><span class="viewcode-link">[source]</span></a></dt>
1368<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1369<p>Store information about data</p>
1370<dl class="method">
1371<dt id="sas.guiframe.data_state.DataState.clone">
1372<tt class="descname">clone</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.clone"><span class="viewcode-link">[source]</span></a></dt>
1373<dd></dd></dl>
1374
1375<dl class="method">
1376<dt id="sas.guiframe.data_state.DataState.get_data">
1377<tt class="descname">get_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.get_data"><span class="viewcode-link">[source]</span></a></dt>
1378<dd></dd></dl>
1379
1380<dl class="method">
1381<dt id="sas.guiframe.data_state.DataState.get_message">
1382<tt class="descname">get_message</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.get_message"><span class="viewcode-link">[source]</span></a></dt>
1383<dd><p>return message</p>
1384</dd></dl>
1385
1386<dl class="method">
1387<dt id="sas.guiframe.data_state.DataState.get_name">
1388<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.get_name"><span class="viewcode-link">[source]</span></a></dt>
1389<dd></dd></dl>
1390
1391<dl class="method">
1392<dt id="sas.guiframe.data_state.DataState.get_path">
1393<tt class="descname">get_path</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.get_path"><span class="viewcode-link">[source]</span></a></dt>
1394<dd><p>return the path of the loaded data</p>
1395</dd></dl>
1396
1397<dl class="method">
1398<dt id="sas.guiframe.data_state.DataState.get_theory">
1399<tt class="descname">get_theory</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.get_theory"><span class="viewcode-link">[source]</span></a></dt>
1400<dd></dd></dl>
1401
1402<dl class="method">
1403<dt id="sas.guiframe.data_state.DataState.set_data">
1404<tt class="descname">set_data</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.set_data"><span class="viewcode-link">[source]</span></a></dt>
1405<dd></dd></dl>
1406
1407<dl class="method">
1408<dt id="sas.guiframe.data_state.DataState.set_name">
1409<tt class="descname">set_name</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.set_name"><span class="viewcode-link">[source]</span></a></dt>
1410<dd></dd></dl>
1411
1412<dl class="method">
1413<dt id="sas.guiframe.data_state.DataState.set_path">
1414<tt class="descname">set_path</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.set_path"><span class="viewcode-link">[source]</span></a></dt>
1415<dd><p>Set the path of the loaded data</p>
1416</dd></dl>
1417
1418<dl class="method">
1419<dt id="sas.guiframe.data_state.DataState.set_theory">
1420<tt class="descname">set_theory</tt><big>(</big><em>theory_data</em>, <em>theory_state=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/data_state.html#DataState.set_theory"><span class="viewcode-link">[source]</span></a></dt>
1421<dd></dd></dl>
1422
1423</dd></dl>
1424
1425</div>
1426<div class="section" id="module-sas.guiframe.documentation_window">
1427<span id="sas-guiframe-documentation-window-module"></span><h2>sas.guiframe.documentation_window module</h2>
1428<dl class="class">
1429<dt id="sas.guiframe.documentation_window.DocumentationWindow">
1430<em class="property">class </em><tt class="descclassname">sas.guiframe.documentation_window.</tt><tt class="descname">DocumentationWindow</tt><big>(</big><em>parent</em>, <em>id</em>, <em>path</em>, <em>title='Help'</em>, <em>size=(850</em>, <em>540)</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/documentation_window.html#DocumentationWindow"><span class="viewcode-link">[source]</span></a></dt>
1431<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
1432</dd></dl>
1433
1434</div>
1435<div class="section" id="module-sas.guiframe.dummyapp">
1436<span id="sas-guiframe-dummyapp-module"></span><h2>sas.guiframe.dummyapp module</h2>
1437<p>Dummy application.
1438Allows the user to set an external data manager</p>
1439<dl class="class">
1440<dt id="sas.guiframe.dummyapp.DummyView">
1441<em class="property">class </em><tt class="descclassname">sas.guiframe.dummyapp.</tt><tt class="descname">DummyView</tt><big>(</big><em>redirect=False</em>, <em>filename=None</em>, <em>useBestVisual=False</em>, <em>clearSigInt=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dummyapp.html#DummyView"><span class="viewcode-link">[source]</span></a></dt>
1442<dd><p>Bases: <a class="reference internal" href="#sas.guiframe.gui_manager.ViewApp" title="sas.guiframe.gui_manager.ViewApp"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.gui_manager.ViewApp</span></tt></a></p>
1443</dd></dl>
1444
1445<dl class="class">
1446<dt id="sas.guiframe.dummyapp.SasView">
1447<em class="property">class </em><tt class="descclassname">sas.guiframe.dummyapp.</tt><tt class="descname">SasView</tt><a class="reference internal" href="../../_modules/sas/guiframe/dummyapp.html#SasView"><span class="viewcode-link">[source]</span></a></dt>
1448<dd></dd></dl>
1449
1450<dl class="class">
1451<dt id="sas.guiframe.dummyapp.TestPlugin">
1452<em class="property">class </em><tt class="descclassname">sas.guiframe.dummyapp.</tt><tt class="descname">TestPlugin</tt><big>(</big><em>name='Test_plugin'</em>, <em>standalone=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dummyapp.html#TestPlugin"><span class="viewcode-link">[source]</span></a></dt>
1453<dd><p>Bases: <a class="reference internal" href="#sas.guiframe.plugin_base.PluginBase" title="sas.guiframe.plugin_base.PluginBase"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.plugin_base.PluginBase</span></tt></a></p>
1454<dl class="method">
1455<dt id="sas.guiframe.dummyapp.TestPlugin.get_context_menu">
1456<tt class="descname">get_context_menu</tt><big>(</big><em>graph=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dummyapp.html#TestPlugin.get_context_menu"><span class="viewcode-link">[source]</span></a></dt>
1457<dd><p>This method is optional.</p>
1458<p>When the context menu of a plot is rendered, the
1459get_context_menu method will be called to give you a
1460chance to add a menu item to the context menu.</p>
1461<p>A ref to a Graph object is passed so that you can
1462investigate the plot content and decide whether you
1463need to add items to the context menu.</p>
1464<p>This method returns a list of menu items.
1465Each item is itself a list defining the text to
1466appear in the menu, a tool-tip help text, and a
1467call-back method.</p>
1468<table class="docutils field-list" frame="void" rules="none">
1469<col class="field-name" />
1470<col class="field-body" />
1471<tbody valign="top">
1472<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>graph</strong> &#8211; the Graph object to which we attach the context menu</td>
1473</tr>
1474<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of menu items with call-back function</td>
1475</tr>
1476</tbody>
1477</table>
1478</dd></dl>
1479
1480<dl class="method">
1481<dt id="sas.guiframe.dummyapp.TestPlugin.get_panels">
1482<tt class="descname">get_panels</tt><big>(</big><em>parent</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dummyapp.html#TestPlugin.get_panels"><span class="viewcode-link">[source]</span></a></dt>
1483<dd><p>Create and return the list of wx.Panels for your plug-in.
1484Define the plug-in perspective.</p>
1485<p>Panels should inherit from DefaultPanel defined below,
1486or should present the same interface. They must define
1487&#8220;window_caption&#8221; and &#8220;window_name&#8221;.</p>
1488<table class="docutils field-list" frame="void" rules="none">
1489<col class="field-name" />
1490<col class="field-body" />
1491<tbody valign="top">
1492<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> &#8211; parent window</td>
1493</tr>
1494<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of panels</td>
1495</tr>
1496</tbody>
1497</table>
1498</dd></dl>
1499
1500<dl class="method">
1501<dt id="sas.guiframe.dummyapp.TestPlugin.get_tools">
1502<tt class="descname">get_tools</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dummyapp.html#TestPlugin.get_tools"><span class="viewcode-link">[source]</span></a></dt>
1503<dd><p>Returns a set of menu entries for tools</p>
1504</dd></dl>
1505
1506<dl class="method">
1507<dt id="sas.guiframe.dummyapp.TestPlugin.populate_menu">
1508<tt class="descname">populate_menu</tt><big>(</big><em>parent</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/dummyapp.html#TestPlugin.populate_menu"><span class="viewcode-link">[source]</span></a></dt>
1509<dd><p>Create and return the list of application menu
1510items for the plug-in.
1511:param parent: parent window</p>
1512<table class="docutils field-list" frame="void" rules="none">
1513<col class="field-name" />
1514<col class="field-body" />
1515<tbody valign="top">
1516<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">plug-in menu</td>
1517</tr>
1518</tbody>
1519</table>
1520</dd></dl>
1521
1522</dd></dl>
1523
1524</div>
1525<div class="section" id="module-sas.guiframe.events">
1526<span id="sas-guiframe-events-module"></span><h2>sas.guiframe.events module</h2>
1527</div>
1528<div class="section" id="module-sas.guiframe.gui_manager">
1529<span id="sas-guiframe-gui-manager-module"></span><h2>sas.guiframe.gui_manager module</h2>
1530<p>Gui manager: manages the widgets making up an application</p>
1531<dl class="class">
1532<dt id="sas.guiframe.gui_manager.DefaultPanel">
1533<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_manager.</tt><tt class="descname">DefaultPanel</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#DefaultPanel"><span class="viewcode-link">[source]</span></a></dt>
1534<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Panel</span></tt>, <a class="reference internal" href="#sas.guiframe.panel_base.PanelBase" title="sas.guiframe.panel_base.PanelBase"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.panel_base.PanelBase</span></tt></a></p>
1535<p>Defines the API for a panels to work with
1536the GUI manager</p>
1537<dl class="attribute">
1538<dt id="sas.guiframe.gui_manager.DefaultPanel.CENTER_PANE">
1539<tt class="descname">CENTER_PANE</tt><em class="property"> = True</em></dt>
1540<dd></dd></dl>
1541
1542<dl class="attribute">
1543<dt id="sas.guiframe.gui_manager.DefaultPanel.window_caption">
1544<tt class="descname">window_caption</tt><em class="property"> = 'Welcome panel'</em></dt>
1545<dd></dd></dl>
1546
1547<dl class="attribute">
1548<dt id="sas.guiframe.gui_manager.DefaultPanel.window_name">
1549<tt class="descname">window_name</tt><em class="property"> = 'default'</em></dt>
1550<dd></dd></dl>
1551
1552</dd></dl>
1553
1554<dl class="class">
1555<dt id="sas.guiframe.gui_manager.MDIFrame">
1556<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_manager.</tt><tt class="descname">MDIFrame</tt><big>(</big><em>parent</em>, <em>panel</em>, <em>title='Untitled'</em>, <em>size=(300</em>, <em>200)</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#MDIFrame"><span class="viewcode-link">[source]</span></a></dt>
1557<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.MDIChildFrame</span></tt></p>
1558<p>Frame for panels</p>
1559<dl class="method">
1560<dt id="sas.guiframe.gui_manager.MDIFrame.OnClose">
1561<tt class="descname">OnClose</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#MDIFrame.OnClose"><span class="viewcode-link">[source]</span></a></dt>
1562<dd><p>On Close event</p>
1563</dd></dl>
1564
1565<dl class="method">
1566<dt id="sas.guiframe.gui_manager.MDIFrame.set_panel">
1567<tt class="descname">set_panel</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#MDIFrame.set_panel"><span class="viewcode-link">[source]</span></a></dt>
1568<dd></dd></dl>
1569
1570<dl class="method">
1571<dt id="sas.guiframe.gui_manager.MDIFrame.set_panel_focus">
1572<tt class="descname">set_panel_focus</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#MDIFrame.set_panel_focus"><span class="viewcode-link">[source]</span></a></dt>
1573<dd></dd></dl>
1574
1575<dl class="method">
1576<dt id="sas.guiframe.gui_manager.MDIFrame.show_data_panel">
1577<tt class="descname">show_data_panel</tt><big>(</big><em>action</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#MDIFrame.show_data_panel"><span class="viewcode-link">[source]</span></a></dt>
1578<dd></dd></dl>
1579
1580</dd></dl>
1581
1582<dl class="class">
1583<dt id="sas.guiframe.gui_manager.ViewApp">
1584<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_manager.</tt><tt class="descname">ViewApp</tt><big>(</big><em>redirect=False</em>, <em>filename=None</em>, <em>useBestVisual=False</em>, <em>clearSigInt=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp"><span class="viewcode-link">[source]</span></a></dt>
1585<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.App</span></tt></p>
1586<p>Toy application to test this Frame</p>
1587<dl class="method">
1588<dt id="sas.guiframe.gui_manager.ViewApp.OnInit">
1589<tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.OnInit"><span class="viewcode-link">[source]</span></a></dt>
1590<dd><p>When initialised</p>
1591</dd></dl>
1592
1593<dl class="method">
1594<dt id="sas.guiframe.gui_manager.ViewApp.add_perspective">
1595<tt class="descname">add_perspective</tt><big>(</big><em>perspective</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.add_perspective"><span class="viewcode-link">[source]</span></a></dt>
1596<dd><p>Manually add a perspective to the application GUI</p>
1597</dd></dl>
1598
1599<dl class="method">
1600<dt id="sas.guiframe.gui_manager.ViewApp.build_gui">
1601<tt class="descname">build_gui</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.build_gui"><span class="viewcode-link">[source]</span></a></dt>
1602<dd><p>Build the GUI</p>
1603</dd></dl>
1604
1605<dl class="method">
1606<dt id="sas.guiframe.gui_manager.ViewApp.clean_plugin_models">
1607<tt class="descname">clean_plugin_models</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.clean_plugin_models"><span class="viewcode-link">[source]</span></a></dt>
1608<dd><p>Delete plugin models  in app folder</p>
1609<table class="docutils field-list" frame="void" rules="none">
1610<col class="field-name" />
1611<col class="field-body" />
1612<tbody valign="top">
1613<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; path of the plugin_models folder in app</td>
1614</tr>
1615</tbody>
1616</table>
1617</dd></dl>
1618
1619<dl class="method">
1620<dt id="sas.guiframe.gui_manager.ViewApp.display_splash_screen">
1621<tt class="descname">display_splash_screen</tt><big>(</big><em>parent</em>, <em>path='/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/sasview/images/SVwelcome_mini.png'</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.display_splash_screen"><span class="viewcode-link">[source]</span></a></dt>
1622<dd><p>Displays the splash screen.  It will exactly cover the main frame.</p>
1623</dd></dl>
1624
1625<dl class="method">
1626<dt id="sas.guiframe.gui_manager.ViewApp.maximize_win">
1627<tt class="descname">maximize_win</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.maximize_win"><span class="viewcode-link">[source]</span></a></dt>
1628<dd><p>Maximize the window after the frame shown</p>
1629</dd></dl>
1630
1631<dl class="method">
1632<dt id="sas.guiframe.gui_manager.ViewApp.on_close_splash_screen">
1633<tt class="descname">on_close_splash_screen</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.on_close_splash_screen"><span class="viewcode-link">[source]</span></a></dt>
1634<dd><p>When the splash screen is closed.</p>
1635</dd></dl>
1636
1637<dl class="method">
1638<dt id="sas.guiframe.gui_manager.ViewApp.open_file">
1639<tt class="descname">open_file</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.open_file"><span class="viewcode-link">[source]</span></a></dt>
1640<dd><p>open a state file at the start of the application</p>
1641</dd></dl>
1642
1643<dl class="method">
1644<dt id="sas.guiframe.gui_manager.ViewApp.set_manager">
1645<tt class="descname">set_manager</tt><big>(</big><em>manager</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.set_manager"><span class="viewcode-link">[source]</span></a></dt>
1646<dd><p>Sets a reference to the application manager
1647of the GUI manager (Frame)</p>
1648</dd></dl>
1649
1650<dl class="method">
1651<dt id="sas.guiframe.gui_manager.ViewApp.set_welcome_panel">
1652<tt class="descname">set_welcome_panel</tt><big>(</big><em>panel_class</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.set_welcome_panel"><span class="viewcode-link">[source]</span></a></dt>
1653<dd><p>Set the welcome panel</p>
1654<table class="docutils field-list" frame="void" rules="none">
1655<col class="field-name" />
1656<col class="field-body" />
1657<tbody valign="top">
1658<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>panel_class</strong> &#8211; class of the welcome panel to be instantiated</td>
1659</tr>
1660</tbody>
1661</table>
1662</dd></dl>
1663
1664<dl class="method">
1665<dt id="sas.guiframe.gui_manager.ViewApp.window_placement">
1666<tt class="descname">window_placement</tt><big>(</big><em>size</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewApp.window_placement"><span class="viewcode-link">[source]</span></a></dt>
1667<dd><p>Determines the position and size of the application frame such that it
1668fits on the user&#8217;s screen without obstructing (or being obstructed by)
1669the Windows task bar.  The maximum initial size in pixels is bounded by
1670WIDTH x HEIGHT.  For most monitors, the application
1671will be centered on the screen; for very large monitors it will be
1672placed on the left side of the screen.</p>
1673</dd></dl>
1674
1675</dd></dl>
1676
1677<dl class="class">
1678<dt id="sas.guiframe.gui_manager.ViewerFrame">
1679<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_manager.</tt><tt class="descname">ViewerFrame</tt><big>(</big><em>parent</em>, <em>title</em>, <em>size=(-1</em>, <em>-1)</em>, <em>gui_style=381</em>, <em>style=541072960</em>, <em>pos=wx.Point(-1</em>, <em>-1)</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame"><span class="viewcode-link">[source]</span></a></dt>
1680<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.MDIParentFrame</span></tt></p>
1681<p>Main application frame</p>
1682<dl class="method">
1683<dt id="sas.guiframe.gui_manager.ViewerFrame.Close">
1684<tt class="descname">Close</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.Close"><span class="viewcode-link">[source]</span></a></dt>
1685<dd><p>Quit the application</p>
1686</dd></dl>
1687
1688<dl class="method">
1689<dt id="sas.guiframe.gui_manager.ViewerFrame.PopStatusText">
1690<tt class="descname">PopStatusText</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.PopStatusText"><span class="viewcode-link">[source]</span></a></dt>
1691<dd></dd></dl>
1692
1693<dl class="method">
1694<dt id="sas.guiframe.gui_manager.ViewerFrame.PushStatusText">
1695<tt class="descname">PushStatusText</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.PushStatusText"><span class="viewcode-link">[source]</span></a></dt>
1696<dd><p>FIXME: No message is passed. What is this supposed to do?</p>
1697</dd></dl>
1698
1699<dl class="method">
1700<dt id="sas.guiframe.gui_manager.ViewerFrame.SetStatusText">
1701<tt class="descname">SetStatusText</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.SetStatusText"><span class="viewcode-link">[source]</span></a></dt>
1702<dd></dd></dl>
1703
1704<dl class="method">
1705<dt id="sas.guiframe.gui_manager.ViewerFrame.WindowClose">
1706<tt class="descname">WindowClose</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.WindowClose"><span class="viewcode-link">[source]</span></a></dt>
1707<dd><p>Quit the application from x icon</p>
1708</dd></dl>
1709
1710<dl class="method">
1711<dt id="sas.guiframe.gui_manager.ViewerFrame.add_data">
1712<tt class="descname">add_data</tt><big>(</big><em>data_list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.add_data"><span class="viewcode-link">[source]</span></a></dt>
1713<dd><p>receive a dictionary of data from loader
1714store them its data manager if possible
1715send to data the current active perspective if the data panel
1716is not active.
1717:param data_list: dictionary of data&#8217;s ID and value Data</p>
1718</dd></dl>
1719
1720<dl class="method">
1721<dt id="sas.guiframe.gui_manager.ViewerFrame.add_data_helper">
1722<tt class="descname">add_data_helper</tt><big>(</big><em>data_list</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.add_data_helper"><span class="viewcode-link">[source]</span></a></dt>
1723<dd></dd></dl>
1724
1725<dl class="method">
1726<dt id="sas.guiframe.gui_manager.ViewerFrame.add_icon">
1727<tt class="descname">add_icon</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.add_icon"><span class="viewcode-link">[source]</span></a></dt>
1728<dd><p>get list of child and attempt to add the default icon</p>
1729</dd></dl>
1730
1731<dl class="method">
1732<dt id="sas.guiframe.gui_manager.ViewerFrame.add_perspective">
1733<tt class="descname">add_perspective</tt><big>(</big><em>plugin</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.add_perspective"><span class="viewcode-link">[source]</span></a></dt>
1734<dd><p>Add a perspective if it doesn&#8217;t already
1735exist.</p>
1736</dd></dl>
1737
1738<dl class="method">
1739<dt id="sas.guiframe.gui_manager.ViewerFrame.append_bookmark">
1740<tt class="descname">append_bookmark</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.append_bookmark"><span class="viewcode-link">[source]</span></a></dt>
1741<dd><p>Bookmark available information of the panel on focus</p>
1742</dd></dl>
1743
1744<dl class="method">
1745<dt id="sas.guiframe.gui_manager.ViewerFrame.build_gui">
1746<tt class="descname">build_gui</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.build_gui"><span class="viewcode-link">[source]</span></a></dt>
1747<dd><p>Build the GUI by setting up the toolbar, menu and layout.</p>
1748</dd></dl>
1749
1750<dl class="method">
1751<dt id="sas.guiframe.gui_manager.ViewerFrame.check_multimode">
1752<tt class="descname">check_multimode</tt><big>(</big><em>perspective=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.check_multimode"><span class="viewcode-link">[source]</span></a></dt>
1753<dd><p>Check the perspective have batch mode capablitity</p>
1754</dd></dl>
1755
1756<dl class="method">
1757<dt id="sas.guiframe.gui_manager.ViewerFrame.create_gui_data">
1758<tt class="descname">create_gui_data</tt><big>(</big><em>data</em>, <em>path=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.create_gui_data"><span class="viewcode-link">[source]</span></a></dt>
1759<dd></dd></dl>
1760
1761<dl class="method">
1762<dt id="sas.guiframe.gui_manager.ViewerFrame.delete_data">
1763<tt class="descname">delete_data</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.delete_data"><span class="viewcode-link">[source]</span></a></dt>
1764<dd><p>Delete the data.</p>
1765</dd></dl>
1766
1767<dl class="method">
1768<dt id="sas.guiframe.gui_manager.ViewerFrame.delete_panel">
1769<tt class="descname">delete_panel</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.delete_panel"><span class="viewcode-link">[source]</span></a></dt>
1770<dd><p>delete panel given uid</p>
1771</dd></dl>
1772
1773<dl class="method">
1774<dt id="sas.guiframe.gui_manager.ViewerFrame.disable_app_menu">
1775<tt class="descname">disable_app_menu</tt><big>(</big><em>p_panel=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.disable_app_menu"><span class="viewcode-link">[source]</span></a></dt>
1776<dd><p>Disables all menus in the menubar</p>
1777</dd></dl>
1778
1779<dl class="method">
1780<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_add_data">
1781<tt class="descname">enable_add_data</tt><big>(</big><em>new_plot</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_add_data"><span class="viewcode-link">[source]</span></a></dt>
1782<dd><p>Enable append data on a plot panel</p>
1783</dd></dl>
1784
1785<dl class="method">
1786<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_bookmark">
1787<tt class="descname">enable_bookmark</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_bookmark"><span class="viewcode-link">[source]</span></a></dt>
1788<dd><p>Bookmark</p>
1789</dd></dl>
1790
1791<dl class="method">
1792<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_copy">
1793<tt class="descname">enable_copy</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_copy"><span class="viewcode-link">[source]</span></a></dt>
1794<dd><p>enable copy related control</p>
1795</dd></dl>
1796
1797<dl class="method">
1798<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_drag">
1799<tt class="descname">enable_drag</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_drag"><span class="viewcode-link">[source]</span></a></dt>
1800<dd><p>drag</p>
1801</dd></dl>
1802
1803<dl class="method">
1804<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_edit_menu">
1805<tt class="descname">enable_edit_menu</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_edit_menu"><span class="viewcode-link">[source]</span></a></dt>
1806<dd><p>enable menu item under edit menu depending on the panel on focus</p>
1807</dd></dl>
1808
1809<dl class="method">
1810<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_paste">
1811<tt class="descname">enable_paste</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_paste"><span class="viewcode-link">[source]</span></a></dt>
1812<dd><p>enable paste</p>
1813</dd></dl>
1814
1815<dl class="method">
1816<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_preview">
1817<tt class="descname">enable_preview</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_preview"><span class="viewcode-link">[source]</span></a></dt>
1818<dd><p>preview</p>
1819</dd></dl>
1820
1821<dl class="method">
1822<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_print">
1823<tt class="descname">enable_print</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_print"><span class="viewcode-link">[source]</span></a></dt>
1824<dd><p>print</p>
1825</dd></dl>
1826
1827<dl class="method">
1828<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_redo">
1829<tt class="descname">enable_redo</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_redo"><span class="viewcode-link">[source]</span></a></dt>
1830<dd><p>enable redo</p>
1831</dd></dl>
1832
1833<dl class="method">
1834<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_reset">
1835<tt class="descname">enable_reset</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_reset"><span class="viewcode-link">[source]</span></a></dt>
1836<dd><p>reset the current panel</p>
1837</dd></dl>
1838
1839<dl class="method">
1840<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_save">
1841<tt class="descname">enable_save</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_save"><span class="viewcode-link">[source]</span></a></dt>
1842<dd><p>save</p>
1843</dd></dl>
1844
1845<dl class="method">
1846<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_undo">
1847<tt class="descname">enable_undo</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_undo"><span class="viewcode-link">[source]</span></a></dt>
1848<dd><p>enable undo related control</p>
1849</dd></dl>
1850
1851<dl class="method">
1852<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_zoom">
1853<tt class="descname">enable_zoom</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_zoom"><span class="viewcode-link">[source]</span></a></dt>
1854<dd><p>zoom</p>
1855</dd></dl>
1856
1857<dl class="method">
1858<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_zoom_in">
1859<tt class="descname">enable_zoom_in</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_zoom_in"><span class="viewcode-link">[source]</span></a></dt>
1860<dd><p>zoom in</p>
1861</dd></dl>
1862
1863<dl class="method">
1864<dt id="sas.guiframe.gui_manager.ViewerFrame.enable_zoom_out">
1865<tt class="descname">enable_zoom_out</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.enable_zoom_out"><span class="viewcode-link">[source]</span></a></dt>
1866<dd><p>zoom out</p>
1867</dd></dl>
1868
1869<dl class="method">
1870<dt id="sas.guiframe.gui_manager.ViewerFrame.freeze">
1871<tt class="descname">freeze</tt><big>(</big><em>data_id</em>, <em>theory_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.freeze"><span class="viewcode-link">[source]</span></a></dt>
1872<dd></dd></dl>
1873
1874<dl class="method">
1875<dt id="sas.guiframe.gui_manager.ViewerFrame.full_draw">
1876<tt class="descname">full_draw</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.full_draw"><span class="viewcode-link">[source]</span></a></dt>
1877<dd><p>Draw the panels with axes in the schedule to full dwar list</p>
1878</dd></dl>
1879
1880<dl class="method">
1881<dt id="sas.guiframe.gui_manager.ViewerFrame.get_client_size">
1882<tt class="descname">get_client_size</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_client_size"><span class="viewcode-link">[source]</span></a></dt>
1883<dd><p>return client size tuple</p>
1884</dd></dl>
1885
1886<dl class="method">
1887<dt id="sas.guiframe.gui_manager.ViewerFrame.get_context_menu">
1888<tt class="descname">get_context_menu</tt><big>(</big><em>plotpanel=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_context_menu"><span class="viewcode-link">[source]</span></a></dt>
1889<dd><p>Get the context menu items made available
1890by the different plug-ins.
1891This function is used by the plotting module</p>
1892</dd></dl>
1893
1894<dl class="method">
1895<dt id="sas.guiframe.gui_manager.ViewerFrame.get_current_context_menu">
1896<tt class="descname">get_current_context_menu</tt><big>(</big><em>plotpanel=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_current_context_menu"><span class="viewcode-link">[source]</span></a></dt>
1897<dd><p>Get the context menu items made available
1898by the current plug-in.
1899This function is used by the plotting module</p>
1900</dd></dl>
1901
1902<dl class="method">
1903<dt id="sas.guiframe.gui_manager.ViewerFrame.get_current_perspective">
1904<tt class="descname">get_current_perspective</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_current_perspective"><span class="viewcode-link">[source]</span></a></dt>
1905<dd><p>return the current perspective</p>
1906</dd></dl>
1907
1908<dl class="method">
1909<dt id="sas.guiframe.gui_manager.ViewerFrame.get_data">
1910<tt class="descname">get_data</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_data"><span class="viewcode-link">[source]</span></a></dt>
1911<dd></dd></dl>
1912
1913<dl class="method">
1914<dt id="sas.guiframe.gui_manager.ViewerFrame.get_data_manager">
1915<tt class="descname">get_data_manager</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_data_manager"><span class="viewcode-link">[source]</span></a></dt>
1916<dd><p>return the data manager.</p>
1917</dd></dl>
1918
1919<dl class="method">
1920<dt id="sas.guiframe.gui_manager.ViewerFrame.get_paneinfo">
1921<tt class="descname">get_paneinfo</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_paneinfo"><span class="viewcode-link">[source]</span></a></dt>
1922<dd><p>Get pane Caption from window_name</p>
1923<table class="docutils field-list" frame="void" rules="none">
1924<col class="field-name" />
1925<col class="field-body" />
1926<tbody valign="top">
1927<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; window_name in AuiPaneInfo</td>
1928</tr>
1929</tbody>
1930</table>
1931<p>: return: AuiPaneInfo of the name</p>
1932</dd></dl>
1933
1934<dl class="method">
1935<dt id="sas.guiframe.gui_manager.ViewerFrame.get_save_location">
1936<tt class="descname">get_save_location</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_save_location"><span class="viewcode-link">[source]</span></a></dt>
1937<dd><p>return the _default_save_location</p>
1938</dd></dl>
1939
1940<dl class="method">
1941<dt id="sas.guiframe.gui_manager.ViewerFrame.get_schedule">
1942<tt class="descname">get_schedule</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_schedule"><span class="viewcode-link">[source]</span></a></dt>
1943<dd><p>Get schedule</p>
1944</dd></dl>
1945
1946<dl class="method">
1947<dt id="sas.guiframe.gui_manager.ViewerFrame.get_style">
1948<tt class="descname">get_style</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_style"><span class="viewcode-link">[source]</span></a></dt>
1949<dd><p>Return the gui style</p>
1950</dd></dl>
1951
1952<dl class="method">
1953<dt id="sas.guiframe.gui_manager.ViewerFrame.get_toolbar">
1954<tt class="descname">get_toolbar</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_toolbar"><span class="viewcode-link">[source]</span></a></dt>
1955<dd><p>return the toolbar.</p>
1956</dd></dl>
1957
1958<dl class="method">
1959<dt id="sas.guiframe.gui_manager.ViewerFrame.get_toolbar_height">
1960<tt class="descname">get_toolbar_height</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_toolbar_height"><span class="viewcode-link">[source]</span></a></dt>
1961<dd></dd></dl>
1962
1963<dl class="method">
1964<dt id="sas.guiframe.gui_manager.ViewerFrame.get_window_size">
1965<tt class="descname">get_window_size</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.get_window_size"><span class="viewcode-link">[source]</span></a></dt>
1966<dd><p>Get window size</p>
1967<table class="docutils field-list" frame="void" rules="none">
1968<col class="field-name" />
1969<col class="field-body" />
1970<tbody valign="top">
1971<tr class="field-odd field"><th class="field-name">Return size:</th><td class="field-body">tuple</td>
1972</tr>
1973</tbody>
1974</table>
1975</dd></dl>
1976
1977<dl class="method">
1978<dt id="sas.guiframe.gui_manager.ViewerFrame.load_data">
1979<tt class="descname">load_data</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.load_data"><span class="viewcode-link">[source]</span></a></dt>
1980<dd><p>load data from command line</p>
1981</dd></dl>
1982
1983<dl class="method">
1984<dt id="sas.guiframe.gui_manager.ViewerFrame.load_folder">
1985<tt class="descname">load_folder</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.load_folder"><span class="viewcode-link">[source]</span></a></dt>
1986<dd><p>Load entire folder</p>
1987</dd></dl>
1988
1989<dl class="method">
1990<dt id="sas.guiframe.gui_manager.ViewerFrame.load_from_cmd">
1991<tt class="descname">load_from_cmd</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.load_from_cmd"><span class="viewcode-link">[source]</span></a></dt>
1992<dd><p>load data from cmd or application</p>
1993</dd></dl>
1994
1995<dl class="method">
1996<dt id="sas.guiframe.gui_manager.ViewerFrame.load_state">
1997<tt class="descname">load_state</tt><big>(</big><em>path</em>, <em>is_project=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.load_state"><span class="viewcode-link">[source]</span></a></dt>
1998<dd><p>load data from command line or application</p>
1999</dd></dl>
2000
2001<dl class="method">
2002<dt id="sas.guiframe.gui_manager.ViewerFrame.on_batch_selection">
2003<tt class="descname">on_batch_selection</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_batch_selection"><span class="viewcode-link">[source]</span></a></dt>
2004<dd><table class="docutils field-list" frame="void" rules="none">
2005<col class="field-name" />
2006<col class="field-body" />
2007<tbody valign="top">
2008<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; contains parameter enable . when enable is set to True</td>
2009</tr>
2010</tbody>
2011</table>
2012<p>the application is in Batch mode
2013else the application is default mode(single mode)</p>
2014</dd></dl>
2015
2016<dl class="method">
2017<dt id="sas.guiframe.gui_manager.ViewerFrame.on_bookmark_panel">
2018<tt class="descname">on_bookmark_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_bookmark_panel"><span class="viewcode-link">[source]</span></a></dt>
2019<dd><p>bookmark panel</p>
2020</dd></dl>
2021
2022<dl class="method">
2023<dt id="sas.guiframe.gui_manager.ViewerFrame.on_category_panel">
2024<tt class="descname">on_category_panel</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_category_panel"><span class="viewcode-link">[source]</span></a></dt>
2025<dd><p>On cat panel</p>
2026</dd></dl>
2027
2028<dl class="method">
2029<dt id="sas.guiframe.gui_manager.ViewerFrame.on_change_caption">
2030<tt class="descname">on_change_caption</tt><big>(</big><em>name</em>, <em>old_caption</em>, <em>new_caption</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_change_caption"><span class="viewcode-link">[source]</span></a></dt>
2031<dd><p>Change the panel caption</p>
2032<table class="docutils field-list" frame="void" rules="none">
2033<col class="field-name" />
2034<col class="field-body" />
2035<tbody valign="top">
2036<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2037<li><strong>name</strong> &#8211; window_name of the pane</li>
2038<li><strong>old_caption</strong> &#8211; current caption [string]</li>
2039<li><strong>new_caption</strong> &#8211; new caption [string]</li>
2040</ul>
2041</td>
2042</tr>
2043</tbody>
2044</table>
2045</dd></dl>
2046
2047<dl class="method">
2048<dt id="sas.guiframe.gui_manager.ViewerFrame.on_change_categories">
2049<tt class="descname">on_change_categories</tt><big>(</big><em>evt</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_change_categories"><span class="viewcode-link">[source]</span></a></dt>
2050<dd></dd></dl>
2051
2052<dl class="method">
2053<dt id="sas.guiframe.gui_manager.ViewerFrame.on_close_welcome_panel">
2054<tt class="descname">on_close_welcome_panel</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_close_welcome_panel"><span class="viewcode-link">[source]</span></a></dt>
2055<dd><p>Close the welcome panel</p>
2056</dd></dl>
2057
2058<dl class="method">
2059<dt id="sas.guiframe.gui_manager.ViewerFrame.on_color_selection">
2060<tt class="descname">on_color_selection</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_color_selection"><span class="viewcode-link">[source]</span></a></dt>
2061<dd><table class="docutils field-list" frame="void" rules="none">
2062<col class="field-name" />
2063<col class="field-body" />
2064<tbody valign="top">
2065<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; contains parameters for id and color</td>
2066</tr>
2067</tbody>
2068</table>
2069</dd></dl>
2070
2071<dl class="method">
2072<dt id="sas.guiframe.gui_manager.ViewerFrame.on_copy_panel">
2073<tt class="descname">on_copy_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_copy_panel"><span class="viewcode-link">[source]</span></a></dt>
2074<dd><p>copy the last panel on focus if possible</p>
2075</dd></dl>
2076
2077<dl class="method">
2078<dt id="sas.guiframe.gui_manager.ViewerFrame.on_drag_panel">
2079<tt class="descname">on_drag_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_drag_panel"><span class="viewcode-link">[source]</span></a></dt>
2080<dd><p>drag apply to the panel on focus</p>
2081</dd></dl>
2082
2083<dl class="method">
2084<dt id="sas.guiframe.gui_manager.ViewerFrame.on_load_data">
2085<tt class="descname">on_load_data</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_load_data"><span class="viewcode-link">[source]</span></a></dt>
2086<dd><p>received an event to trigger load from data plugin</p>
2087</dd></dl>
2088
2089<dl class="method">
2090<dt id="sas.guiframe.gui_manager.ViewerFrame.on_panel_close">
2091<tt class="descname">on_panel_close</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_panel_close"><span class="viewcode-link">[source]</span></a></dt>
2092<dd><p>Gets called when the close event for a panel runs.
2093This will check which panel has been closed and
2094delete it.</p>
2095</dd></dl>
2096
2097<dl class="method">
2098<dt id="sas.guiframe.gui_manager.ViewerFrame.on_paste_panel">
2099<tt class="descname">on_paste_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_paste_panel"><span class="viewcode-link">[source]</span></a></dt>
2100<dd><p>paste clipboard to the last panel on focus</p>
2101</dd></dl>
2102
2103<dl class="method">
2104<dt id="sas.guiframe.gui_manager.ViewerFrame.on_preview_panel">
2105<tt class="descname">on_preview_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_preview_panel"><span class="viewcode-link">[source]</span></a></dt>
2106<dd><p>preview information on the panel on focus</p>
2107</dd></dl>
2108
2109<dl class="method">
2110<dt id="sas.guiframe.gui_manager.ViewerFrame.on_print_panel">
2111<tt class="descname">on_print_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_print_panel"><span class="viewcode-link">[source]</span></a></dt>
2112<dd><p>print available information on the last panel on focus</p>
2113</dd></dl>
2114
2115<dl class="method">
2116<dt id="sas.guiframe.gui_manager.ViewerFrame.on_read_batch_tofile">
2117<tt class="descname">on_read_batch_tofile</tt><big>(</big><em>base</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_read_batch_tofile"><span class="viewcode-link">[source]</span></a></dt>
2118<dd><p>Open a file dialog , extract the file to read and display values
2119into a grid</p>
2120</dd></dl>
2121
2122<dl class="method">
2123<dt id="sas.guiframe.gui_manager.ViewerFrame.on_redo_panel">
2124<tt class="descname">on_redo_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_redo_panel"><span class="viewcode-link">[source]</span></a></dt>
2125<dd><p>redo the last cancel action done on the last panel on focus</p>
2126</dd></dl>
2127
2128<dl class="method">
2129<dt id="sas.guiframe.gui_manager.ViewerFrame.on_reset_panel">
2130<tt class="descname">on_reset_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_reset_panel"><span class="viewcode-link">[source]</span></a></dt>
2131<dd><p>reset the current panel</p>
2132</dd></dl>
2133
2134<dl class="method">
2135<dt id="sas.guiframe.gui_manager.ViewerFrame.on_save_helper">
2136<tt class="descname">on_save_helper</tt><big>(</big><em>doc</em>, <em>reader</em>, <em>panel</em>, <em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_save_helper"><span class="viewcode-link">[source]</span></a></dt>
2137<dd><p>Save state into a file</p>
2138</dd></dl>
2139
2140<dl class="method">
2141<dt id="sas.guiframe.gui_manager.ViewerFrame.on_save_panel">
2142<tt class="descname">on_save_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_save_panel"><span class="viewcode-link">[source]</span></a></dt>
2143<dd><p>save possible information on the current panel</p>
2144</dd></dl>
2145
2146<dl class="method">
2147<dt id="sas.guiframe.gui_manager.ViewerFrame.on_set_batch_result">
2148<tt class="descname">on_set_batch_result</tt><big>(</big><em>data_outputs</em>, <em>data_inputs=None</em>, <em>plugin_name=''</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_set_batch_result"><span class="viewcode-link">[source]</span></a></dt>
2149<dd><p>Display data into a grid in batch mode and show the grid</p>
2150</dd></dl>
2151
2152<dl class="method">
2153<dt id="sas.guiframe.gui_manager.ViewerFrame.on_set_plot_focus">
2154<tt class="descname">on_set_plot_focus</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_set_plot_focus"><span class="viewcode-link">[source]</span></a></dt>
2155<dd><p>Set focus on a plot panel</p>
2156</dd></dl>
2157
2158<dl class="method">
2159<dt id="sas.guiframe.gui_manager.ViewerFrame.on_undo_panel">
2160<tt class="descname">on_undo_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_undo_panel"><span class="viewcode-link">[source]</span></a></dt>
2161<dd><p>undo previous action of the last panel on focus if possible</p>
2162</dd></dl>
2163
2164<dl class="method">
2165<dt id="sas.guiframe.gui_manager.ViewerFrame.on_view">
2166<tt class="descname">on_view</tt><big>(</big><em>evt</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_view"><span class="viewcode-link">[source]</span></a></dt>
2167<dd><p>A panel was selected to be shown. If it&#8217;s not already
2168shown, display it.</p>
2169<table class="docutils field-list" frame="void" rules="none">
2170<col class="field-name" />
2171<col class="field-body" />
2172<tbody valign="top">
2173<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>evt</strong> &#8211; menu event</td>
2174</tr>
2175</tbody>
2176</table>
2177</dd></dl>
2178
2179<dl class="method">
2180<dt id="sas.guiframe.gui_manager.ViewerFrame.on_zoom_in_panel">
2181<tt class="descname">on_zoom_in_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_zoom_in_panel"><span class="viewcode-link">[source]</span></a></dt>
2182<dd><p>zoom in of the panel on focus</p>
2183</dd></dl>
2184
2185<dl class="method">
2186<dt id="sas.guiframe.gui_manager.ViewerFrame.on_zoom_out_panel">
2187<tt class="descname">on_zoom_out_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_zoom_out_panel"><span class="viewcode-link">[source]</span></a></dt>
2188<dd><p>zoom out on the panel on focus</p>
2189</dd></dl>
2190
2191<dl class="method">
2192<dt id="sas.guiframe.gui_manager.ViewerFrame.on_zoom_panel">
2193<tt class="descname">on_zoom_panel</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.on_zoom_panel"><span class="viewcode-link">[source]</span></a></dt>
2194<dd><p>zoom on the current panel if possible</p>
2195</dd></dl>
2196
2197<dl class="method">
2198<dt id="sas.guiframe.gui_manager.ViewerFrame.onfreeze">
2199<tt class="descname">onfreeze</tt><big>(</big><em>theory_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.onfreeze"><span class="viewcode-link">[source]</span></a></dt>
2200<dd></dd></dl>
2201
2202<dl class="method">
2203<dt id="sas.guiframe.gui_manager.ViewerFrame.open_with_externalapp">
2204<tt class="descname">open_with_externalapp</tt><big>(</big><em>data</em>, <em>file_name</em>, <em>details=''</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.open_with_externalapp"><span class="viewcode-link">[source]</span></a></dt>
2205<dd><p>Display data in the another application , by default Excel</p>
2206</dd></dl>
2207
2208<dl class="method">
2209<dt id="sas.guiframe.gui_manager.ViewerFrame.open_with_localapp">
2210<tt class="descname">open_with_localapp</tt><big>(</big><em>data_inputs=None</em>, <em>details=''</em>, <em>file_name=None</em>, <em>data_outputs=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.open_with_localapp"><span class="viewcode-link">[source]</span></a></dt>
2211<dd><p>Display value of data into the application grid
2212:param data: dictionary of string and list of items</p>
2213</dd></dl>
2214
2215<dl class="method">
2216<dt id="sas.guiframe.gui_manager.ViewerFrame.plot_data">
2217<tt class="descname">plot_data</tt><big>(</big><em>state_id</em>, <em>data_id=None</em>, <em>theory_id=None</em>, <em>append=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.plot_data"><span class="viewcode-link">[source]</span></a></dt>
2218<dd><p>send a list of data to plot</p>
2219</dd></dl>
2220
2221<dl class="method">
2222<dt id="sas.guiframe.gui_manager.ViewerFrame.popup_panel">
2223<tt class="descname">popup_panel</tt><big>(</big><em>p</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.popup_panel"><span class="viewcode-link">[source]</span></a></dt>
2224<dd><p>Add a panel object to the AUI manager</p>
2225<table class="docutils field-list" frame="void" rules="none">
2226<col class="field-name" />
2227<col class="field-body" />
2228<tbody valign="top">
2229<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>p</strong> &#8211; panel object to add to the AUI manager</td>
2230</tr>
2231<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the event associated with the new panel [int]</td>
2232</tr>
2233</tbody>
2234</table>
2235</dd></dl>
2236
2237<dl class="method">
2238<dt id="sas.guiframe.gui_manager.ViewerFrame.post_init">
2239<tt class="descname">post_init</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.post_init"><span class="viewcode-link">[source]</span></a></dt>
2240<dd><p>This initialization method is called after the GUI
2241has been created and all plug-ins loaded. It calls
2242the post_init() method of each plug-in (if it exists)
2243so that final initialization can be done.</p>
2244</dd></dl>
2245
2246<dl class="method">
2247<dt id="sas.guiframe.gui_manager.ViewerFrame.put_icon">
2248<tt class="descname">put_icon</tt><big>(</big><em>frame</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.put_icon"><span class="viewcode-link">[source]</span></a></dt>
2249<dd><p>Put icon on the tap of a panel</p>
2250</dd></dl>
2251
2252<dl class="method">
2253<dt id="sas.guiframe.gui_manager.ViewerFrame.quit_guiframe">
2254<tt class="descname">quit_guiframe</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.quit_guiframe"><span class="viewcode-link">[source]</span></a></dt>
2255<dd><p>Pop up message to make sure the user wants to quit the application</p>
2256</dd></dl>
2257
2258<dl class="method">
2259<dt id="sas.guiframe.gui_manager.ViewerFrame.read_batch_tofile">
2260<tt class="descname">read_batch_tofile</tt><big>(</big><em>file_name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.read_batch_tofile"><span class="viewcode-link">[source]</span></a></dt>
2261<dd><p>Extract value from file name and Display them into a grid</p>
2262</dd></dl>
2263
2264<dl class="method">
2265<dt id="sas.guiframe.gui_manager.ViewerFrame.remove_data">
2266<tt class="descname">remove_data</tt><big>(</big><em>data_id</em>, <em>theory_id=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.remove_data"><span class="viewcode-link">[source]</span></a></dt>
2267<dd><p>Delete data state if data_id is provide
2268delete theory created with data of id data_id if theory_id is provide
2269if delete all true: delete the all state
2270else delete theory</p>
2271</dd></dl>
2272
2273<dl class="method">
2274<dt id="sas.guiframe.gui_manager.ViewerFrame.reset_bookmark_menu">
2275<tt class="descname">reset_bookmark_menu</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.reset_bookmark_menu"><span class="viewcode-link">[source]</span></a></dt>
2276<dd><p>Reset Bookmark menu list</p>
2277<p>: param panel: a control panel or tap where the bookmark is</p>
2278</dd></dl>
2279
2280<dl class="method">
2281<dt id="sas.guiframe.gui_manager.ViewerFrame.save_data1d">
2282<tt class="descname">save_data1d</tt><big>(</big><em>data</em>, <em>fname</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.save_data1d"><span class="viewcode-link">[source]</span></a></dt>
2283<dd><p>Save data dialog</p>
2284</dd></dl>
2285
2286<dl class="method">
2287<dt id="sas.guiframe.gui_manager.ViewerFrame.save_data2d">
2288<tt class="descname">save_data2d</tt><big>(</big><em>data</em>, <em>fname</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.save_data2d"><span class="viewcode-link">[source]</span></a></dt>
2289<dd><p>Save data2d dialog</p>
2290</dd></dl>
2291
2292<dl class="method">
2293<dt id="sas.guiframe.gui_manager.ViewerFrame.send_focus_to_datapanel">
2294<tt class="descname">send_focus_to_datapanel</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.send_focus_to_datapanel"><span class="viewcode-link">[source]</span></a></dt>
2295<dd><p>Send focusing on ID to data explorer</p>
2296</dd></dl>
2297
2298<dl class="method">
2299<dt id="sas.guiframe.gui_manager.ViewerFrame.set_current_perspective">
2300<tt class="descname">set_current_perspective</tt><big>(</big><em>perspective</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_current_perspective"><span class="viewcode-link">[source]</span></a></dt>
2301<dd><p>set the current active perspective</p>
2302</dd></dl>
2303
2304<dl class="method">
2305<dt id="sas.guiframe.gui_manager.ViewerFrame.set_custom_default_perspective">
2306<tt class="descname">set_custom_default_perspective</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_custom_default_perspective"><span class="viewcode-link">[source]</span></a></dt>
2307<dd><p>Set default starting perspective</p>
2308</dd></dl>
2309
2310<dl class="method">
2311<dt id="sas.guiframe.gui_manager.ViewerFrame.set_data">
2312<tt class="descname">set_data</tt><big>(</big><em>data_id</em>, <em>theory_id=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_data"><span class="viewcode-link">[source]</span></a></dt>
2313<dd><p>set data to current perspective</p>
2314</dd></dl>
2315
2316<dl class="method">
2317<dt id="sas.guiframe.gui_manager.ViewerFrame.set_default_perspective">
2318<tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_default_perspective"><span class="viewcode-link">[source]</span></a></dt>
2319<dd><p>Choose among the plugin the first plug-in that has
2320&#8220;set_default_perspective&#8221; method and its return value is True will be
2321as a default perspective when the welcome page is closed</p>
2322</dd></dl>
2323
2324<dl class="method">
2325<dt id="sas.guiframe.gui_manager.ViewerFrame.set_input_file">
2326<tt class="descname">set_input_file</tt><big>(</big><em>input_file</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_input_file"><span class="viewcode-link">[source]</span></a></dt>
2327<dd><table class="docutils field-list" frame="void" rules="none">
2328<col class="field-name" />
2329<col class="field-body" />
2330<tbody valign="top">
2331<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>input_file</strong> &#8211; file to read</td>
2332</tr>
2333</tbody>
2334</table>
2335</dd></dl>
2336
2337<dl class="method">
2338<dt id="sas.guiframe.gui_manager.ViewerFrame.set_manager">
2339<tt class="descname">set_manager</tt><big>(</big><em>manager</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_manager"><span class="viewcode-link">[source]</span></a></dt>
2340<dd><p>Sets the application manager for this frame</p>
2341<table class="docutils field-list" frame="void" rules="none">
2342<col class="field-name" />
2343<col class="field-body" />
2344<tbody valign="top">
2345<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>manager</strong> &#8211; frame manager</td>
2346</tr>
2347</tbody>
2348</table>
2349</dd></dl>
2350
2351<dl class="method">
2352<dt id="sas.guiframe.gui_manager.ViewerFrame.set_panel_on_focus">
2353<tt class="descname">set_panel_on_focus</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_panel_on_focus"><span class="viewcode-link">[source]</span></a></dt>
2354<dd><p>Store reference to the last panel on focus
2355update the toolbar if available
2356update edit menu if available</p>
2357</dd></dl>
2358
2359<dl class="method">
2360<dt id="sas.guiframe.gui_manager.ViewerFrame.set_panel_on_focus_helper">
2361<tt class="descname">set_panel_on_focus_helper</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_panel_on_focus_helper"><span class="viewcode-link">[source]</span></a></dt>
2362<dd><p>Helper for panel on focus with data_panel</p>
2363</dd></dl>
2364
2365<dl class="method">
2366<dt id="sas.guiframe.gui_manager.ViewerFrame.set_perspective">
2367<tt class="descname">set_perspective</tt><big>(</big><em>panels</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_perspective"><span class="viewcode-link">[source]</span></a></dt>
2368<dd><p>Sets the perspective of the GUI.
2369Opens all the panels in the list, and closes
2370all the others.</p>
2371<table class="docutils field-list" frame="void" rules="none">
2372<col class="field-name" />
2373<col class="field-body" />
2374<tbody valign="top">
2375<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>panels</strong> &#8211; list of panels</td>
2376</tr>
2377</tbody>
2378</table>
2379</dd></dl>
2380
2381<dl class="method">
2382<dt id="sas.guiframe.gui_manager.ViewerFrame.set_plot_unfocus">
2383<tt class="descname">set_plot_unfocus</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_plot_unfocus"><span class="viewcode-link">[source]</span></a></dt>
2384<dd><p>Un focus all plot panels</p>
2385</dd></dl>
2386
2387<dl class="method">
2388<dt id="sas.guiframe.gui_manager.ViewerFrame.set_schedule">
2389<tt class="descname">set_schedule</tt><big>(</big><em>schedule=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_schedule"><span class="viewcode-link">[source]</span></a></dt>
2390<dd><p>Set schedule</p>
2391</dd></dl>
2392
2393<dl class="method">
2394<dt id="sas.guiframe.gui_manager.ViewerFrame.set_schedule_full_draw">
2395<tt class="descname">set_schedule_full_draw</tt><big>(</big><em>panel=None</em>, <em>func='del'</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_schedule_full_draw"><span class="viewcode-link">[source]</span></a></dt>
2396<dd><p>Add/subtract the schedule full draw list with the panel given</p>
2397<table class="docutils field-list" frame="void" rules="none">
2398<col class="field-name" />
2399<col class="field-body" />
2400<tbody valign="top">
2401<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2402<li><strong>panel</strong> &#8211; plot panel</li>
2403<li><strong>func</strong> &#8211; append or del [string]</li>
2404</ul>
2405</td>
2406</tr>
2407</tbody>
2408</table>
2409</dd></dl>
2410
2411<dl class="method">
2412<dt id="sas.guiframe.gui_manager.ViewerFrame.set_theory">
2413<tt class="descname">set_theory</tt><big>(</big><em>state_id</em>, <em>theory_id=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.set_theory"><span class="viewcode-link">[source]</span></a></dt>
2414<dd></dd></dl>
2415
2416<dl class="method">
2417<dt id="sas.guiframe.gui_manager.ViewerFrame.setup_custom_conf">
2418<tt class="descname">setup_custom_conf</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.setup_custom_conf"><span class="viewcode-link">[source]</span></a></dt>
2419<dd><p>Set up custom configuration if exists</p>
2420</dd></dl>
2421
2422<dl class="method">
2423<dt id="sas.guiframe.gui_manager.ViewerFrame.show_batch_frame">
2424<tt class="descname">show_batch_frame</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.show_batch_frame"><span class="viewcode-link">[source]</span></a></dt>
2425<dd><p>show the grid of result</p>
2426</dd></dl>
2427
2428<dl class="method">
2429<dt id="sas.guiframe.gui_manager.ViewerFrame.show_data1d">
2430<tt class="descname">show_data1d</tt><big>(</big><em>data</em>, <em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.show_data1d"><span class="viewcode-link">[source]</span></a></dt>
2431<dd><p>Show data dialog</p>
2432</dd></dl>
2433
2434<dl class="method">
2435<dt id="sas.guiframe.gui_manager.ViewerFrame.show_data2d">
2436<tt class="descname">show_data2d</tt><big>(</big><em>data</em>, <em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.show_data2d"><span class="viewcode-link">[source]</span></a></dt>
2437<dd><p>Show data dialog</p>
2438</dd></dl>
2439
2440<dl class="method">
2441<dt id="sas.guiframe.gui_manager.ViewerFrame.show_data_panel">
2442<tt class="descname">show_data_panel</tt><big>(</big><em>event=None</em>, <em>action=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.show_data_panel"><span class="viewcode-link">[source]</span></a></dt>
2443<dd><p>show the data panel</p>
2444</dd></dl>
2445
2446<dl class="method">
2447<dt id="sas.guiframe.gui_manager.ViewerFrame.show_welcome_panel">
2448<tt class="descname">show_welcome_panel</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.show_welcome_panel"><span class="viewcode-link">[source]</span></a></dt>
2449<dd><p>Display the welcome panel</p>
2450</dd></dl>
2451
2452<dl class="method">
2453<dt id="sas.guiframe.gui_manager.ViewerFrame.update_data">
2454<tt class="descname">update_data</tt><big>(</big><em>prev_data</em>, <em>new_data</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.update_data"><span class="viewcode-link">[source]</span></a></dt>
2455<dd><p>Update the data.</p>
2456</dd></dl>
2457
2458<dl class="method">
2459<dt id="sas.guiframe.gui_manager.ViewerFrame.update_theory">
2460<tt class="descname">update_theory</tt><big>(</big><em>data_id</em>, <em>theory</em>, <em>state=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.update_theory"><span class="viewcode-link">[source]</span></a></dt>
2461<dd><p>Update the theory</p>
2462</dd></dl>
2463
2464<dl class="method">
2465<dt id="sas.guiframe.gui_manager.ViewerFrame.write_batch_tofile">
2466<tt class="descname">write_batch_tofile</tt><big>(</big><em>data</em>, <em>file_name</em>, <em>details=''</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#ViewerFrame.write_batch_tofile"><span class="viewcode-link">[source]</span></a></dt>
2467<dd><p>Helper to write result from batch into cvs file</p>
2468</dd></dl>
2469
2470</dd></dl>
2471
2472<dl class="function">
2473<dt id="sas.guiframe.gui_manager.get_app_dir">
2474<tt class="descclassname">sas.guiframe.gui_manager.</tt><tt class="descname">get_app_dir</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#get_app_dir"><span class="viewcode-link">[source]</span></a></dt>
2475<dd><p>The application directory is the one where the default custom_config.py
2476file resides.</p>
2477</dd></dl>
2478
2479<dl class="function">
2480<dt id="sas.guiframe.gui_manager.get_user_directory">
2481<tt class="descclassname">sas.guiframe.gui_manager.</tt><tt class="descname">get_user_directory</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_manager.html#get_user_directory"><span class="viewcode-link">[source]</span></a></dt>
2482<dd><p>Returns the user&#8217;s home directory</p>
2483</dd></dl>
2484
2485</div>
2486<div class="section" id="module-sas.guiframe.gui_statusbar">
2487<span id="sas-guiframe-gui-statusbar-module"></span><h2>sas.guiframe.gui_statusbar module</h2>
2488<dl class="class">
2489<dt id="sas.guiframe.gui_statusbar.Console">
2490<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_statusbar.</tt><tt class="descname">Console</tt><big>(</big><em>parent=None</em>, <em>status=''</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#Console"><span class="viewcode-link">[source]</span></a></dt>
2491<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
2492<dl class="method">
2493<dt id="sas.guiframe.gui_statusbar.Console.Close">
2494<tt class="descname">Close</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#Console.Close"><span class="viewcode-link">[source]</span></a></dt>
2495<dd></dd></dl>
2496
2497<dl class="method">
2498<dt id="sas.guiframe.gui_statusbar.Console.set_message">
2499<tt class="descname">set_message</tt><big>(</big><em>status</em>, <em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#Console.set_message"><span class="viewcode-link">[source]</span></a></dt>
2500<dd></dd></dl>
2501
2502<dl class="method">
2503<dt id="sas.guiframe.gui_statusbar.Console.set_multiple_messages">
2504<tt class="descname">set_multiple_messages</tt><big>(</big><em>messages=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#Console.set_multiple_messages"><span class="viewcode-link">[source]</span></a></dt>
2505<dd></dd></dl>
2506
2507</dd></dl>
2508
2509<dl class="class">
2510<dt id="sas.guiframe.gui_statusbar.ConsolePanel">
2511<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_statusbar.</tt><tt class="descname">ConsolePanel</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#ConsolePanel"><span class="viewcode-link">[source]</span></a></dt>
2512<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Panel</span></tt></p>
2513<dl class="method">
2514<dt id="sas.guiframe.gui_statusbar.ConsolePanel.set_message">
2515<tt class="descname">set_message</tt><big>(</big><em>status=''</em>, <em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#ConsolePanel.set_message"><span class="viewcode-link">[source]</span></a></dt>
2516<dd></dd></dl>
2517
2518</dd></dl>
2519
2520<dl class="class">
2521<dt id="sas.guiframe.gui_statusbar.SPageStatusbar">
2522<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_statusbar.</tt><tt class="descname">SPageStatusbar</tt><big>(</big><em>parent</em>, <em>timeout=None</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#SPageStatusbar"><span class="viewcode-link">[source]</span></a></dt>
2523<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.StatusBar</span></tt></p>
2524</dd></dl>
2525
2526<dl class="class">
2527<dt id="sas.guiframe.gui_statusbar.StatusBar">
2528<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_statusbar.</tt><tt class="descname">StatusBar</tt><big>(</big><em>parent</em>, <em>id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar"><span class="viewcode-link">[source]</span></a></dt>
2529<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.StatusBar</span></tt></p>
2530<p>Application status bar</p>
2531<dl class="method">
2532<dt id="sas.guiframe.gui_statusbar.StatusBar.OnIdle">
2533<tt class="descname">OnIdle</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.OnIdle"><span class="viewcode-link">[source]</span></a></dt>
2534<dd></dd></dl>
2535
2536<dl class="method">
2537<dt id="sas.guiframe.gui_statusbar.StatusBar.OnSize">
2538<tt class="descname">OnSize</tt><big>(</big><em>evt</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.OnSize"><span class="viewcode-link">[source]</span></a></dt>
2539<dd></dd></dl>
2540
2541<dl class="method">
2542<dt id="sas.guiframe.gui_statusbar.StatusBar.PopStatusText">
2543<tt class="descname">PopStatusText</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.PopStatusText"><span class="viewcode-link">[source]</span></a></dt>
2544<dd><p>Override status bar</p>
2545</dd></dl>
2546
2547<dl class="method">
2548<dt id="sas.guiframe.gui_statusbar.StatusBar.PushStatusText">
2549<tt class="descname">PushStatusText</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.PushStatusText"><span class="viewcode-link">[source]</span></a></dt>
2550<dd></dd></dl>
2551
2552<dl class="method">
2553<dt id="sas.guiframe.gui_statusbar.StatusBar.SetStatusText">
2554<tt class="descname">SetStatusText</tt><big>(</big><em>text=''</em>, <em>number=1</em>, <em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.SetStatusText"><span class="viewcode-link">[source]</span></a></dt>
2555<dd></dd></dl>
2556
2557<dl class="method">
2558<dt id="sas.guiframe.gui_statusbar.StatusBar.clear_gauge">
2559<tt class="descname">clear_gauge</tt><big>(</big><em>msg=''</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.clear_gauge"><span class="viewcode-link">[source]</span></a></dt>
2560<dd><p>Hide the gauge</p>
2561</dd></dl>
2562
2563<dl class="method">
2564<dt id="sas.guiframe.gui_statusbar.StatusBar.enable_clear_gauge">
2565<tt class="descname">enable_clear_gauge</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.enable_clear_gauge"><span class="viewcode-link">[source]</span></a></dt>
2566<dd><p>clear the progress bar</p>
2567</dd></dl>
2568
2569<dl class="method">
2570<dt id="sas.guiframe.gui_statusbar.StatusBar.get_msg_position">
2571<tt class="descname">get_msg_position</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.get_msg_position"><span class="viewcode-link">[source]</span></a></dt>
2572<dd></dd></dl>
2573
2574<dl class="method">
2575<dt id="sas.guiframe.gui_statusbar.StatusBar.reposition">
2576<tt class="descname">reposition</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.reposition"><span class="viewcode-link">[source]</span></a></dt>
2577<dd><p>Place the various fields in their proper position</p>
2578</dd></dl>
2579
2580<dl class="method">
2581<dt id="sas.guiframe.gui_statusbar.StatusBar.set_dialog">
2582<tt class="descname">set_dialog</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.set_dialog"><span class="viewcode-link">[source]</span></a></dt>
2583<dd><p>Display dialogbox</p>
2584</dd></dl>
2585
2586<dl class="method">
2587<dt id="sas.guiframe.gui_statusbar.StatusBar.set_gauge">
2588<tt class="descname">set_gauge</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.set_gauge"><span class="viewcode-link">[source]</span></a></dt>
2589<dd><p>change the state of the gauge according the state of the current job</p>
2590</dd></dl>
2591
2592<dl class="method">
2593<dt id="sas.guiframe.gui_statusbar.StatusBar.set_icon">
2594<tt class="descname">set_icon</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.set_icon"><span class="viewcode-link">[source]</span></a></dt>
2595<dd><p>Display icons related to the type of message sent to the statusbar
2596when available. No icon is displayed if the message is empty</p>
2597</dd></dl>
2598
2599<dl class="method">
2600<dt id="sas.guiframe.gui_statusbar.StatusBar.set_message">
2601<tt class="descname">set_message</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.set_message"><span class="viewcode-link">[source]</span></a></dt>
2602<dd><p>display received message on the statusbar</p>
2603</dd></dl>
2604
2605<dl class="method">
2606<dt id="sas.guiframe.gui_statusbar.StatusBar.set_status">
2607<tt class="descname">set_status</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_statusbar.html#StatusBar.set_status"><span class="viewcode-link">[source]</span></a></dt>
2608<dd><p>Update the status bar .</p>
2609<table class="docutils field-list" frame="void" rules="none">
2610<col class="field-name" />
2611<col class="field-body" />
2612<tbody valign="top">
2613<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2614<li><strong>type</strong> &#8211; type of message send.
2615type  must be in [&#8220;start&#8221;,&#8221;progress&#8221;,&#8221;update&#8221;,&#8221;stop&#8221;]</li>
2616<li><strong>msg</strong> &#8211; the message itself  as string</li>
2617<li><strong>thread</strong> &#8211; if updatting using a thread status</li>
2618</ul>
2619</td>
2620</tr>
2621</tbody>
2622</table>
2623</dd></dl>
2624
2625</dd></dl>
2626
2627</div>
2628<div class="section" id="module-sas.guiframe.gui_style">
2629<span id="sas-guiframe-gui-style-module"></span><h2>sas.guiframe.gui_style module</h2>
2630<p>Provide the style for guiframe</p>
2631<dl class="class">
2632<dt id="sas.guiframe.gui_style.GUIFRAME">
2633<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_style.</tt><tt class="descname">GUIFRAME</tt><a class="reference internal" href="../../_modules/sas/guiframe/gui_style.html#GUIFRAME"><span class="viewcode-link">[source]</span></a></dt>
2634<dd><dl class="attribute">
2635<dt id="sas.guiframe.gui_style.GUIFRAME.CALCULATOR_ON">
2636<tt class="descname">CALCULATOR_ON</tt><em class="property"> = 256</em></dt>
2637<dd></dd></dl>
2638
2639<dl class="attribute">
2640<dt id="sas.guiframe.gui_style.GUIFRAME.DATALOADER_ON">
2641<tt class="descname">DATALOADER_ON</tt><em class="property"> = 16</em></dt>
2642<dd></dd></dl>
2643
2644<dl class="attribute">
2645<dt id="sas.guiframe.gui_style.GUIFRAME.DEFAULT_STYLE">
2646<tt class="descname">DEFAULT_STYLE</tt><em class="property"> = 92</em></dt>
2647<dd></dd></dl>
2648
2649<dl class="attribute">
2650<dt id="sas.guiframe.gui_style.GUIFRAME.FIXED_PANEL">
2651<tt class="descname">FIXED_PANEL</tt><em class="property"> = 4</em></dt>
2652<dd></dd></dl>
2653
2654<dl class="attribute">
2655<dt id="sas.guiframe.gui_style.GUIFRAME.FLOATING_PANEL">
2656<tt class="descname">FLOATING_PANEL</tt><em class="property"> = 2</em></dt>
2657<dd></dd></dl>
2658
2659<dl class="attribute">
2660<dt id="sas.guiframe.gui_style.GUIFRAME.MANAGER_ON">
2661<tt class="descname">MANAGER_ON</tt><em class="property"> = 1</em></dt>
2662<dd></dd></dl>
2663
2664<dl class="attribute">
2665<dt id="sas.guiframe.gui_style.GUIFRAME.MULTIPLE_APPLICATIONS">
2666<tt class="descname">MULTIPLE_APPLICATIONS</tt><em class="property"> = 92</em></dt>
2667<dd></dd></dl>
2668
2669<dl class="attribute">
2670<dt id="sas.guiframe.gui_style.GUIFRAME.PLOTTING_ON">
2671<tt class="descname">PLOTTING_ON</tt><em class="property"> = 8</em></dt>
2672<dd></dd></dl>
2673
2674<dl class="attribute">
2675<dt id="sas.guiframe.gui_style.GUIFRAME.SINGLE_APPLICATION">
2676<tt class="descname">SINGLE_APPLICATION</tt><em class="property"> = 64</em></dt>
2677<dd></dd></dl>
2678
2679<dl class="attribute">
2680<dt id="sas.guiframe.gui_style.GUIFRAME.TOOLBAR_ON">
2681<tt class="descname">TOOLBAR_ON</tt><em class="property"> = 32</em></dt>
2682<dd></dd></dl>
2683
2684<dl class="attribute">
2685<dt id="sas.guiframe.gui_style.GUIFRAME.WELCOME_PANEL_ON">
2686<tt class="descname">WELCOME_PANEL_ON</tt><em class="property"> = 128</em></dt>
2687<dd></dd></dl>
2688
2689</dd></dl>
2690
2691<dl class="class">
2692<dt id="sas.guiframe.gui_style.GUIFRAME_ICON">
2693<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_style.</tt><tt class="descname">GUIFRAME_ICON</tt><a class="reference internal" href="../../_modules/sas/guiframe/gui_style.html#GUIFRAME_ICON"><span class="viewcode-link">[source]</span></a></dt>
2694<dd><dl class="attribute">
2695<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.BOOKMARK_ICON">
2696<tt class="descname">BOOKMARK_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x1006e1210&gt; &gt;</em></dt>
2697<dd></dd></dl>
2698
2699<dl class="attribute">
2700<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.BOOKMARK_ICON_PATH">
2701<tt class="descname">BOOKMARK_ICON_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/bookmark.png'</em></dt>
2702<dd></dd></dl>
2703
2704<dl class="attribute">
2705<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.COPY_ICON">
2706<tt class="descname">COPY_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10a214c00&gt; &gt;</em></dt>
2707<dd></dd></dl>
2708
2709<dl class="attribute">
2710<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.COPY_ICON_PATH">
2711<tt class="descname">COPY_ICON_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/copy.png'</em></dt>
2712<dd></dd></dl>
2713
2714<dl class="attribute">
2715<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.DRAG_ICON">
2716<tt class="descname">DRAG_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x100721050&gt; &gt;</em></dt>
2717<dd></dd></dl>
2718
2719<dl class="attribute">
2720<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.DRAG_ID_PATH">
2721<tt class="descname">DRAG_ID_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/drag_hand.png'</em></dt>
2722<dd></dd></dl>
2723
2724<dl class="attribute">
2725<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.FRAME_ICON_PATH">
2726<tt class="descname">FRAME_ICON_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/ball.ico'</em></dt>
2727<dd></dd></dl>
2728
2729<dl class="attribute">
2730<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.HIDE_ICON">
2731<tt class="descname">HIDE_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10a4f6cf0&gt; &gt;</em></dt>
2732<dd></dd></dl>
2733
2734<dl class="attribute">
2735<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.HIDE_ID_PATH">
2736<tt class="descname">HIDE_ID_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/hide.png'</em></dt>
2737<dd></dd></dl>
2738
2739<dl class="attribute">
2740<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.PASTE_ICON">
2741<tt class="descname">PASTE_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x1006becb0&gt; &gt;</em></dt>
2742<dd></dd></dl>
2743
2744<dl class="attribute">
2745<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.PASTE_ICON_PATH">
2746<tt class="descname">PASTE_ICON_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/paste.png'</em></dt>
2747<dd></dd></dl>
2748
2749<dl class="attribute">
2750<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.PATH">
2751<tt class="descname">PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images'</em></dt>
2752<dd></dd></dl>
2753
2754<dl class="attribute">
2755<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.PREVIEW_ICON">
2756<tt class="descname">PREVIEW_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10a4d0430&gt; &gt;</em></dt>
2757<dd></dd></dl>
2758
2759<dl class="attribute">
2760<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.PREVIEW_ID_PATH">
2761<tt class="descname">PREVIEW_ID_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/report.png'</em></dt>
2762<dd></dd></dl>
2763
2764<dl class="attribute">
2765<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.PRINT_ICON">
2766<tt class="descname">PRINT_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x104b324a0&gt; &gt;</em></dt>
2767<dd></dd></dl>
2768
2769<dl class="attribute">
2770<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.PRINT_ID_PATH">
2771<tt class="descname">PRINT_ID_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/printer.png'</em></dt>
2772<dd></dd></dl>
2773
2774<dl class="attribute">
2775<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.REDO_ICON">
2776<tt class="descname">REDO_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x104b91fa0&gt; &gt;</em></dt>
2777<dd></dd></dl>
2778
2779<dl class="attribute">
2780<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.REDO_ICON_PATH">
2781<tt class="descname">REDO_ICON_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/redo.png'</em></dt>
2782<dd></dd></dl>
2783
2784<dl class="attribute">
2785<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.REPORT_ICON">
2786<tt class="descname">REPORT_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10a424a10&gt; &gt;</em></dt>
2787<dd></dd></dl>
2788
2789<dl class="attribute">
2790<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.RESET_ICON">
2791<tt class="descname">RESET_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10a46fef0&gt; &gt;</em></dt>
2792<dd></dd></dl>
2793
2794<dl class="attribute">
2795<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.RESET_ID_PATH">
2796<tt class="descname">RESET_ID_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/reset.png'</em></dt>
2797<dd></dd></dl>
2798
2799<dl class="attribute">
2800<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.SAVE_ICON">
2801<tt class="descname">SAVE_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10a221a80&gt; &gt;</em></dt>
2802<dd></dd></dl>
2803
2804<dl class="attribute">
2805<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.SAVE_ICON_PATH">
2806<tt class="descname">SAVE_ICON_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/save.png'</em></dt>
2807<dd></dd></dl>
2808
2809<dl class="attribute">
2810<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.UNDO_ICON">
2811<tt class="descname">UNDO_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x108d88e10&gt; &gt;</em></dt>
2812<dd></dd></dl>
2813
2814<dl class="attribute">
2815<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.UNDO_ICON_PATH">
2816<tt class="descname">UNDO_ICON_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/undo.png'</em></dt>
2817<dd></dd></dl>
2818
2819<dl class="attribute">
2820<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.ZOOM_ICON">
2821<tt class="descname">ZOOM_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10a2c0e30&gt; &gt;</em></dt>
2822<dd></dd></dl>
2823
2824<dl class="attribute">
2825<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.ZOOM_ID_PATH">
2826<tt class="descname">ZOOM_ID_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/search_pan.png'</em></dt>
2827<dd></dd></dl>
2828
2829<dl class="attribute">
2830<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.ZOOM_IN_ICON">
2831<tt class="descname">ZOOM_IN_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10a4e8a70&gt; &gt;</em></dt>
2832<dd></dd></dl>
2833
2834<dl class="attribute">
2835<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.ZOOM_IN_ID_PATH">
2836<tt class="descname">ZOOM_IN_ID_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/zoom_in.png'</em></dt>
2837<dd></dd></dl>
2838
2839<dl class="attribute">
2840<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.ZOOM_OUT_ICON">
2841<tt class="descname">ZOOM_OUT_ICON</tt><em class="property"> = &lt;wx._core.Image; proxy of &lt;Swig Object of type 'wxImage *' at 0x10931d840&gt; &gt;</em></dt>
2842<dd></dd></dl>
2843
2844<dl class="attribute">
2845<dt id="sas.guiframe.gui_style.GUIFRAME_ICON.ZOOM_OUT_ID_PATH">
2846<tt class="descname">ZOOM_OUT_ID_PATH</tt><em class="property"> = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/zoom_out.png'</em></dt>
2847<dd></dd></dl>
2848
2849</dd></dl>
2850
2851<dl class="class">
2852<dt id="sas.guiframe.gui_style.GUIFRAME_ID">
2853<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_style.</tt><tt class="descname">GUIFRAME_ID</tt><a class="reference internal" href="../../_modules/sas/guiframe/gui_style.html#GUIFRAME_ID"><span class="viewcode-link">[source]</span></a></dt>
2854<dd><dl class="attribute">
2855<dt id="sas.guiframe.gui_style.GUIFRAME_ID.BOOKMARK_ID">
2856<tt class="descname">BOOKMARK_ID</tt><em class="property"> = 104</em></dt>
2857<dd></dd></dl>
2858
2859<dl class="attribute">
2860<dt id="sas.guiframe.gui_style.GUIFRAME_ID.COPYAS_ID">
2861<tt class="descname">COPYAS_ID</tt><em class="property"> = 116</em></dt>
2862<dd></dd></dl>
2863
2864<dl class="attribute">
2865<dt id="sas.guiframe.gui_style.GUIFRAME_ID.COPYEX_ID">
2866<tt class="descname">COPYEX_ID</tt><em class="property"> = 114</em></dt>
2867<dd></dd></dl>
2868
2869<dl class="attribute">
2870<dt id="sas.guiframe.gui_style.GUIFRAME_ID.COPYLAT_ID">
2871<tt class="descname">COPYLAT_ID</tt><em class="property"> = 115</em></dt>
2872<dd></dd></dl>
2873
2874<dl class="attribute">
2875<dt id="sas.guiframe.gui_style.GUIFRAME_ID.COPY_ID">
2876<tt class="descname">COPY_ID</tt><em class="property"> = 102</em></dt>
2877<dd></dd></dl>
2878
2879<dl class="attribute">
2880<dt id="sas.guiframe.gui_style.GUIFRAME_ID.CURRENT_APPLICATION">
2881<tt class="descname">CURRENT_APPLICATION</tt><em class="property"> = 113</em></dt>
2882<dd></dd></dl>
2883
2884<dl class="attribute">
2885<dt id="sas.guiframe.gui_style.GUIFRAME_ID.CURVE_SYMBOL_NUM">
2886<tt class="descname">CURVE_SYMBOL_NUM</tt><em class="property"> = 13</em></dt>
2887<dd></dd></dl>
2888
2889<dl class="attribute">
2890<dt id="sas.guiframe.gui_style.GUIFRAME_ID.DRAG_ID">
2891<tt class="descname">DRAG_ID</tt><em class="property"> = 109</em></dt>
2892<dd></dd></dl>
2893
2894<dl class="attribute">
2895<dt id="sas.guiframe.gui_style.GUIFRAME_ID.PASTE_ID">
2896<tt class="descname">PASTE_ID</tt><em class="property"> = 103</em></dt>
2897<dd></dd></dl>
2898
2899<dl class="attribute">
2900<dt id="sas.guiframe.gui_style.GUIFRAME_ID.PREVIEW_ID">
2901<tt class="descname">PREVIEW_ID</tt><em class="property"> = 111</em></dt>
2902<dd></dd></dl>
2903
2904<dl class="attribute">
2905<dt id="sas.guiframe.gui_style.GUIFRAME_ID.PRINT_ID">
2906<tt class="descname">PRINT_ID</tt><em class="property"> = 112</em></dt>
2907<dd></dd></dl>
2908
2909<dl class="attribute">
2910<dt id="sas.guiframe.gui_style.GUIFRAME_ID.REDO_ID">
2911<tt class="descname">REDO_ID</tt><em class="property"> = 101</em></dt>
2912<dd></dd></dl>
2913
2914<dl class="attribute">
2915<dt id="sas.guiframe.gui_style.GUIFRAME_ID.RESET_ID">
2916<tt class="descname">RESET_ID</tt><em class="property"> = 110</em></dt>
2917<dd></dd></dl>
2918
2919<dl class="attribute">
2920<dt id="sas.guiframe.gui_style.GUIFRAME_ID.SAVE_ID">
2921<tt class="descname">SAVE_ID</tt><em class="property"> = 105</em></dt>
2922<dd></dd></dl>
2923
2924<dl class="attribute">
2925<dt id="sas.guiframe.gui_style.GUIFRAME_ID.UNDO_ID">
2926<tt class="descname">UNDO_ID</tt><em class="property"> = 100</em></dt>
2927<dd></dd></dl>
2928
2929<dl class="attribute">
2930<dt id="sas.guiframe.gui_style.GUIFRAME_ID.ZOOM_ID">
2931<tt class="descname">ZOOM_ID</tt><em class="property"> = 108</em></dt>
2932<dd></dd></dl>
2933
2934<dl class="attribute">
2935<dt id="sas.guiframe.gui_style.GUIFRAME_ID.ZOOM_IN_ID">
2936<tt class="descname">ZOOM_IN_ID</tt><em class="property"> = 106</em></dt>
2937<dd></dd></dl>
2938
2939<dl class="attribute">
2940<dt id="sas.guiframe.gui_style.GUIFRAME_ID.ZOOM_OUT_ID">
2941<tt class="descname">ZOOM_OUT_ID</tt><em class="property"> = 107</em></dt>
2942<dd></dd></dl>
2943
2944</dd></dl>
2945
2946</div>
2947<div class="section" id="module-sas.guiframe.gui_toolbar">
2948<span id="sas-guiframe-gui-toolbar-module"></span><h2>sas.guiframe.gui_toolbar module</h2>
2949<dl class="class">
2950<dt id="sas.guiframe.gui_toolbar.GUIToolBar">
2951<em class="property">class </em><tt class="descclassname">sas.guiframe.gui_toolbar.</tt><tt class="descname">GUIToolBar</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar"><span class="viewcode-link">[source]</span></a></dt>
2952<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._controls.ToolBar</span></tt></p>
2953<p>Implement toolbar for guiframe</p>
2954<dl class="method">
2955<dt id="sas.guiframe.gui_toolbar.GUIToolBar.add_bookmark_default">
2956<tt class="descname">add_bookmark_default</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.add_bookmark_default"><span class="viewcode-link">[source]</span></a></dt>
2957<dd><p>Add default items in bookmark menu</p>
2958</dd></dl>
2959
2960<dl class="method">
2961<dt id="sas.guiframe.gui_toolbar.GUIToolBar.append_bookmark">
2962<tt class="descname">append_bookmark</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.append_bookmark"><span class="viewcode-link">[source]</span></a></dt>
2963<dd><p>receive item to append on the toolbar button bookmark</p>
2964</dd></dl>
2965
2966<dl class="method">
2967<dt id="sas.guiframe.gui_toolbar.GUIToolBar.append_bookmark_item">
2968<tt class="descname">append_bookmark_item</tt><big>(</big><em>id</em>, <em>label</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.append_bookmark_item"><span class="viewcode-link">[source]</span></a></dt>
2969<dd><p>Append a item in bookmark</p>
2970</dd></dl>
2971
2972<dl class="method">
2973<dt id="sas.guiframe.gui_toolbar.GUIToolBar.do_layout">
2974<tt class="descname">do_layout</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.do_layout"><span class="viewcode-link">[source]</span></a></dt>
2975<dd></dd></dl>
2976
2977<dl class="method">
2978<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_bookmark">
2979<tt class="descname">enable_bookmark</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_bookmark"><span class="viewcode-link">[source]</span></a></dt>
2980<dd></dd></dl>
2981
2982<dl class="method">
2983<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_copy">
2984<tt class="descname">enable_copy</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_copy"><span class="viewcode-link">[source]</span></a></dt>
2985<dd></dd></dl>
2986
2987<dl class="method">
2988<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_paste">
2989<tt class="descname">enable_paste</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_paste"><span class="viewcode-link">[source]</span></a></dt>
2990<dd></dd></dl>
2991
2992<dl class="method">
2993<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_preview">
2994<tt class="descname">enable_preview</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_preview"><span class="viewcode-link">[source]</span></a></dt>
2995<dd></dd></dl>
2996
2997<dl class="method">
2998<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_print">
2999<tt class="descname">enable_print</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_print"><span class="viewcode-link">[source]</span></a></dt>
3000<dd></dd></dl>
3001
3002<dl class="method">
3003<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_redo">
3004<tt class="descname">enable_redo</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_redo"><span class="viewcode-link">[source]</span></a></dt>
3005<dd></dd></dl>
3006
3007<dl class="method">
3008<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_reset">
3009<tt class="descname">enable_reset</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_reset"><span class="viewcode-link">[source]</span></a></dt>
3010<dd></dd></dl>
3011
3012<dl class="method">
3013<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_save">
3014<tt class="descname">enable_save</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_save"><span class="viewcode-link">[source]</span></a></dt>
3015<dd></dd></dl>
3016
3017<dl class="method">
3018<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_undo">
3019<tt class="descname">enable_undo</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_undo"><span class="viewcode-link">[source]</span></a></dt>
3020<dd></dd></dl>
3021
3022<dl class="method">
3023<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_zoom">
3024<tt class="descname">enable_zoom</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_zoom"><span class="viewcode-link">[source]</span></a></dt>
3025<dd></dd></dl>
3026
3027<dl class="method">
3028<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_zoom_in">
3029<tt class="descname">enable_zoom_in</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_zoom_in"><span class="viewcode-link">[source]</span></a></dt>
3030<dd></dd></dl>
3031
3032<dl class="method">
3033<dt id="sas.guiframe.gui_toolbar.GUIToolBar.enable_zoom_out">
3034<tt class="descname">enable_zoom_out</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.enable_zoom_out"><span class="viewcode-link">[source]</span></a></dt>
3035<dd></dd></dl>
3036
3037<dl class="method">
3038<dt id="sas.guiframe.gui_toolbar.GUIToolBar.get_bookmark_items">
3039<tt class="descname">get_bookmark_items</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.get_bookmark_items"><span class="viewcode-link">[source]</span></a></dt>
3040<dd><p>Get bookmark menu items</p>
3041</dd></dl>
3042
3043<dl class="method">
3044<dt id="sas.guiframe.gui_toolbar.GUIToolBar.on_bind_button">
3045<tt class="descname">on_bind_button</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.on_bind_button"><span class="viewcode-link">[source]</span></a></dt>
3046<dd><p>Bind the buttons</p>
3047</dd></dl>
3048
3049<dl class="method">
3050<dt id="sas.guiframe.gui_toolbar.GUIToolBar.on_bookmark">
3051<tt class="descname">on_bookmark</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.on_bookmark"><span class="viewcode-link">[source]</span></a></dt>
3052<dd><p>add book mark</p>
3053</dd></dl>
3054
3055<dl class="method">
3056<dt id="sas.guiframe.gui_toolbar.GUIToolBar.remove_bookmark_item">
3057<tt class="descname">remove_bookmark_item</tt><big>(</big><em>item</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.remove_bookmark_item"><span class="viewcode-link">[source]</span></a></dt>
3058<dd><p>Remove a bookmark item</p>
3059</dd></dl>
3060
3061<dl class="method">
3062<dt id="sas.guiframe.gui_toolbar.GUIToolBar.update_button">
3063<tt class="descname">update_button</tt><big>(</big><em>application_name=''</em>, <em>panel_name=''</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.update_button"><span class="viewcode-link">[source]</span></a></dt>
3064<dd></dd></dl>
3065
3066<dl class="method">
3067<dt id="sas.guiframe.gui_toolbar.GUIToolBar.update_toolbar">
3068<tt class="descname">update_toolbar</tt><big>(</big><em>panel=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#GUIToolBar.update_toolbar"><span class="viewcode-link">[source]</span></a></dt>
3069<dd></dd></dl>
3070
3071</dd></dl>
3072
3073<dl class="function">
3074<dt id="sas.guiframe.gui_toolbar.clear_image">
3075<tt class="descclassname">sas.guiframe.gui_toolbar.</tt><tt class="descname">clear_image</tt><big>(</big><em>image</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/gui_toolbar.html#clear_image"><span class="viewcode-link">[source]</span></a></dt>
3076<dd></dd></dl>
3077
3078</div>
3079<div class="section" id="module-sas.guiframe.panel_base">
3080<span id="sas-guiframe-panel-base-module"></span><h2>sas.guiframe.panel_base module</h2>
3081<dl class="class">
3082<dt id="sas.guiframe.panel_base.PanelBase">
3083<em class="property">class </em><tt class="descclassname">sas.guiframe.panel_base.</tt><tt class="descname">PanelBase</tt><big>(</big><em>parent=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase"><span class="viewcode-link">[source]</span></a></dt>
3084<dd><p>Defines the API for a panels to work with
3085the ViewerFrame toolbar and menu bar</p>
3086<dl class="method">
3087<dt id="sas.guiframe.panel_base.PanelBase.get_bookmark_flag">
3088<tt class="descname">get_bookmark_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_bookmark_flag"><span class="viewcode-link">[source]</span></a></dt>
3089<dd><p>Get the bookmark flag to update appropriately the tool bar</p>
3090</dd></dl>
3091
3092<dl class="method">
3093<dt id="sas.guiframe.panel_base.PanelBase.get_copy_flag">
3094<tt class="descname">get_copy_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_copy_flag"><span class="viewcode-link">[source]</span></a></dt>
3095<dd><p>Get the copy flag to update appropriately the tool bar</p>
3096</dd></dl>
3097
3098<dl class="method">
3099<dt id="sas.guiframe.panel_base.PanelBase.get_data">
3100<tt class="descname">get_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_data"><span class="viewcode-link">[source]</span></a></dt>
3101<dd><p>return list of current data</p>
3102</dd></dl>
3103
3104<dl class="method">
3105<dt id="sas.guiframe.panel_base.PanelBase.get_drag_flag">
3106<tt class="descname">get_drag_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_drag_flag"><span class="viewcode-link">[source]</span></a></dt>
3107<dd><p>Get the drag flag to update appropriately the tool bar</p>
3108</dd></dl>
3109
3110<dl class="method">
3111<dt id="sas.guiframe.panel_base.PanelBase.get_frame">
3112<tt class="descname">get_frame</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_frame"><span class="viewcode-link">[source]</span></a></dt>
3113<dd></dd></dl>
3114
3115<dl class="method">
3116<dt id="sas.guiframe.panel_base.PanelBase.get_manager">
3117<tt class="descname">get_manager</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_manager"><span class="viewcode-link">[source]</span></a></dt>
3118<dd></dd></dl>
3119
3120<dl class="method">
3121<dt id="sas.guiframe.panel_base.PanelBase.get_paste_flag">
3122<tt class="descname">get_paste_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_paste_flag"><span class="viewcode-link">[source]</span></a></dt>
3123<dd><p>Get the copy flag to update appropriately the tool bar</p>
3124</dd></dl>
3125
3126<dl class="method">
3127<dt id="sas.guiframe.panel_base.PanelBase.get_preview_flag">
3128<tt class="descname">get_preview_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_preview_flag"><span class="viewcode-link">[source]</span></a></dt>
3129<dd><p>Get the preview flag to update appropriately the tool bar</p>
3130</dd></dl>
3131
3132<dl class="method">
3133<dt id="sas.guiframe.panel_base.PanelBase.get_print_flag">
3134<tt class="descname">get_print_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_print_flag"><span class="viewcode-link">[source]</span></a></dt>
3135<dd><p>Get the print flag to update appropriately the tool bar</p>
3136</dd></dl>
3137
3138<dl class="method">
3139<dt id="sas.guiframe.panel_base.PanelBase.get_redo_flag">
3140<tt class="descname">get_redo_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_redo_flag"><span class="viewcode-link">[source]</span></a></dt>
3141<dd><p>Get the redo flag to update appropriately the tool bar</p>
3142</dd></dl>
3143
3144<dl class="method">
3145<dt id="sas.guiframe.panel_base.PanelBase.get_reset_flag">
3146<tt class="descname">get_reset_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_reset_flag"><span class="viewcode-link">[source]</span></a></dt>
3147<dd><p>Get the reset flag to update appropriately the tool bar</p>
3148</dd></dl>
3149
3150<dl class="method">
3151<dt id="sas.guiframe.panel_base.PanelBase.get_save_flag">
3152<tt class="descname">get_save_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_save_flag"><span class="viewcode-link">[source]</span></a></dt>
3153<dd><p>Get the save flag to update appropriately the tool bar</p>
3154</dd></dl>
3155
3156<dl class="method">
3157<dt id="sas.guiframe.panel_base.PanelBase.get_state">
3158<tt class="descname">get_state</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_state"><span class="viewcode-link">[source]</span></a></dt>
3159<dd><p>return the current state</p>
3160</dd></dl>
3161
3162<dl class="method">
3163<dt id="sas.guiframe.panel_base.PanelBase.get_undo_flag">
3164<tt class="descname">get_undo_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_undo_flag"><span class="viewcode-link">[source]</span></a></dt>
3165<dd><p>Get the undo flag to update appropriately the tool bar</p>
3166</dd></dl>
3167
3168<dl class="method">
3169<dt id="sas.guiframe.panel_base.PanelBase.get_zoom_flag">
3170<tt class="descname">get_zoom_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_zoom_flag"><span class="viewcode-link">[source]</span></a></dt>
3171<dd><p>Get the zoom flag to update appropriately the tool bar</p>
3172</dd></dl>
3173
3174<dl class="method">
3175<dt id="sas.guiframe.panel_base.PanelBase.get_zoom_in_flag">
3176<tt class="descname">get_zoom_in_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_zoom_in_flag"><span class="viewcode-link">[source]</span></a></dt>
3177<dd><p>Get the zoom in flag to update appropriately the tool bar</p>
3178</dd></dl>
3179
3180<dl class="method">
3181<dt id="sas.guiframe.panel_base.PanelBase.get_zoom_out_flag">
3182<tt class="descname">get_zoom_out_flag</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.get_zoom_out_flag"><span class="viewcode-link">[source]</span></a></dt>
3183<dd><p>Get the zoom out flag to update appropriately the tool bar</p>
3184</dd></dl>
3185
3186<dl class="attribute">
3187<dt id="sas.guiframe.panel_base.PanelBase.group_id">
3188<tt class="descname">group_id</tt><em class="property"> = None</em></dt>
3189<dd></dd></dl>
3190
3191<dl class="method">
3192<dt id="sas.guiframe.panel_base.PanelBase.has_changed">
3193<tt class="descname">has_changed</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.has_changed"><span class="viewcode-link">[source]</span></a></dt>
3194<dd></dd></dl>
3195
3196<dl class="method">
3197<dt id="sas.guiframe.panel_base.PanelBase.on_batch_selection">
3198<tt class="descname">on_batch_selection</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_batch_selection"><span class="viewcode-link">[source]</span></a></dt>
3199<dd><table class="docutils field-list" frame="void" rules="none">
3200<col class="field-name" />
3201<col class="field-body" />
3202<tbody valign="top">
3203<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; contains parameter enable . when enable is set to True</td>
3204</tr>
3205</tbody>
3206</table>
3207<p>the application is in Batch mode
3208else the application is default mode(single mode)</p>
3209</dd></dl>
3210
3211<dl class="method">
3212<dt id="sas.guiframe.panel_base.PanelBase.on_bookmark">
3213<tt class="descname">on_bookmark</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_bookmark"><span class="viewcode-link">[source]</span></a></dt>
3214<dd><p>The derivative class is on bookmark mode if implemented</p>
3215</dd></dl>
3216
3217<dl class="method">
3218<dt id="sas.guiframe.panel_base.PanelBase.on_close">
3219<tt class="descname">on_close</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_close"><span class="viewcode-link">[source]</span></a></dt>
3220<dd><p>Close event. Hide the whole window.</p>
3221</dd></dl>
3222
3223<dl class="method">
3224<dt id="sas.guiframe.panel_base.PanelBase.on_copy">
3225<tt class="descname">on_copy</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_copy"><span class="viewcode-link">[source]</span></a></dt>
3226<dd><p>The copy action if possible</p>
3227</dd></dl>
3228
3229<dl class="method">
3230<dt id="sas.guiframe.panel_base.PanelBase.on_drag">
3231<tt class="descname">on_drag</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_drag"><span class="viewcode-link">[source]</span></a></dt>
3232<dd><p>The derivative class allows dragging motion if implemented</p>
3233</dd></dl>
3234
3235<dl class="method">
3236<dt id="sas.guiframe.panel_base.PanelBase.on_kill_focus">
3237<tt class="descname">on_kill_focus</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_kill_focus"><span class="viewcode-link">[source]</span></a></dt>
3238<dd><p>The  derivative class is on unfocus if implemented</p>
3239</dd></dl>
3240
3241<dl class="method">
3242<dt id="sas.guiframe.panel_base.PanelBase.on_paste">
3243<tt class="descname">on_paste</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_paste"><span class="viewcode-link">[source]</span></a></dt>
3244<dd><p>The paste action if possible</p>
3245</dd></dl>
3246
3247<dl class="method">
3248<dt id="sas.guiframe.panel_base.PanelBase.on_preview">
3249<tt class="descname">on_preview</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_preview"><span class="viewcode-link">[source]</span></a></dt>
3250<dd><p>Display a printable version of the class derivative</p>
3251</dd></dl>
3252
3253<dl class="method">
3254<dt id="sas.guiframe.panel_base.PanelBase.on_redo">
3255<tt class="descname">on_redo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_redo"><span class="viewcode-link">[source]</span></a></dt>
3256<dd><p>The previous action is restored if possible</p>
3257</dd></dl>
3258
3259<dl class="method">
3260<dt id="sas.guiframe.panel_base.PanelBase.on_reset">
3261<tt class="descname">on_reset</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_reset"><span class="viewcode-link">[source]</span></a></dt>
3262<dd><p>The derivative class state is restored</p>
3263</dd></dl>
3264
3265<dl class="method">
3266<dt id="sas.guiframe.panel_base.PanelBase.on_save">
3267<tt class="descname">on_save</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_save"><span class="viewcode-link">[source]</span></a></dt>
3268<dd><p>The state of the derivative class is restored</p>
3269</dd></dl>
3270
3271<dl class="method">
3272<dt id="sas.guiframe.panel_base.PanelBase.on_set_focus">
3273<tt class="descname">on_set_focus</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_set_focus"><span class="viewcode-link">[source]</span></a></dt>
3274<dd><p>The  derivative class is on focus if implemented</p>
3275</dd></dl>
3276
3277<dl class="method">
3278<dt id="sas.guiframe.panel_base.PanelBase.on_tap_focus">
3279<tt class="descname">on_tap_focus</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_tap_focus"><span class="viewcode-link">[source]</span></a></dt>
3280<dd><p>Update menu on clicking the panel tap</p>
3281</dd></dl>
3282
3283<dl class="method">
3284<dt id="sas.guiframe.panel_base.PanelBase.on_undo">
3285<tt class="descname">on_undo</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_undo"><span class="viewcode-link">[source]</span></a></dt>
3286<dd><p>The current action is canceled</p>
3287</dd></dl>
3288
3289<dl class="method">
3290<dt id="sas.guiframe.panel_base.PanelBase.on_zoom">
3291<tt class="descname">on_zoom</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_zoom"><span class="viewcode-link">[source]</span></a></dt>
3292<dd><p>The derivative class is on zoom mode (using pane)
3293if zoom mode is implemented</p>
3294</dd></dl>
3295
3296<dl class="method">
3297<dt id="sas.guiframe.panel_base.PanelBase.on_zoom_in">
3298<tt class="descname">on_zoom_in</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_zoom_in"><span class="viewcode-link">[source]</span></a></dt>
3299<dd><p>The derivative class is on zoom in mode if implemented</p>
3300</dd></dl>
3301
3302<dl class="method">
3303<dt id="sas.guiframe.panel_base.PanelBase.on_zoom_out">
3304<tt class="descname">on_zoom_out</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.on_zoom_out"><span class="viewcode-link">[source]</span></a></dt>
3305<dd><p>The derivative class is on zoom out mode if implemented</p>
3306</dd></dl>
3307
3308<dl class="method">
3309<dt id="sas.guiframe.panel_base.PanelBase.save_project">
3310<tt class="descname">save_project</tt><big>(</big><em>doc=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.save_project"><span class="viewcode-link">[source]</span></a></dt>
3311<dd><dl class="docutils">
3312<dt>return an xml node containing state of the panel</dt>
3313<dd>that guiframe can write to file</dd>
3314</dl>
3315</dd></dl>
3316
3317<dl class="method">
3318<dt id="sas.guiframe.panel_base.PanelBase.set_manager">
3319<tt class="descname">set_manager</tt><big>(</big><em>manager</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/panel_base.html#PanelBase.set_manager"><span class="viewcode-link">[source]</span></a></dt>
3320<dd></dd></dl>
3321
3322<dl class="attribute">
3323<dt id="sas.guiframe.panel_base.PanelBase.uid">
3324<tt class="descname">uid</tt><em class="property"> = None</em></dt>
3325<dd></dd></dl>
3326
3327</dd></dl>
3328
3329</div>
3330<div class="section" id="module-sas.guiframe.pdfview">
3331<span id="sas-guiframe-pdfview-module"></span><h2>sas.guiframe.pdfview module</h2>
3332<dl class="class">
3333<dt id="sas.guiframe.pdfview.PDFFrame">
3334<em class="property">class </em><tt class="descclassname">sas.guiframe.pdfview.</tt><tt class="descname">PDFFrame</tt><big>(</big><em>parent</em>, <em>id</em>, <em>title</em>, <em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#PDFFrame"><span class="viewcode-link">[source]</span></a></dt>
3335<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
3336<p>Frame for PDF panel</p>
3337</dd></dl>
3338
3339<dl class="class">
3340<dt id="sas.guiframe.pdfview.PDFPanel">
3341<em class="property">class </em><tt class="descclassname">sas.guiframe.pdfview.</tt><tt class="descname">PDFPanel</tt><big>(</big><em>parent</em>, <em>path=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#PDFPanel"><span class="viewcode-link">[source]</span></a></dt>
3342<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Panel</span></tt></p>
3343<p>Panel that contains the pdf reader</p>
3344<dl class="method">
3345<dt id="sas.guiframe.pdfview.PDFPanel.OnClose">
3346<tt class="descname">OnClose</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#PDFPanel.OnClose"><span class="viewcode-link">[source]</span></a></dt>
3347<dd><p>Close panel</p>
3348</dd></dl>
3349
3350<dl class="method">
3351<dt id="sas.guiframe.pdfview.PDFPanel.OnLoad">
3352<tt class="descname">OnLoad</tt><big>(</big><em>event=None</em>, <em>path=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#PDFPanel.OnLoad"><span class="viewcode-link">[source]</span></a></dt>
3353<dd><p>Load a pdf file</p>
3354<p>: Param path: full path to the file</p>
3355</dd></dl>
3356
3357<dl class="method">
3358<dt id="sas.guiframe.pdfview.PDFPanel.OnNextPageButton">
3359<tt class="descname">OnNextPageButton</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#PDFPanel.OnNextPageButton"><span class="viewcode-link">[source]</span></a></dt>
3360<dd><p>Goes to Next page</p>
3361</dd></dl>
3362
3363<dl class="method">
3364<dt id="sas.guiframe.pdfview.PDFPanel.OnOpenButton">
3365<tt class="descname">OnOpenButton</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#PDFPanel.OnOpenButton"><span class="viewcode-link">[source]</span></a></dt>
3366<dd><p>Open file button</p>
3367</dd></dl>
3368
3369<dl class="method">
3370<dt id="sas.guiframe.pdfview.PDFPanel.OnPrevPageButton">
3371<tt class="descname">OnPrevPageButton</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#PDFPanel.OnPrevPageButton"><span class="viewcode-link">[source]</span></a></dt>
3372<dd><p>Goes to Previous page</p>
3373</dd></dl>
3374
3375</dd></dl>
3376
3377<dl class="class">
3378<dt id="sas.guiframe.pdfview.TextFrame">
3379<em class="property">class </em><tt class="descclassname">sas.guiframe.pdfview.</tt><tt class="descname">TextFrame</tt><big>(</big><em>parent</em>, <em>id</em>, <em>title</em>, <em>text</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#TextFrame"><span class="viewcode-link">[source]</span></a></dt>
3380<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
3381<p>Frame for PDF panel</p>
3382</dd></dl>
3383
3384<dl class="class">
3385<dt id="sas.guiframe.pdfview.TextPanel">
3386<em class="property">class </em><tt class="descclassname">sas.guiframe.pdfview.</tt><tt class="descname">TextPanel</tt><big>(</big><em>parent</em>, <em>text=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#TextPanel"><span class="viewcode-link">[source]</span></a></dt>
3387<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.scrolledpanel.ScrolledPanel</span></tt></p>
3388<p>Panel that contains the text</p>
3389<dl class="method">
3390<dt id="sas.guiframe.pdfview.TextPanel.OnClose">
3391<tt class="descname">OnClose</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#TextPanel.OnClose"><span class="viewcode-link">[source]</span></a></dt>
3392<dd><p>Close panel</p>
3393</dd></dl>
3394
3395</dd></dl>
3396
3397<dl class="class">
3398<dt id="sas.guiframe.pdfview.ViewApp">
3399<em class="property">class </em><tt class="descclassname">sas.guiframe.pdfview.</tt><tt class="descname">ViewApp</tt><big>(</big><em>redirect=False</em>, <em>filename=None</em>, <em>useBestVisual=False</em>, <em>clearSigInt=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#ViewApp"><span class="viewcode-link">[source]</span></a></dt>
3400<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.App</span></tt></p>
3401<dl class="method">
3402<dt id="sas.guiframe.pdfview.ViewApp.OnInit">
3403<tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/pdfview.html#ViewApp.OnInit"><span class="viewcode-link">[source]</span></a></dt>
3404<dd></dd></dl>
3405
3406</dd></dl>
3407
3408</div>
3409<div class="section" id="module-sas.guiframe.plugin_base">
3410<span id="sas-guiframe-plugin-base-module"></span><h2>sas.guiframe.plugin_base module</h2>
3411<dl class="class">
3412<dt id="sas.guiframe.plugin_base.PluginBase">
3413<em class="property">class </em><tt class="descclassname">sas.guiframe.plugin_base.</tt><tt class="descname">PluginBase</tt><big>(</big><em>name='Test_plugin'</em>, <em>standalone=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase"><span class="viewcode-link">[source]</span></a></dt>
3414<dd><p>This class defines the interface for a Plugin class
3415that can be used by the gui_manager.</p>
3416<p>Plug-ins should be placed in a sub-directory called &#8220;perspectives&#8221;.
3417For example, a plug-in called Foo should be place in &#8220;perspectives/Foo&#8221;.
3418That directory contains at least two files:</p>
3419<ol class="arabic">
3420<li><p class="first">perspectives/Foo/__init__.py contains two lines:</p>
3421<div class="highlight-python"><div class="highlight"><pre><span class="n">PLUGIN_ID</span> <span class="o">=</span> <span class="s">&quot;Foo plug-in 1.0&quot;</span>
3422<span class="kn">from</span> <span class="nn">Foo</span> <span class="kn">import</span> <span class="o">*</span>
3423</pre></div>
3424</div>
3425</li>
3426<li><p class="first">perspectives/Foo/Foo.py contains the definition of the Plugin
3427class for the Foo plug-in. The interface of that Plugin class
3428should follow the interface of the class you are looking at.</p>
3429</li>
3430</ol>
3431<p>See dummyapp.py for a plugin example.</p>
3432<dl class="method">
3433<dt id="sas.guiframe.plugin_base.PluginBase.add_color">
3434<tt class="descname">add_color</tt><big>(</big><em>color</em>, <em>id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.add_color"><span class="viewcode-link">[source]</span></a></dt>
3435<dd><p>Adds color to a plugin</p>
3436</dd></dl>
3437
3438<dl class="method">
3439<dt id="sas.guiframe.plugin_base.PluginBase.can_load_data">
3440<tt class="descname">can_load_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.can_load_data"><span class="viewcode-link">[source]</span></a></dt>
3441<dd><p>if return True, then call handler to laod data</p>
3442</dd></dl>
3443
3444<dl class="method">
3445<dt id="sas.guiframe.plugin_base.PluginBase.clear_panel">
3446<tt class="descname">clear_panel</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.clear_panel"><span class="viewcode-link">[source]</span></a></dt>
3447<dd><p>clear all related panels</p>
3448</dd></dl>
3449
3450<dl class="method">
3451<dt id="sas.guiframe.plugin_base.PluginBase.delete_data">
3452<tt class="descname">delete_data</tt><big>(</big><em>data_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.delete_data"><span class="viewcode-link">[source]</span></a></dt>
3453<dd><p>Delete all references of data which id are in data_list.</p>
3454</dd></dl>
3455
3456<dl class="method">
3457<dt id="sas.guiframe.plugin_base.PluginBase.get_batch_capable">
3458<tt class="descname">get_batch_capable</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.get_batch_capable"><span class="viewcode-link">[source]</span></a></dt>
3459<dd><p>Check if the plugin has a batch capability</p>
3460</dd></dl>
3461
3462<dl class="method">
3463<dt id="sas.guiframe.plugin_base.PluginBase.get_context_menu">
3464<tt class="descname">get_context_menu</tt><big>(</big><em>plotpanel=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.get_context_menu"><span class="viewcode-link">[source]</span></a></dt>
3465<dd><p>This method is optional.</p>
3466<p>When the context menu of a plot is rendered, the
3467get_context_menu method will be called to give you a
3468chance to add a menu item to the context menu.</p>
3469<p>A ref to a plotpanel object is passed so that you can
3470investigate the plot content and decide whether you
3471need to add items to the context menu.</p>
3472<p>This method returns a list of menu items.
3473Each item is itself a list defining the text to
3474appear in the menu, a tool-tip help text, and a
3475call-back method.</p>
3476<table class="docutils field-list" frame="void" rules="none">
3477<col class="field-name" />
3478<col class="field-body" />
3479<tbody valign="top">
3480<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>graph</strong> &#8211; the Graph object to which we attach the context menu</td>
3481</tr>
3482<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of menu items with call-back function</td>
3483</tr>
3484</tbody>
3485</table>
3486</dd></dl>
3487
3488<dl class="method">
3489<dt id="sas.guiframe.plugin_base.PluginBase.get_extensions">
3490<tt class="descname">get_extensions</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.get_extensions"><span class="viewcode-link">[source]</span></a></dt>
3491<dd><p>return state reader and its extensions</p>
3492</dd></dl>
3493
3494<dl class="method">
3495<dt id="sas.guiframe.plugin_base.PluginBase.get_frame">
3496<tt class="descname">get_frame</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.get_frame"><span class="viewcode-link">[source]</span></a></dt>
3497<dd><p>Returns MDIChildFrame</p>
3498</dd></dl>
3499
3500<dl class="method">
3501<dt id="sas.guiframe.plugin_base.PluginBase.get_panels">
3502<tt class="descname">get_panels</tt><big>(</big><em>parent</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.get_panels"><span class="viewcode-link">[source]</span></a></dt>
3503<dd><p>Create and return the list of wx.Panels for your plug-in.
3504Define the plug-in perspective.</p>
3505<p>Panels should inherit from DefaultPanel defined below,
3506or should present the same interface. They must define
3507&#8220;window_caption&#8221; and &#8220;window_name&#8221;.</p>
3508<table class="docutils field-list" frame="void" rules="none">
3509<col class="field-name" />
3510<col class="field-body" />
3511<tbody valign="top">
3512<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> &#8211; parent window</td>
3513</tr>
3514<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of panels</td>
3515</tr>
3516</tbody>
3517</table>
3518</dd></dl>
3519
3520<dl class="method">
3521<dt id="sas.guiframe.plugin_base.PluginBase.get_perspective">
3522<tt class="descname">get_perspective</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.get_perspective"><span class="viewcode-link">[source]</span></a></dt>
3523<dd><p>Get the list of panel names for this perspective</p>
3524</dd></dl>
3525
3526<dl class="method">
3527<dt id="sas.guiframe.plugin_base.PluginBase.get_tools">
3528<tt class="descname">get_tools</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.get_tools"><span class="viewcode-link">[source]</span></a></dt>
3529<dd><p>Returns a set of menu entries for tools</p>
3530</dd></dl>
3531
3532<dl class="method">
3533<dt id="sas.guiframe.plugin_base.PluginBase.is_always_active">
3534<tt class="descname">is_always_active</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.is_always_active"><span class="viewcode-link">[source]</span></a></dt>
3535<dd><p>return True is this plugin is always active and it is local to guiframe
3536even if the user is switching between perspectives</p>
3537</dd></dl>
3538
3539<dl class="method">
3540<dt id="sas.guiframe.plugin_base.PluginBase.is_in_use">
3541<tt class="descname">is_in_use</tt><big>(</big><em>data_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.is_in_use"><span class="viewcode-link">[source]</span></a></dt>
3542<dd><dl class="docutils">
3543<dt>get a  data id a list of data name if data data is</dt>
3544<dd>currently used by the plugin and the name of the plugin</dd>
3545</dl>
3546<p>data_name = &#8216;None&#8217;
3547in_use = False
3548example [(data_name, self.sub_menu)]</p>
3549</dd></dl>
3550
3551<dl class="method">
3552<dt id="sas.guiframe.plugin_base.PluginBase.load_data">
3553<tt class="descname">load_data</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.load_data"><span class="viewcode-link">[source]</span></a></dt>
3554<dd><p>Load  data</p>
3555</dd></dl>
3556
3557<dl class="method">
3558<dt id="sas.guiframe.plugin_base.PluginBase.load_folder">
3559<tt class="descname">load_folder</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.load_folder"><span class="viewcode-link">[source]</span></a></dt>
3560<dd><p>Load entire folder</p>
3561</dd></dl>
3562
3563<dl class="method">
3564<dt id="sas.guiframe.plugin_base.PluginBase.on_batch_selection">
3565<tt class="descname">on_batch_selection</tt><big>(</big><em>flag</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.on_batch_selection"><span class="viewcode-link">[source]</span></a></dt>
3566<dd><p>need to be overwritten by the derivated class</p>
3567</dd></dl>
3568
3569<dl class="method">
3570<dt id="sas.guiframe.plugin_base.PluginBase.on_perspective">
3571<tt class="descname">on_perspective</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.on_perspective"><span class="viewcode-link">[source]</span></a></dt>
3572<dd><p>Call back function for the perspective menu item.
3573We notify the parent window that the perspective
3574has changed.</p>
3575<table class="docutils field-list" frame="void" rules="none">
3576<col class="field-name" />
3577<col class="field-body" />
3578<tbody valign="top">
3579<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; menu event</td>
3580</tr>
3581</tbody>
3582</table>
3583</dd></dl>
3584
3585<dl class="method">
3586<dt id="sas.guiframe.plugin_base.PluginBase.on_set_state_helper">
3587<tt class="descname">on_set_state_helper</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.on_set_state_helper"><span class="viewcode-link">[source]</span></a></dt>
3588<dd><p>update state</p>
3589</dd></dl>
3590
3591<dl class="method">
3592<dt id="sas.guiframe.plugin_base.PluginBase.populate_file_menu">
3593<tt class="descname">populate_file_menu</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.populate_file_menu"><span class="viewcode-link">[source]</span></a></dt>
3594<dd><p>Append menu item under file menu item of the frame</p>
3595</dd></dl>
3596
3597<dl class="method">
3598<dt id="sas.guiframe.plugin_base.PluginBase.populate_menu">
3599<tt class="descname">populate_menu</tt><big>(</big><em>parent</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.populate_menu"><span class="viewcode-link">[source]</span></a></dt>
3600<dd><p>Create and return the list of application menu
3601items for the plug-in.</p>
3602<table class="docutils field-list" frame="void" rules="none">
3603<col class="field-name" />
3604<col class="field-body" />
3605<tbody valign="top">
3606<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> &#8211; parent window</td>
3607</tr>
3608<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">plug-in menu</td>
3609</tr>
3610</tbody>
3611</table>
3612</dd></dl>
3613
3614<dl class="method">
3615<dt id="sas.guiframe.plugin_base.PluginBase.post_init">
3616<tt class="descname">post_init</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.post_init"><span class="viewcode-link">[source]</span></a></dt>
3617<dd><p>Post initialization call back to close the loose ends</p>
3618</dd></dl>
3619
3620<dl class="method">
3621<dt id="sas.guiframe.plugin_base.PluginBase.set_batch_selection">
3622<tt class="descname">set_batch_selection</tt><big>(</big><em>flag</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.set_batch_selection"><span class="viewcode-link">[source]</span></a></dt>
3623<dd><p>the plugin to its batch state if flag is True</p>
3624</dd></dl>
3625
3626<dl class="method">
3627<dt id="sas.guiframe.plugin_base.PluginBase.set_data">
3628<tt class="descname">set_data</tt><big>(</big><em>data_list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.set_data"><span class="viewcode-link">[source]</span></a></dt>
3629<dd><p>receive a list of data and use it in the current perspective</p>
3630</dd></dl>
3631
3632<dl class="method">
3633<dt id="sas.guiframe.plugin_base.PluginBase.set_default_perspective">
3634<tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.set_default_perspective"><span class="viewcode-link">[source]</span></a></dt>
3635<dd><p>Call back method that True to notify the parent that the current plug-in
3636can be set as default  perspective.
3637when returning False, the plug-in is not candidate for an automatic
3638default perspective setting</p>
3639</dd></dl>
3640
3641<dl class="method">
3642<dt id="sas.guiframe.plugin_base.PluginBase.set_is_active">
3643<tt class="descname">set_is_active</tt><big>(</big><em>active=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.set_is_active"><span class="viewcode-link">[source]</span></a></dt>
3644<dd></dd></dl>
3645
3646<dl class="method">
3647<dt id="sas.guiframe.plugin_base.PluginBase.set_state">
3648<tt class="descname">set_state</tt><big>(</big><em>state=None</em>, <em>datainfo=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.set_state"><span class="viewcode-link">[source]</span></a></dt>
3649<dd><p>update state</p>
3650</dd></dl>
3651
3652<dl class="method">
3653<dt id="sas.guiframe.plugin_base.PluginBase.set_theory">
3654<tt class="descname">set_theory</tt><big>(</big><em>theory_list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.set_theory"><span class="viewcode-link">[source]</span></a></dt>
3655<dd><table class="docutils field-list" frame="void" rules="none">
3656<col class="field-name" />
3657<col class="field-body" />
3658<tbody valign="top">
3659<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>theory_list</strong> &#8211; list of information
3660related to available theory state</td>
3661</tr>
3662</tbody>
3663</table>
3664</dd></dl>
3665
3666<dl class="method">
3667<dt id="sas.guiframe.plugin_base.PluginBase.use_data">
3668<tt class="descname">use_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/plugin_base.html#PluginBase.use_data"><span class="viewcode-link">[source]</span></a></dt>
3669<dd><p>return True if these plugin use data</p>
3670</dd></dl>
3671
3672</dd></dl>
3673
3674</div>
3675<div class="section" id="module-sas.guiframe.startup_configuration">
3676<span id="sas-guiframe-startup-configuration-module"></span><h2>sas.guiframe.startup_configuration module</h2>
3677<dl class="data">
3678<dt id="sas.guiframe.startup_configuration.PANEL_HEIGHT">
3679<tt class="descclassname">sas.guiframe.startup_configuration.</tt><tt class="descname">PANEL_HEIGHT</tt><em class="property"> = 215</em></dt>
3680<dd><p>Dialog to set Appication startup configuration</p>
3681</dd></dl>
3682
3683<dl class="class">
3684<dt id="sas.guiframe.startup_configuration.StartupConfiguration">
3685<em class="property">class </em><tt class="descclassname">sas.guiframe.startup_configuration.</tt><tt class="descname">StartupConfiguration</tt><big>(</big><em>parent</em>, <em>gui</em>, <em>id=-1</em>, <em>title='Startup Setting'</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/startup_configuration.html#StartupConfiguration"><span class="viewcode-link">[source]</span></a></dt>
3686<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
3687<p>Dialog for Startup Configuration</p>
3688<dl class="method">
3689<dt id="sas.guiframe.startup_configuration.StartupConfiguration.OnCurrent">
3690<tt class="descname">OnCurrent</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/startup_configuration.html#StartupConfiguration.OnCurrent"><span class="viewcode-link">[source]</span></a></dt>
3691<dd><p>Set to curent setup</p>
3692</dd></dl>
3693
3694<dl class="method">
3695<dt id="sas.guiframe.startup_configuration.StartupConfiguration.OnDefault">
3696<tt class="descname">OnDefault</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/startup_configuration.html#StartupConfiguration.OnDefault"><span class="viewcode-link">[source]</span></a></dt>
3697<dd><p>Set to default</p>
3698</dd></dl>
3699
3700<dl class="method">
3701<dt id="sas.guiframe.startup_configuration.StartupConfiguration.write_custom_config">
3702<tt class="descname">write_custom_config</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/startup_configuration.html#StartupConfiguration.write_custom_config"><span class="viewcode-link">[source]</span></a></dt>
3703<dd><p>Write custom configuration</p>
3704</dd></dl>
3705
3706<dl class="method">
3707<dt id="sas.guiframe.startup_configuration.StartupConfiguration.write_string">
3708<tt class="descname">write_string</tt><big>(</big><em>fname</em>, <em>strings</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/startup_configuration.html#StartupConfiguration.write_string"><span class="viewcode-link">[source]</span></a></dt>
3709<dd><p>Write and Save file</p>
3710</dd></dl>
3711
3712</dd></dl>
3713
3714</div>
3715<div class="section" id="module-sas.guiframe.utils">
3716<span id="sas-guiframe-utils-module"></span><h2>sas.guiframe.utils module</h2>
3717<p>Contains common classes and functions</p>
3718<dl class="class">
3719<dt id="sas.guiframe.utils.PanelMenu">
3720<em class="property">class </em><tt class="descclassname">sas.guiframe.utils.</tt><tt class="descname">PanelMenu</tt><big>(</big><em>self</em>, <em>String title=EmptyString</em>, <em>long style=0</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#PanelMenu"><span class="viewcode-link">[source]</span></a></dt>
3721<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.Menu</span></tt></p>
3722<dl class="attribute">
3723<dt id="sas.guiframe.utils.PanelMenu.graph">
3724<tt class="descname">graph</tt><em class="property"> = None</em></dt>
3725<dd></dd></dl>
3726
3727<dl class="attribute">
3728<dt id="sas.guiframe.utils.PanelMenu.plots">
3729<tt class="descname">plots</tt><em class="property"> = None</em></dt>
3730<dd></dd></dl>
3731
3732<dl class="method">
3733<dt id="sas.guiframe.utils.PanelMenu.set_graph">
3734<tt class="descname">set_graph</tt><big>(</big><em>graph</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#PanelMenu.set_graph"><span class="viewcode-link">[source]</span></a></dt>
3735<dd></dd></dl>
3736
3737<dl class="method">
3738<dt id="sas.guiframe.utils.PanelMenu.set_plots">
3739<tt class="descname">set_plots</tt><big>(</big><em>plots</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#PanelMenu.set_plots"><span class="viewcode-link">[source]</span></a></dt>
3740<dd></dd></dl>
3741
3742</dd></dl>
3743
3744<dl class="function">
3745<dt id="sas.guiframe.utils.check_float">
3746<tt class="descclassname">sas.guiframe.utils.</tt><tt class="descname">check_float</tt><big>(</big><em>item</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#check_float"><span class="viewcode-link">[source]</span></a></dt>
3747<dd><table class="docutils field-list" frame="void" rules="none">
3748<col class="field-name" />
3749<col class="field-body" />
3750<tbody valign="top">
3751<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> &#8211; txtcrtl containing a value</td>
3752</tr>
3753</tbody>
3754</table>
3755</dd></dl>
3756
3757<dl class="function">
3758<dt id="sas.guiframe.utils.format_number">
3759<tt class="descclassname">sas.guiframe.utils.</tt><tt class="descname">format_number</tt><big>(</big><em>value</em>, <em>high=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#format_number"><span class="viewcode-link">[source]</span></a></dt>
3760<dd><p>Return a float in a standardized, human-readable formatted string</p>
3761</dd></dl>
3762
3763<dl class="function">
3764<dt id="sas.guiframe.utils.look_for_tag">
3765<tt class="descclassname">sas.guiframe.utils.</tt><tt class="descname">look_for_tag</tt><big>(</big><em>string1</em>, <em>begin</em>, <em>end=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#look_for_tag"><span class="viewcode-link">[source]</span></a></dt>
3766<dd><p>this method  remove the begin and end tags given by the user
3767from the string .</p>
3768<table class="docutils field-list" frame="void" rules="none">
3769<col class="field-name" />
3770<col class="field-body" />
3771<tbody valign="top">
3772<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
3773<li><strong>begin</strong> &#8211; the initial tag</li>
3774<li><strong>end</strong> &#8211; the final tag</li>
3775<li><strong>string</strong> &#8211; the string to check</li>
3776</ul>
3777</td>
3778</tr>
3779<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">begin_flag==True if begin was found,
3780end_flag==if end was found else return false, false</p>
3781</td>
3782</tr>
3783</tbody>
3784</table>
3785</dd></dl>
3786
3787<dl class="function">
3788<dt id="sas.guiframe.utils.parse_name">
3789<tt class="descclassname">sas.guiframe.utils.</tt><tt class="descname">parse_name</tt><big>(</big><em>name</em>, <em>expression</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#parse_name"><span class="viewcode-link">[source]</span></a></dt>
3790<dd><p>remove &#8220;_&#8221; in front of a name</p>
3791</dd></dl>
3792
3793<dl class="function">
3794<dt id="sas.guiframe.utils.split_list">
3795<tt class="descclassname">sas.guiframe.utils.</tt><tt class="descname">split_list</tt><big>(</big><em>separator</em>, <em>mylist</em>, <em>n=0</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#split_list"><span class="viewcode-link">[source]</span></a></dt>
3796<dd><p>returns a list of string without white space of separator</p>
3797<table class="docutils field-list" frame="void" rules="none">
3798<col class="field-name" />
3799<col class="field-body" />
3800<tbody valign="top">
3801<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>separator</strong> &#8211; the string to remove</td>
3802</tr>
3803</tbody>
3804</table>
3805</dd></dl>
3806
3807<dl class="function">
3808<dt id="sas.guiframe.utils.split_text">
3809<tt class="descclassname">sas.guiframe.utils.</tt><tt class="descname">split_text</tt><big>(</big><em>separator</em>, <em>string1</em>, <em>n=0</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/utils.html#split_text"><span class="viewcode-link">[source]</span></a></dt>
3810<dd><p>return a list of string without white space of separator</p>
3811<table class="docutils field-list" frame="void" rules="none">
3812<col class="field-name" />
3813<col class="field-body" />
3814<tbody valign="top">
3815<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>separator</strong> &#8211; the string to remove</td>
3816</tr>
3817</tbody>
3818</table>
3819</dd></dl>
3820
3821</div>
3822<div class="section" id="module-sas.guiframe">
3823<span id="module-contents"></span><h2>Module contents</h2>
3824<dl class="function">
3825<dt id="sas.guiframe.data_files">
3826<tt class="descclassname">sas.guiframe.</tt><tt class="descname">data_files</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe.html#data_files"><span class="viewcode-link">[source]</span></a></dt>
3827<dd><p>Return the data files associated with guiframe images .</p>
3828<p>The format is a list of (directory, [files...]) pairs which can be
3829used directly in setup(...,data_files=...) for setup.py.</p>
3830</dd></dl>
3831
3832<dl class="function">
3833<dt id="sas.guiframe.get_data_path">
3834<tt class="descclassname">sas.guiframe.</tt><tt class="descname">get_data_path</tt><big>(</big><em>media</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe.html#get_data_path"><span class="viewcode-link">[source]</span></a></dt>
3835<dd></dd></dl>
3836
3837<dl class="function">
3838<dt id="sas.guiframe.get_media_path">
3839<tt class="descclassname">sas.guiframe.</tt><tt class="descname">get_media_path</tt><big>(</big><em>media</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe.html#get_media_path"><span class="viewcode-link">[source]</span></a></dt>
3840<dd></dd></dl>
3841
3842</div>
3843</div>
3844
3845
3846          </div>
3847        </div>
3848      </div>
3849      <div class="sphinxsidebar">
3850        <div class="sphinxsidebarwrapper">
3851  <h3><a href="../../index.html">Table Of Contents</a></h3>
3852  <ul>
3853<li><a class="reference internal" href="#">sas.guiframe package</a><ul>
3854<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
3855<li><a class="reference internal" href="#submodules">Submodules</a></li>
3856<li><a class="reference internal" href="#module-sas.guiframe.CategoryInstaller">sas.guiframe.CategoryInstaller module</a></li>
3857<li><a class="reference internal" href="#module-sas.guiframe.CategoryManager">sas.guiframe.CategoryManager module</a></li>
3858<li><a class="reference internal" href="#module-sas.guiframe.aboutbox">sas.guiframe.aboutbox module</a></li>
3859<li><a class="reference internal" href="#module-sas.guiframe.config">sas.guiframe.config module</a></li>
3860<li><a class="reference internal" href="#module-sas.guiframe.custom_pstats">sas.guiframe.custom_pstats module</a></li>
3861<li><a class="reference internal" href="#module-sas.guiframe.customdir">sas.guiframe.customdir module</a></li>
3862<li><a class="reference internal" href="#module-sas.guiframe.dataFitting">sas.guiframe.dataFitting module</a></li>
3863<li><a class="reference internal" href="#module-sas.guiframe.data_manager">sas.guiframe.data_manager module</a></li>
3864<li><a class="reference internal" href="#module-sas.guiframe.data_panel">sas.guiframe.data_panel module</a></li>
3865<li><a class="reference internal" href="#module-sas.guiframe.data_processor">sas.guiframe.data_processor module</a></li>
3866<li><a class="reference internal" href="#module-sas.guiframe.data_state">sas.guiframe.data_state module</a></li>
3867<li><a class="reference internal" href="#module-sas.guiframe.documentation_window">sas.guiframe.documentation_window module</a></li>
3868<li><a class="reference internal" href="#module-sas.guiframe.dummyapp">sas.guiframe.dummyapp module</a></li>
3869<li><a class="reference internal" href="#module-sas.guiframe.events">sas.guiframe.events module</a></li>
3870<li><a class="reference internal" href="#module-sas.guiframe.gui_manager">sas.guiframe.gui_manager module</a></li>
3871<li><a class="reference internal" href="#module-sas.guiframe.gui_statusbar">sas.guiframe.gui_statusbar module</a></li>
3872<li><a class="reference internal" href="#module-sas.guiframe.gui_style">sas.guiframe.gui_style module</a></li>
3873<li><a class="reference internal" href="#module-sas.guiframe.gui_toolbar">sas.guiframe.gui_toolbar module</a></li>
3874<li><a class="reference internal" href="#module-sas.guiframe.panel_base">sas.guiframe.panel_base module</a></li>
3875<li><a class="reference internal" href="#module-sas.guiframe.pdfview">sas.guiframe.pdfview module</a></li>
3876<li><a class="reference internal" href="#module-sas.guiframe.plugin_base">sas.guiframe.plugin_base module</a></li>
3877<li><a class="reference internal" href="#module-sas.guiframe.startup_configuration">sas.guiframe.startup_configuration module</a></li>
3878<li><a class="reference internal" href="#module-sas.guiframe.utils">sas.guiframe.utils module</a></li>
3879<li><a class="reference internal" href="#module-sas.guiframe">Module contents</a></li>
3880</ul>
3881</li>
3882</ul>
3883
3884  <h4>Previous topic</h4>
3885  <p class="topless"><a href="sas.fit.html"
3886                        title="previous chapter">sas.fit package</a></p>
3887  <h4>Next topic</h4>
3888  <p class="topless"><a href="sas.guiframe.local_perspectives.html"
3889                        title="next chapter">sas.guiframe.local_perspectives package</a></p>
3890  <h3>This Page</h3>
3891  <ul class="this-page-menu">
3892    <li><a href="../../_sources/dev/api/sas.guiframe.txt"
3893           rel="nofollow">Show Source</a></li>
3894  </ul>
3895<div id="searchbox" style="display: none">
3896  <h3>Quick search</h3>
3897    <form class="search" action="../../search.html" method="get">
3898      <input type="text" name="q" />
3899      <input type="submit" value="Go" />
3900      <input type="hidden" name="check_keywords" value="yes" />
3901      <input type="hidden" name="area" value="default" />
3902    </form>
3903    <p class="searchtip" style="font-size: 90%">
3904    Enter search terms or a module, class or function name.
3905    </p>
3906</div>
3907<script type="text/javascript">$('#searchbox').show(0);</script>
3908        </div>
3909      </div>
3910      <div class="clearer"></div>
3911    </div>
3912    <div class="related">
3913      <h3>Navigation</h3>
3914      <ul>
3915        <li class="right" style="margin-right: 10px">
3916          <a href="../../genindex.html" title="General Index"
3917             >index</a></li>
3918        <li class="right" >
3919          <a href="../../py-modindex.html" title="Python Module Index"
3920             >modules</a> |</li>
3921        <li class="right" >
3922          <a href="sas.guiframe.local_perspectives.html" title="sas.guiframe.local_perspectives package"
3923             >next</a> |</li>
3924        <li class="right" >
3925          <a href="sas.fit.html" title="sas.fit package"
3926             >previous</a> |</li>
3927        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
3928          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
3929          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
3930          <li><a href="sas.html" >sas package</a> &raquo;</li> 
3931      </ul>
3932    </div>
3933    <div class="footer">
3934        &copy; Copyright 2013, The SasView Project.
3935      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
3936    </div>
3937  </body>
3938</html>
Note: See TracBrowser for help on using the repository browser.