source: sasview/_modules/sas/guiframe/plugin_base.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: 33.9 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.plugin_base &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.plugin_base</h1><div class="highlight"><pre>
52<span class="c">################################################################################</span>
53<span class="c">#This software was developed by the University of Tennessee as part of the</span>
54<span class="c">#Distributed Data Analysis of Neutron Scattering Experiments (DANSE)</span>
55<span class="c">#project funded by the US National Science Foundation. </span>
56<span class="c">#</span>
57<span class="c">#See the license text in license.txt</span>
58<span class="c">#</span>
59<span class="c">#copyright 2008, University of Tennessee</span>
60<span class="c">################################################################################</span>
61 
62<div class="viewcode-block" id="PluginBase"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase">[docs]</a><span class="k">class</span> <span class="nc">PluginBase</span><span class="p">:</span>
63    <span class="sd">&quot;&quot;&quot;</span>
64<span class="sd">    This class defines the interface for a Plugin class</span>
65<span class="sd">    that can be used by the gui_manager.</span>
66<span class="sd">    </span>
67<span class="sd">    Plug-ins should be placed in a sub-directory called &quot;perspectives&quot;.</span>
68<span class="sd">    For example, a plug-in called Foo should be place in &quot;perspectives/Foo&quot;.</span>
69<span class="sd">    That directory contains at least two files:</span>
70
71<span class="sd">    1. perspectives/Foo/__init__.py contains two lines: ::</span>
72<span class="sd">        </span>
73<span class="sd">        PLUGIN_ID = &quot;Foo plug-in 1.0&quot;</span>
74<span class="sd">        from Foo import *</span>
75<span class="sd">            </span>
76<span class="sd">    2. perspectives/Foo/Foo.py contains the definition of the Plugin</span>
77<span class="sd">       class for the Foo plug-in. The interface of that Plugin class</span>
78<span class="sd">       should follow the interface of the class you are looking at.</span>
79<span class="sd">        </span>
80<span class="sd">    See dummyapp.py for a plugin example.</span>
81<span class="sd">    &quot;&quot;&quot;</span>
82   
83    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">&quot;Test_plugin&quot;</span><span class="p">,</span> <span class="n">standalone</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
84        <span class="sd">&quot;&quot;&quot;</span>
85<span class="sd">            Abstract class for gui_manager Plugins.</span>
86<span class="sd">        &quot;&quot;&quot;</span>
87        <span class="c"># Define if the plugin is local to Viewerframe  and always active</span>
88        <span class="bp">self</span><span class="o">.</span><span class="n">_always_active</span> <span class="o">=</span> <span class="bp">False</span>
89        <span class="c">## Plug-in name. It will appear on the application menu.</span>
90        <span class="bp">self</span><span class="o">.</span><span class="n">sub_menu</span> <span class="o">=</span> <span class="n">name</span>     
91        <span class="c">#standalone flag</span>
92        <span class="bp">self</span><span class="o">.</span><span class="n">standalone</span> <span class="o">=</span> <span class="n">standalone</span>
93        <span class="c">## Reference to the parent window. Filled by get_panels() below.</span>
94        <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="bp">None</span>
95        <span class="bp">self</span><span class="o">.</span><span class="n">frame</span> <span class="o">=</span> <span class="bp">None</span>
96        <span class="c">#plugin state reader</span>
97        <span class="bp">self</span><span class="o">.</span><span class="n">state_reader</span> <span class="o">=</span> <span class="bp">None</span> 
98        <span class="bp">self</span><span class="o">.</span><span class="n">_extensions</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
99        <span class="c">## List of panels that you would like to open in AUI windows</span>
100        <span class="c">#  for your plug-in. This defines your plug-in &quot;perspective&quot;</span>
101        <span class="bp">self</span><span class="o">.</span><span class="n">perspective</span> <span class="o">=</span> <span class="p">[]</span>
102        <span class="c">#flag to tell the current plugin that aaplication is in batch mode</span>
103        <span class="bp">self</span><span class="o">.</span><span class="n">batch_on</span> <span class="o">=</span> <span class="bp">False</span>
104        <span class="c">#properties for color and ID of a specific plugin..</span>
105        <span class="bp">self</span><span class="o">.</span><span class="n">color</span> <span class="o">=</span> <span class="bp">None</span>
106        <span class="bp">self</span><span class="o">.</span><span class="n">id</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
107        <span class="bp">self</span><span class="o">.</span><span class="n">batch_capable</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_batch_capable</span><span class="p">()</span>
108   
109<div class="viewcode-block" id="PluginBase.get_batch_capable"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.get_batch_capable">[docs]</a>    <span class="k">def</span> <span class="nf">get_batch_capable</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
110        <span class="sd">&quot;&quot;&quot;</span>
111<span class="sd">        Check if the plugin has a batch capability</span>
112<span class="sd">        &quot;&quot;&quot;</span>
113        <span class="k">return</span> <span class="bp">False</span>
114         </div>
115<div class="viewcode-block" id="PluginBase.add_color"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.add_color">[docs]</a>    <span class="k">def</span> <span class="nf">add_color</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">color</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
116        <span class="sd">&quot;&quot;&quot;</span>
117<span class="sd">        Adds color to a plugin</span>
118<span class="sd">        &quot;&quot;&quot;</span>
119        </div>
120<div class="viewcode-block" id="PluginBase.clear_panel"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.clear_panel">[docs]</a>    <span class="k">def</span> <span class="nf">clear_panel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
121        <span class="sd">&quot;&quot;&quot;</span>
122<span class="sd">        clear all related panels</span>
123<span class="sd">        &quot;&quot;&quot;</span></div>
124<div class="viewcode-block" id="PluginBase.get_extensions"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.get_extensions">[docs]</a>    <span class="k">def</span> <span class="nf">get_extensions</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
125        <span class="sd">&quot;&quot;&quot;</span>
126<span class="sd">        return state reader and its extensions</span>
127<span class="sd">        &quot;&quot;&quot;</span>
128        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">state_reader</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_extensions</span>
129    </div>
130<div class="viewcode-block" id="PluginBase.can_load_data"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.can_load_data">[docs]</a>    <span class="k">def</span> <span class="nf">can_load_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
131        <span class="sd">&quot;&quot;&quot;</span>
132<span class="sd">        if return True, then call handler to laod data</span>
133<span class="sd">        &quot;&quot;&quot;</span>
134        <span class="k">return</span> <span class="bp">False</span>
135    </div>
136<div class="viewcode-block" id="PluginBase.use_data"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.use_data">[docs]</a>    <span class="k">def</span> <span class="nf">use_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
137        <span class="sd">&quot;&quot;&quot;</span>
138<span class="sd">        return True if these plugin use data</span>
139<span class="sd">        &quot;&quot;&quot;</span>
140        <span class="k">return</span> <span class="bp">True</span>
141    </div>
142<div class="viewcode-block" id="PluginBase.is_in_use"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.is_in_use">[docs]</a>    <span class="k">def</span> <span class="nf">is_in_use</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_id</span><span class="p">):</span>
143        <span class="sd">&quot;&quot;&quot;</span>
144<span class="sd">        get a  data id a list of data name if data data is</span>
145<span class="sd">         currently used by the plugin and the name of the plugin</span>
146<span class="sd">        </span>
147<span class="sd">        data_name = &#39;None&#39;</span>
148<span class="sd">        in_use = False</span>
149<span class="sd">        example [(data_name, self.sub_menu)]</span>
150<span class="sd">        &quot;&quot;&quot;</span>
151        <span class="k">return</span> <span class="p">[]</span>
152    </div>
153<div class="viewcode-block" id="PluginBase.delete_data"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.delete_data">[docs]</a>    <span class="k">def</span> <span class="nf">delete_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_id</span><span class="p">):</span>
154        <span class="sd">&quot;&quot;&quot;</span>
155<span class="sd">        Delete all references of data which id are in data_list. </span>
156<span class="sd">        &quot;&quot;&quot;</span>
157        </div>
158<div class="viewcode-block" id="PluginBase.load_data"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.load_data">[docs]</a>    <span class="k">def</span> <span class="nf">load_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
159        <span class="sd">&quot;&quot;&quot;</span>
160<span class="sd">        Load  data</span>
161<span class="sd">        &quot;&quot;&quot;</span>
162        <span class="k">raise</span> <span class="ne">NotImplementedError</span>
163 </div>
164<div class="viewcode-block" id="PluginBase.load_folder"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.load_folder">[docs]</a>    <span class="k">def</span> <span class="nf">load_folder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
165        <span class="sd">&quot;&quot;&quot;</span>
166<span class="sd">        Load entire folder</span>
167<span class="sd">        &quot;&quot;&quot;</span>
168        <span class="k">raise</span> <span class="ne">NotImplementedError</span>
169    </div>
170<div class="viewcode-block" id="PluginBase.set_is_active"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.set_is_active">[docs]</a>    <span class="k">def</span> <span class="nf">set_is_active</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">active</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
171        <span class="sd">&quot;&quot;&quot;</span>
172<span class="sd">        &quot;&quot;&quot;</span>
173        <span class="bp">self</span><span class="o">.</span><span class="n">_always_active</span> <span class="o">=</span> <span class="n">active</span>
174        </div>
175<div class="viewcode-block" id="PluginBase.is_always_active"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.is_always_active">[docs]</a>    <span class="k">def</span> <span class="nf">is_always_active</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
176        <span class="sd">&quot;&quot;&quot;</span>
177<span class="sd">        return True is this plugin is always active and it is local to guiframe</span>
178<span class="sd">        even if the user is switching between perspectives</span>
179<span class="sd">        &quot;&quot;&quot;</span>
180        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_always_active</span>
181    </div>
182<div class="viewcode-block" id="PluginBase.populate_file_menu"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.populate_file_menu">[docs]</a>    <span class="k">def</span> <span class="nf">populate_file_menu</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
183        <span class="sd">&quot;&quot;&quot;</span>
184<span class="sd">        Append menu item under file menu item of the frame</span>
185<span class="sd">        &quot;&quot;&quot;</span>
186        <span class="k">return</span> <span class="p">[]</span>
187    </div>
188<div class="viewcode-block" id="PluginBase.populate_menu"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.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>
189        <span class="sd">&quot;&quot;&quot;</span>
190<span class="sd">        Create and return the list of application menu</span>
191<span class="sd">        items for the plug-in. </span>
192<span class="sd">        </span>
193<span class="sd">        :param parent: parent window</span>
194<span class="sd">        </span>
195<span class="sd">        :return: plug-in menu</span>
196<span class="sd">        </span>
197<span class="sd">        &quot;&quot;&quot;</span>
198        <span class="k">return</span> <span class="p">[]</span>
199    </div>
200<div class="viewcode-block" id="PluginBase.get_frame"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.get_frame">[docs]</a>    <span class="k">def</span> <span class="nf">get_frame</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
201        <span class="sd">&quot;&quot;&quot;</span>
202<span class="sd">        Returns MDIChildFrame</span>
203<span class="sd">        &quot;&quot;&quot;</span>
204        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame</span>
205</div>
206    <span class="k">def</span> <span class="nf">_frame_set_helper</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
207        <span class="sd">&quot;&quot;&quot;</span>
208<span class="sd">        Sets default frame config</span>
209<span class="sd">        &quot;&quot;&quot;</span>
210        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">:</span>
211            <span class="bp">self</span><span class="o">.</span><span class="n">frame</span><span class="o">.</span><span class="n">EnableCloseButton</span><span class="p">(</span><span class="bp">False</span><span class="p">)</span>
212            <span class="bp">self</span><span class="o">.</span><span class="n">frame</span><span class="o">.</span><span class="n">Show</span><span class="p">(</span><span class="bp">False</span><span class="p">)</span>
213   
214<div class="viewcode-block" id="PluginBase.get_panels"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.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>
215        <span class="sd">&quot;&quot;&quot;</span>
216<span class="sd">        Create and return the list of wx.Panels for your plug-in.</span>
217<span class="sd">        Define the plug-in perspective.</span>
218<span class="sd">        </span>
219<span class="sd">        Panels should inherit from DefaultPanel defined below,</span>
220<span class="sd">        or should present the same interface. They must define</span>
221<span class="sd">        &quot;window_caption&quot; and &quot;window_name&quot;.</span>
222<span class="sd">        </span>
223<span class="sd">        :param parent: parent window</span>
224<span class="sd">        </span>
225<span class="sd">        :return: list of panels</span>
226<span class="sd">        </span>
227<span class="sd">        &quot;&quot;&quot;</span>
228        <span class="c">## Save a reference to the parent</span>
229        <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">parent</span>
230       
231        <span class="c"># Return the list of panels</span>
232        <span class="k">return</span> <span class="p">[]</span>
233   
234 </div>
235<div class="viewcode-block" id="PluginBase.get_tools"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.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>
236        <span class="sd">&quot;&quot;&quot;</span>
237<span class="sd">        Returns a set of menu entries for tools</span>
238<span class="sd">        &quot;&quot;&quot;</span>
239        <span class="k">return</span> <span class="p">[]</span>
240       
241    </div>
242<div class="viewcode-block" id="PluginBase.get_context_menu"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.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">plotpanel</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
243        <span class="sd">&quot;&quot;&quot;</span>
244<span class="sd">        This method is optional.</span>
245<span class="sd">    </span>
246<span class="sd">        When the context menu of a plot is rendered, the </span>
247<span class="sd">        get_context_menu method will be called to give you a </span>
248<span class="sd">        chance to add a menu item to the context menu.</span>
249<span class="sd">        </span>
250<span class="sd">        A ref to a plotpanel object is passed so that you can</span>
251<span class="sd">        investigate the plot content and decide whether you</span>
252<span class="sd">        need to add items to the context menu.  </span>
253<span class="sd">        </span>
254<span class="sd">        This method returns a list of menu items.</span>
255<span class="sd">        Each item is itself a list defining the text to </span>
256<span class="sd">        appear in the menu, a tool-tip help text, and a</span>
257<span class="sd">        call-back method.</span>
258<span class="sd">        </span>
259<span class="sd">        :param graph: the Graph object to which we attach the context menu</span>
260<span class="sd">        </span>
261<span class="sd">        :return: a list of menu items with call-back function</span>
262<span class="sd">        </span>
263<span class="sd">        &quot;&quot;&quot;</span>
264        <span class="k">return</span> <span class="p">[]</span>
265    </div>
266<div class="viewcode-block" id="PluginBase.get_perspective"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.get_perspective">[docs]</a>    <span class="k">def</span> <span class="nf">get_perspective</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
267        <span class="sd">&quot;&quot;&quot;</span>
268<span class="sd">        Get the list of panel names for this perspective</span>
269<span class="sd">        &quot;&quot;&quot;</span>
270        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">perspective</span>
271    </div>
272<div class="viewcode-block" id="PluginBase.on_perspective"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.on_perspective">[docs]</a>    <span class="k">def</span> <span class="nf">on_perspective</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
273        <span class="sd">&quot;&quot;&quot;</span>
274<span class="sd">        Call back function for the perspective menu item.</span>
275<span class="sd">        We notify the parent window that the perspective</span>
276<span class="sd">        has changed.</span>
277<span class="sd">        </span>
278<span class="sd">        :param event: menu event</span>
279<span class="sd">        </span>
280<span class="sd">        &quot;&quot;&quot;</span>
281        <span class="n">old_frame</span> <span class="o">=</span> <span class="bp">None</span>
282        <span class="n">tool_height</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">get_toolbar_height</span><span class="p">()</span>
283        <span class="n">old_persp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">get_current_perspective</span><span class="p">()</span>
284        <span class="k">if</span> <span class="n">old_persp</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">:</span>
285            <span class="n">old_frame</span> <span class="o">=</span> <span class="n">old_persp</span><span class="o">.</span><span class="n">get_frame</span><span class="p">()</span>
286        <span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">check_multimode</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
287        <span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">set_current_perspective</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
288        <span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">set_perspective</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">perspective</span><span class="p">)</span>
289       
290        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">:</span>
291            <span class="k">if</span> <span class="n">old_frame</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">:</span>
292                <span class="n">pos_x</span><span class="p">,</span> <span class="n">pos_y</span> <span class="o">=</span> <span class="n">old_frame</span><span class="o">.</span><span class="n">GetPositionTuple</span><span class="p">()</span>
293                <span class="bp">self</span><span class="o">.</span><span class="n">frame</span><span class="o">.</span><span class="n">SetPosition</span><span class="p">((</span><span class="n">pos_x</span><span class="p">,</span> <span class="n">pos_y</span> <span class="o">-</span> <span class="n">tool_height</span><span class="p">))</span>
294            <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame</span><span class="o">.</span><span class="n">IsShown</span><span class="p">():</span>
295                <span class="bp">self</span><span class="o">.</span><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>
296       
297        </div>
298<div class="viewcode-block" id="PluginBase.set_batch_selection"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.set_batch_selection">[docs]</a>    <span class="k">def</span> <span class="nf">set_batch_selection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">flag</span><span class="p">):</span>
299        <span class="sd">&quot;&quot;&quot;</span>
300<span class="sd">        the plugin to its batch state if flag is True</span>
301<span class="sd">        &quot;&quot;&quot;</span>
302        <span class="bp">self</span><span class="o">.</span><span class="n">batch_on</span> <span class="o">=</span> <span class="n">flag</span>
303        <span class="bp">self</span><span class="o">.</span><span class="n">on_batch_selection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">batch_on</span><span class="p">)</span>   
304    </div>
305<div class="viewcode-block" id="PluginBase.on_batch_selection"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.on_batch_selection">[docs]</a>    <span class="k">def</span> <span class="nf">on_batch_selection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">flag</span><span class="p">):</span>
306        <span class="sd">&quot;&quot;&quot;</span>
307<span class="sd">        need to be overwritten by the derivated class</span>
308<span class="sd">        &quot;&quot;&quot;</span>
309    </div>
310<div class="viewcode-block" id="PluginBase.post_init"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.post_init">[docs]</a>    <span class="k">def</span> <span class="nf">post_init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
311        <span class="sd">&quot;&quot;&quot;</span>
312<span class="sd">        Post initialization call back to close the loose ends</span>
313<span class="sd">        &quot;&quot;&quot;</span>
314        <span class="k">pass</span>
315    </div>
316<div class="viewcode-block" id="PluginBase.set_default_perspective"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.set_default_perspective">[docs]</a>    <span class="k">def</span> <span class="nf">set_default_perspective</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
317        <span class="sd">&quot;&quot;&quot;</span>
318<span class="sd">       Call back method that True to notify the parent that the current plug-in</span>
319<span class="sd">       can be set as default  perspective.</span>
320<span class="sd">       when returning False, the plug-in is not candidate for an automatic </span>
321<span class="sd">       default perspective setting</span>
322<span class="sd">        &quot;&quot;&quot;</span>
323        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">standalone</span><span class="p">:</span>
324            <span class="k">return</span> <span class="bp">True</span>
325        <span class="k">return</span> <span class="bp">False</span>
326    </div>
327<div class="viewcode-block" id="PluginBase.set_state"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.set_state">[docs]</a>    <span class="k">def</span> <span class="nf">set_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">datainfo</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>   
328        <span class="sd">&quot;&quot;&quot;</span>
329<span class="sd">        update state</span>
330<span class="sd">        &quot;&quot;&quot;</span></div>
331<div class="viewcode-block" id="PluginBase.set_data"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.set_data">[docs]</a>    <span class="k">def</span> <span class="nf">set_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_list</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
332        <span class="sd">&quot;&quot;&quot;</span>
333<span class="sd">        receive a list of data and use it in the current perspective</span>
334<span class="sd">       </span>
335<span class="sd">        &quot;&quot;&quot;</span></div>
336<div class="viewcode-block" id="PluginBase.set_theory"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.set_theory">[docs]</a>    <span class="k">def</span> <span class="nf">set_theory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">theory_list</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
337        <span class="sd">&quot;&quot;&quot;</span>
338<span class="sd">        :param theory_list: list of information </span>
339<span class="sd">            related to available theory state</span>
340<span class="sd">        &quot;&quot;&quot;</span>
341        <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s"> plugin: does not support import theory&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sub_menu</span><span class="p">)</span>
342        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="n">msg</span> 
343    </div>
344<div class="viewcode-block" id="PluginBase.on_set_state_helper"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.plugin_base.PluginBase.on_set_state_helper">[docs]</a>    <span class="k">def</span> <span class="nf">on_set_state_helper</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
345        <span class="sd">&quot;&quot;&quot;</span>
346<span class="sd">        update state</span>
347<span class="sd">        &quot;&quot;&quot;</span>
348    </div></div>
349</pre></div>
350
351          </div>
352        </div>
353      </div>
354      <div class="sphinxsidebar">
355        <div class="sphinxsidebarwrapper">
356<div id="searchbox" style="display: none">
357  <h3>Quick search</h3>
358    <form class="search" action="../../../search.html" method="get">
359      <input type="text" name="q" />
360      <input type="submit" value="Go" />
361      <input type="hidden" name="check_keywords" value="yes" />
362      <input type="hidden" name="area" value="default" />
363    </form>
364    <p class="searchtip" style="font-size: 90%">
365    Enter search terms or a module, class or function name.
366    </p>
367</div>
368<script type="text/javascript">$('#searchbox').show(0);</script>
369        </div>
370      </div>
371      <div class="clearer"></div>
372    </div>
373    <div class="related">
374      <h3>Navigation</h3>
375      <ul>
376        <li class="right" style="margin-right: 10px">
377          <a href="../../../genindex.html" title="General Index"
378             >index</a></li>
379        <li class="right" >
380          <a href="../../../py-modindex.html" title="Python Module Index"
381             >modules</a> |</li>
382        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
383          <li><a href="../../index.html" >Module code</a> &raquo;</li>
384          <li><a href="../guiframe.html" >sas.guiframe</a> &raquo;</li> 
385      </ul>
386    </div>
387    <div class="footer">
388        &copy; Copyright 2013, The SasView Project.
389      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
390    </div>
391  </body>
392</html>
Note: See TracBrowser for help on using the repository browser.