source: sasview/dev/api/sas.sasview.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: 19.2 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.sasview 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="prev" title="sas.pr.core package" href="sas.pr.core.html" /> 
30  </head>
31  <body>
32    <div class="related">
33      <h3>Navigation</h3>
34      <ul>
35        <li class="right" style="margin-right: 10px">
36          <a href="../../genindex.html" title="General Index"
37             accesskey="I">index</a></li>
38        <li class="right" >
39          <a href="../../py-modindex.html" title="Python Module Index"
40             >modules</a> |</li>
41        <li class="right" >
42          <a href="sas.pr.core.html" title="sas.pr.core package"
43             accesskey="P">previous</a> |</li>
44        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
45          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
46          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
47          <li><a href="sas.html" accesskey="U">sas package</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="sas-sasview-package">
57<h1>sas.sasview package</h1>
58<div class="section" id="submodules">
59<h2>Submodules</h2>
60</div>
61<div class="section" id="module-sas.sasview.custom_config">
62<span id="sas-sasview-custom-config-module"></span><h2>sas.sasview.custom_config module</h2>
63<p>Application appearance custom configuration</p>
64</div>
65<div class="section" id="module-sas.sasview.installer_generator">
66<span id="sas-sasview-installer-generator-module"></span><h2>sas.sasview.installer_generator module</h2>
67<p>This module generates .iss file according to the local config of
68the current application. Please make sure a file named &#8220;local_config.py&#8221;
69exists in the current directory. Edit local_config.py according to your needs.</p>
70<dl class="function">
71<dt id="sas.sasview.installer_generator.find_extension">
72<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">find_extension</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#find_extension"><span class="viewcode-link">[source]</span></a></dt>
73<dd><p>Describe the extensions that can be read by the current application</p>
74</dd></dl>
75
76<dl class="function">
77<dt id="sas.sasview.installer_generator.generate_installer">
78<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">generate_installer</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#generate_installer"><span class="viewcode-link">[source]</span></a></dt>
79<dd></dd></dl>
80
81<dl class="function">
82<dt id="sas.sasview.installer_generator.write_code">
83<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_code</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_code"><span class="viewcode-link">[source]</span></a></dt>
84<dd><p>Code that checks the existing path and snaviewpath
85in the environmental viriables/PATH</p>
86</dd></dl>
87
88<dl class="function">
89<dt id="sas.sasview.installer_generator.write_dirs">
90<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_dirs</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_dirs"><span class="viewcode-link">[source]</span></a></dt>
91<dd><p>Define Dir permission</p>
92</dd></dl>
93
94<dl class="function">
95<dt id="sas.sasview.installer_generator.write_file">
96<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_file</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_file"><span class="viewcode-link">[source]</span></a></dt>
97<dd><p>copy some data files</p>
98</dd></dl>
99
100<dl class="function">
101<dt id="sas.sasview.installer_generator.write_icon">
102<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_icon</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_icon"><span class="viewcode-link">[source]</span></a></dt>
103<dd><p>Create application icon</p>
104</dd></dl>
105
106<dl class="function">
107<dt id="sas.sasview.installer_generator.write_language">
108<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_language</tt><big>(</big><em>language=['english'], msfile='compiler:Default.isl'</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_language"><span class="viewcode-link">[source]</span></a></dt>
109<dd><p>define the language of the application</p>
110</dd></dl>
111
112<dl class="function">
113<dt id="sas.sasview.installer_generator.write_registry">
114<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_registry</tt><big>(</big><em>data_extension=None</em>, <em>app_extension=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_registry"><span class="viewcode-link">[source]</span></a></dt>
115<dd><p>create file association for windows.
116Allow open file on double click</p>
117</dd></dl>
118
119<dl class="function">
120<dt id="sas.sasview.installer_generator.write_run">
121<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_run</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_run"><span class="viewcode-link">[source]</span></a></dt>
122<dd><p>execute some file</p>
123</dd></dl>
124
125<dl class="function">
126<dt id="sas.sasview.installer_generator.write_tasks">
127<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_tasks</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_tasks"><span class="viewcode-link">[source]</span></a></dt>
128<dd><p>create desktop icon</p>
129</dd></dl>
130
131<dl class="function">
132<dt id="sas.sasview.installer_generator.write_uninstalldelete">
133<tt class="descclassname">sas.sasview.installer_generator.</tt><tt class="descname">write_uninstalldelete</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/installer_generator.html#write_uninstalldelete"><span class="viewcode-link">[source]</span></a></dt>
134<dd><p>Define uninstalldelete</p>
135</dd></dl>
136
137</div>
138<div class="section" id="module-sas.sasview.local_config">
139<span id="sas-sasview-local-config-module"></span><h2>sas.sasview.local_config module</h2>
140<p>Application settings</p>
141<dl class="function">
142<dt id="sas.sasview.local_config.printEVT">
143<tt class="descclassname">sas.sasview.local_config.</tt><tt class="descname">printEVT</tt><big>(</big><em>message</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/local_config.html#printEVT"><span class="viewcode-link">[source]</span></a></dt>
144<dd></dd></dl>
145
146</div>
147<div class="section" id="module-sas.sasview.sasview">
148<span id="sas-sasview-sasview-module"></span><h2>sas.sasview.sasview module</h2>
149<dl class="class">
150<dt id="sas.sasview.sasview.SasView">
151<em class="property">class </em><tt class="descclassname">sas.sasview.sasview.</tt><tt class="descname">SasView</tt><a class="reference internal" href="../../_modules/sas/sasview/sasview.html#SasView"><span class="viewcode-link">[source]</span></a></dt>
152<dd></dd></dl>
153
154<dl class="class">
155<dt id="sas.sasview.sasview.SasViewApp">
156<em class="property">class </em><tt class="descclassname">sas.sasview.sasview.</tt><tt class="descname">SasViewApp</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/sasview/sasview.html#SasViewApp"><span class="viewcode-link">[source]</span></a></dt>
157<dd><p>Bases: <a class="reference internal" href="sas.guiframe.html#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>
158</dd></dl>
159
160<dl class="function">
161<dt id="sas.sasview.sasview.run">
162<tt class="descclassname">sas.sasview.sasview.</tt><tt class="descname">run</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/sasview.html#run"><span class="viewcode-link">[source]</span></a></dt>
163<dd></dd></dl>
164
165</div>
166<div class="section" id="sas-sasview-setup-exe-module">
167<h2>sas.sasview.setup_exe module</h2>
168</div>
169<div class="section" id="sas-sasview-setup-mac-module">
170<h2>sas.sasview.setup_mac module</h2>
171</div>
172<div class="section" id="module-sas.sasview.welcome_panel">
173<span id="sas-sasview-welcome-panel-module"></span><h2>sas.sasview.welcome_panel module</h2>
174<p>Welcome page</p>
175<dl class="class">
176<dt id="sas.sasview.welcome_panel.ViewApp">
177<em class="property">class </em><tt class="descclassname">sas.sasview.welcome_panel.</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/sasview/welcome_panel.html#ViewApp"><span class="viewcode-link">[source]</span></a></dt>
178<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.App</span></tt></p>
179<p>Test application</p>
180<dl class="method">
181<dt id="sas.sasview.welcome_panel.ViewApp.OnInit">
182<tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#ViewApp.OnInit"><span class="viewcode-link">[source]</span></a></dt>
183<dd></dd></dl>
184
185</dd></dl>
186
187<dl class="class">
188<dt id="sas.sasview.welcome_panel.WelcomeFrame">
189<em class="property">class </em><tt class="descclassname">sas.sasview.welcome_panel.</tt><tt class="descname">WelcomeFrame</tt><big>(</big><em>parent</em>, <em>id</em>, <em>title</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomeFrame"><span class="viewcode-link">[source]</span></a></dt>
190<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
191<p>Test frame</p>
192</dd></dl>
193
194<dl class="class">
195<dt id="sas.sasview.welcome_panel.WelcomePage">
196<em class="property">class </em><tt class="descclassname">sas.sasview.welcome_panel.</tt><tt class="descname">WelcomePage</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomePage"><span class="viewcode-link">[source]</span></a></dt>
197<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.scrolledpanel.ScrolledPanel</span></tt></p>
198<p>Panel created like about box  as a welcome page
199Shows product name, current version, authors, and link to the product page.</p>
200<dl class="attribute">
201<dt id="sas.sasview.welcome_panel.WelcomePage.CENTER_PANE">
202<tt class="descname">CENTER_PANE</tt><em class="property"> = True</em></dt>
203<dd></dd></dl>
204
205<dl class="method">
206<dt id="sas.sasview.welcome_panel.WelcomePage.set_data">
207<tt class="descname">set_data</tt><big>(</big><em>list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomePage.set_data"><span class="viewcode-link">[source]</span></a></dt>
208<dd></dd></dl>
209
210<dl class="attribute">
211<dt id="sas.sasview.welcome_panel.WelcomePage.window_caption">
212<tt class="descname">window_caption</tt><em class="property"> = 'Welcome panel'</em></dt>
213<dd></dd></dl>
214
215<dl class="attribute">
216<dt id="sas.sasview.welcome_panel.WelcomePage.window_name">
217<tt class="descname">window_name</tt><em class="property"> = 'default'</em></dt>
218<dd></dd></dl>
219
220</dd></dl>
221
222<dl class="class">
223<dt id="sas.sasview.welcome_panel.WelcomePanel">
224<em class="property">class </em><tt class="descclassname">sas.sasview.welcome_panel.</tt><tt class="descname">WelcomePanel</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomePanel"><span class="viewcode-link">[source]</span></a></dt>
225<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.html#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>
226<p>Panel created like about box  as a welcome page
227Shows product name, current version, authors, and link to the product page.</p>
228<dl class="attribute">
229<dt id="sas.sasview.welcome_panel.WelcomePanel.CENTER_PANE">
230<tt class="descname">CENTER_PANE</tt><em class="property"> = True</em></dt>
231<dd></dd></dl>
232
233<dl class="method">
234<dt id="sas.sasview.welcome_panel.WelcomePanel.get_frame">
235<tt class="descname">get_frame</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomePanel.get_frame"><span class="viewcode-link">[source]</span></a></dt>
236<dd></dd></dl>
237
238<dl class="method">
239<dt id="sas.sasview.welcome_panel.WelcomePanel.on_close_page">
240<tt class="descname">on_close_page</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomePanel.on_close_page"><span class="viewcode-link">[source]</span></a></dt>
241<dd></dd></dl>
242
243<dl class="method">
244<dt id="sas.sasview.welcome_panel.WelcomePanel.set_data">
245<tt class="descname">set_data</tt><big>(</big><em>list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomePanel.set_data"><span class="viewcode-link">[source]</span></a></dt>
246<dd></dd></dl>
247
248<dl class="method">
249<dt id="sas.sasview.welcome_panel.WelcomePanel.set_frame">
250<tt class="descname">set_frame</tt><big>(</big><em>frame</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomePanel.set_frame"><span class="viewcode-link">[source]</span></a></dt>
251<dd></dd></dl>
252
253<dl class="method">
254<dt id="sas.sasview.welcome_panel.WelcomePanel.set_manager">
255<tt class="descname">set_manager</tt><big>(</big><em>manager</em><big>)</big><a class="reference internal" href="../../_modules/sas/sasview/welcome_panel.html#WelcomePanel.set_manager"><span class="viewcode-link">[source]</span></a></dt>
256<dd><p>the manager of the panel in this case the application itself</p>
257</dd></dl>
258
259<dl class="attribute">
260<dt id="sas.sasview.welcome_panel.WelcomePanel.window_caption">
261<tt class="descname">window_caption</tt><em class="property"> = 'Welcome panel'</em></dt>
262<dd></dd></dl>
263
264<dl class="attribute">
265<dt id="sas.sasview.welcome_panel.WelcomePanel.window_name">
266<tt class="descname">window_name</tt><em class="property"> = 'default'</em></dt>
267<dd></dd></dl>
268
269</dd></dl>
270
271</div>
272<div class="section" id="module-sas.sasview">
273<span id="module-contents"></span><h2>Module contents</h2>
274</div>
275</div>
276
277
278          </div>
279        </div>
280      </div>
281      <div class="sphinxsidebar">
282        <div class="sphinxsidebarwrapper">
283  <h3><a href="../../index.html">Table Of Contents</a></h3>
284  <ul>
285<li><a class="reference internal" href="#">sas.sasview package</a><ul>
286<li><a class="reference internal" href="#submodules">Submodules</a></li>
287<li><a class="reference internal" href="#module-sas.sasview.custom_config">sas.sasview.custom_config module</a></li>
288<li><a class="reference internal" href="#module-sas.sasview.installer_generator">sas.sasview.installer_generator module</a></li>
289<li><a class="reference internal" href="#module-sas.sasview.local_config">sas.sasview.local_config module</a></li>
290<li><a class="reference internal" href="#module-sas.sasview.sasview">sas.sasview.sasview module</a></li>
291<li><a class="reference internal" href="#sas-sasview-setup-exe-module">sas.sasview.setup_exe module</a></li>
292<li><a class="reference internal" href="#sas-sasview-setup-mac-module">sas.sasview.setup_mac module</a></li>
293<li><a class="reference internal" href="#module-sas.sasview.welcome_panel">sas.sasview.welcome_panel module</a></li>
294<li><a class="reference internal" href="#module-sas.sasview">Module contents</a></li>
295</ul>
296</li>
297</ul>
298
299  <h4>Previous topic</h4>
300  <p class="topless"><a href="sas.pr.core.html"
301                        title="previous chapter">sas.pr.core package</a></p>
302  <h3>This Page</h3>
303  <ul class="this-page-menu">
304    <li><a href="../../_sources/dev/api/sas.sasview.txt"
305           rel="nofollow">Show Source</a></li>
306  </ul>
307<div id="searchbox" style="display: none">
308  <h3>Quick search</h3>
309    <form class="search" action="../../search.html" method="get">
310      <input type="text" name="q" />
311      <input type="submit" value="Go" />
312      <input type="hidden" name="check_keywords" value="yes" />
313      <input type="hidden" name="area" value="default" />
314    </form>
315    <p class="searchtip" style="font-size: 90%">
316    Enter search terms or a module, class or function name.
317    </p>
318</div>
319<script type="text/javascript">$('#searchbox').show(0);</script>
320        </div>
321      </div>
322      <div class="clearer"></div>
323    </div>
324    <div class="related">
325      <h3>Navigation</h3>
326      <ul>
327        <li class="right" style="margin-right: 10px">
328          <a href="../../genindex.html" title="General Index"
329             >index</a></li>
330        <li class="right" >
331          <a href="../../py-modindex.html" title="Python Module Index"
332             >modules</a> |</li>
333        <li class="right" >
334          <a href="sas.pr.core.html" title="sas.pr.core package"
335             >previous</a> |</li>
336        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
337          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
338          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
339          <li><a href="sas.html" >sas package</a> &raquo;</li> 
340      </ul>
341    </div>
342    <div class="footer">
343        &copy; Copyright 2013, The SasView Project.
344      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
345    </div>
346  </body>
347</html>
Note: See TracBrowser for help on using the repository browser.