source: sasview/_modules/sas/guiframe/dummyapp.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: 15.7 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.dummyapp &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.guiframe" href="../guiframe.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../../../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../../../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
41          <li><a href="../../index.html" >Module code</a> &raquo;</li>
42          <li><a href="../guiframe.html" accesskey="U">sas.guiframe</a> &raquo;</li> 
43      </ul>
44    </div> 
45
46    <div class="document">
47      <div class="documentwrapper">
48        <div class="bodywrapper">
49          <div class="body">
50           
51  <h1>Source code for sas.guiframe.dummyapp</h1><div class="highlight"><pre>
52<span class="sd">&quot;&quot;&quot;</span>
53<span class="sd">Dummy application.</span>
54<span class="sd">Allows the user to set an external data manager</span>
55<span class="sd">&quot;&quot;&quot;</span>
56<span class="kn">import</span> <span class="nn">sas.guiframe.gui_manager</span> <span class="kn">as</span> <span class="nn">gui_manager</span>
57
58<span class="kn">from</span> <span class="nn">sas.guiframe.plugin_base</span> <span class="kn">import</span> <span class="n">PluginBase</span>
59
60<div class="viewcode-block" id="DummyView"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.dummyapp.DummyView">[docs]</a><span class="k">class</span> <span class="nc">DummyView</span><span class="p">(</span><span class="n">gui_manager</span><span class="o">.</span><span class="n">ViewApp</span><span class="p">):</span>
61    <span class="sd">&quot;&quot;&quot;</span>
62<span class="sd">    &quot;&quot;&quot;</span>
63    </div>
64<div class="viewcode-block" id="TestPlugin"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.dummyapp.TestPlugin">[docs]</a><span class="k">class</span> <span class="nc">TestPlugin</span><span class="p">(</span><span class="n">PluginBase</span><span class="p">):</span>
65   
66<div class="viewcode-block" id="TestPlugin.populate_menu"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.dummyapp.TestPlugin.populate_menu">[docs]</a>    <span class="k">def</span> <span class="nf">populate_menu</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
67        <span class="sd">&quot;&quot;&quot;</span>
68<span class="sd">        Create and return the list of application menu</span>
69<span class="sd">        items for the plug-in. </span>
70<span class="sd">        :param parent: parent window</span>
71<span class="sd">        </span>
72<span class="sd">        :return: plug-in menu</span>
73<span class="sd">        </span>
74<span class="sd">        &quot;&quot;&quot;</span>
75        <span class="kn">import</span> <span class="nn">wx</span>
76        <span class="c"># Create a menu</span>
77        <span class="n">plug_menu</span> <span class="o">=</span> <span class="n">wx</span><span class="o">.</span><span class="n">Menu</span><span class="p">()</span>
78
79        <span class="c"># Always get event IDs from wx</span>
80        <span class="nb">id</span> <span class="o">=</span> <span class="n">wx</span><span class="o">.</span><span class="n">NewId</span><span class="p">()</span>
81       
82        <span class="c"># Fill your menu</span>
83        <span class="n">plug_menu</span><span class="o">.</span><span class="n">Append</span><span class="p">(</span><span class="nb">id</span><span class="p">,</span> <span class="s">&#39;&amp;Do something&#39;</span><span class="p">)</span>
84        <span class="k">def</span> <span class="nf">_on_do_something</span><span class="p">(</span><span class="n">event</span><span class="p">):</span>
85            <span class="k">print</span> <span class="s">&quot;Do something&quot;</span>
86        <span class="n">wx</span><span class="o">.</span><span class="n">EVT_MENU</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">_on_do_something</span><span class="p">)</span>
87   
88        <span class="c"># Returns the menu and a name for it.</span>
89        <span class="k">return</span> <span class="p">[(</span><span class="n">plug_menu</span><span class="p">,</span> <span class="s">&quot;DummyApp&quot;</span><span class="p">)]</span>   
90    </div>
91<div class="viewcode-block" id="TestPlugin.get_panels"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.dummyapp.TestPlugin.get_panels">[docs]</a>    <span class="k">def</span> <span class="nf">get_panels</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">):</span>
92        <span class="sd">&quot;&quot;&quot;</span>
93<span class="sd">        Create and return the list of wx.Panels for your plug-in.</span>
94<span class="sd">        Define the plug-in perspective.</span>
95<span class="sd">        </span>
96<span class="sd">        Panels should inherit from DefaultPanel defined below,</span>
97<span class="sd">        or should present the same interface. They must define</span>
98<span class="sd">        &quot;window_caption&quot; and &quot;window_name&quot;.</span>
99<span class="sd">        </span>
100<span class="sd">        :param parent: parent window</span>
101<span class="sd">        </span>
102<span class="sd">        :return: list of panels</span>
103<span class="sd">        </span>
104<span class="sd">        &quot;&quot;&quot;</span>
105        <span class="c">## Save a reference to the parent</span>
106        <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">parent</span>
107       
108        <span class="c"># Define a panel</span>
109        <span class="n">defaultpanel</span> <span class="o">=</span> <span class="n">gui_manager</span><span class="o">.</span><span class="n">DefaultPanel</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
110        <span class="n">defaultpanel</span><span class="o">.</span><span class="n">window_name</span> <span class="o">=</span> <span class="s">&quot;Test&quot;</span>
111       
112        <span class="c"># If needed, add its name to the perspective list</span>
113        <span class="bp">self</span><span class="o">.</span><span class="n">perspective</span> <span class="o">=</span> <span class="p">[</span><span class="n">defaultpanel</span><span class="o">.</span><span class="n">window_name</span><span class="p">]</span>
114
115        <span class="c"># Return the list of panels</span>
116        <span class="k">return</span> <span class="p">[</span><span class="n">defaultpanel</span><span class="p">]</span>
117    </div>
118<div class="viewcode-block" id="TestPlugin.get_tools"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.dummyapp.TestPlugin.get_tools">[docs]</a>    <span class="k">def</span> <span class="nf">get_tools</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
119        <span class="sd">&quot;&quot;&quot;</span>
120<span class="sd">        Returns a set of menu entries for tools</span>
121<span class="sd">        &quot;&quot;&quot;</span>
122        <span class="k">def</span> <span class="nf">_test_dialog</span><span class="p">(</span><span class="n">event</span><span class="p">):</span>
123            <span class="kn">import</span> <span class="nn">wx</span>
124            <span class="n">frame</span> <span class="o">=</span> <span class="n">wx</span><span class="o">.</span><span class="n">Dialog</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s">&#39;Test Tool&#39;</span><span class="p">)</span>   
125            <span class="n">frame</span><span class="o">.</span><span class="n">Show</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span>
126        <span class="k">return</span> <span class="p">[[</span><span class="s">&quot;Tool 1&quot;</span><span class="p">,</span> <span class="s">&quot;This is an example tool&quot;</span><span class="p">,</span> <span class="n">_test_dialog</span><span class="p">],</span>
127                <span class="p">[</span><span class="s">&quot;Tool 2&quot;</span><span class="p">,</span> <span class="s">&quot;This is another example tool&quot;</span><span class="p">,</span> <span class="n">_test_dialog</span><span class="p">]]</span>
128</div>
129<div class="viewcode-block" id="TestPlugin.get_context_menu"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.dummyapp.TestPlugin.get_context_menu">[docs]</a>    <span class="k">def</span> <span class="nf">get_context_menu</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">graph</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
130        <span class="sd">&quot;&quot;&quot;</span>
131<span class="sd">        This method is optional.</span>
132<span class="sd">    </span>
133<span class="sd">        When the context menu of a plot is rendered, the </span>
134<span class="sd">        get_context_menu method will be called to give you a </span>
135<span class="sd">        chance to add a menu item to the context menu.</span>
136<span class="sd">        </span>
137<span class="sd">        A ref to a Graph object is passed so that you can</span>
138<span class="sd">        investigate the plot content and decide whether you</span>
139<span class="sd">        need to add items to the context menu.  </span>
140<span class="sd">        </span>
141<span class="sd">        This method returns a list of menu items.</span>
142<span class="sd">        Each item is itself a list defining the text to </span>
143<span class="sd">        appear in the menu, a tool-tip help text, and a</span>
144<span class="sd">        call-back method.</span>
145<span class="sd">        </span>
146<span class="sd">        :param graph: the Graph object to which we attach the context menu</span>
147<span class="sd">        </span>
148<span class="sd">        :return: a list of menu items with call-back function</span>
149<span class="sd">        &quot;&quot;&quot;</span>
150        <span class="k">return</span> <span class="p">[[</span><span class="s">&quot;Menu text&quot;</span><span class="p">,</span> 
151                 <span class="s">&quot;Tool-tip help text&quot;</span><span class="p">,</span> 
152                 <span class="s">&quot;self._on_context_do_something&quot;</span><span class="p">]]</span>   
153</div></div>
154<div class="viewcode-block" id="SasView"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.dummyapp.SasView">[docs]</a><span class="k">class</span> <span class="nc">SasView</span><span class="p">():</span>
155   
156    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
157        <span class="sd">&quot;&quot;&quot;</span>
158<span class="sd">        Initialization</span>
159<span class="sd">        &quot;&quot;&quot;</span>
160        <span class="bp">self</span><span class="o">.</span><span class="n">gui</span> <span class="o">=</span> <span class="n">DummyView</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
161       
162        <span class="n">fitting_plug</span> <span class="o">=</span> <span class="n">TestPlugin</span><span class="p">()</span>
163        <span class="bp">self</span><span class="o">.</span><span class="n">gui</span><span class="o">.</span><span class="n">add_perspective</span><span class="p">(</span><span class="n">fitting_plug</span><span class="p">)</span>
164       
165        <span class="c"># Build the GUI</span>
166        <span class="bp">self</span><span class="o">.</span><span class="n">gui</span><span class="o">.</span><span class="n">build_gui</span><span class="p">()</span>
167       
168        <span class="c"># Set the application manager for the GUI</span>
169        <span class="bp">self</span><span class="o">.</span><span class="n">gui</span><span class="o">.</span><span class="n">set_manager</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
170       
171        <span class="c"># Start the main loop</span>
172        <span class="bp">self</span><span class="o">.</span><span class="n">gui</span><span class="o">.</span><span class="n">MainLoop</span><span class="p">()</span> 
173</div>
174<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&quot;__main__&quot;</span><span class="p">:</span> 
175    <span class="kn">from</span> <span class="nn">multiprocessing</span> <span class="kn">import</span> <span class="n">freeze_support</span>
176    <span class="n">freeze_support</span><span class="p">()</span>
177    <span class="n">sasview</span> <span class="o">=</span> <span class="n">SasView</span><span class="p">()</span>
178</pre></div>
179
180          </div>
181        </div>
182      </div>
183      <div class="sphinxsidebar">
184        <div class="sphinxsidebarwrapper">
185<div id="searchbox" style="display: none">
186  <h3>Quick search</h3>
187    <form class="search" action="../../../search.html" method="get">
188      <input type="text" name="q" />
189      <input type="submit" value="Go" />
190      <input type="hidden" name="check_keywords" value="yes" />
191      <input type="hidden" name="area" value="default" />
192    </form>
193    <p class="searchtip" style="font-size: 90%">
194    Enter search terms or a module, class or function name.
195    </p>
196</div>
197<script type="text/javascript">$('#searchbox').show(0);</script>
198        </div>
199      </div>
200      <div class="clearer"></div>
201    </div>
202    <div class="related">
203      <h3>Navigation</h3>
204      <ul>
205        <li class="right" style="margin-right: 10px">
206          <a href="../../../genindex.html" title="General Index"
207             >index</a></li>
208        <li class="right" >
209          <a href="../../../py-modindex.html" title="Python Module Index"
210             >modules</a> |</li>
211        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
212          <li><a href="../../index.html" >Module code</a> &raquo;</li>
213          <li><a href="../guiframe.html" >sas.guiframe</a> &raquo;</li> 
214      </ul>
215    </div>
216    <div class="footer">
217        &copy; Copyright 2013, The SasView Project.
218      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
219    </div>
220  </body>
221</html>
Note: See TracBrowser for help on using the repository browser.