source: sasview/sansguiframe/docs/sphinx/html/api/panel_base.html @ b3145bf

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since b3145bf was 96cbb53, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 17.2 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>panel_base &mdash; guiframe v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="guiframe v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="pdfview" href="pdfview.html" />
28    <link rel="prev" title="gui_toolbar" href="gui_toolbar.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 class="right" >
41          <a href="pdfview.html" title="pdfview"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="gui_toolbar.html" title="gui_toolbar"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</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="panel-base">
57<h1>panel_base<a class="headerlink" href="#panel-base" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.panel_base">
59<span id="sans-guiframe-panel-base"></span><h2><a class="reference internal" href="#module-sans.guiframe.panel_base" title="sans.guiframe.panel_base"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.panel_base</span></tt></a><a class="headerlink" href="#module-sans.guiframe.panel_base" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.guiframe.panel_base.PanelBase">
62<em class="property">class </em><tt class="descclassname">sans.guiframe.panel_base.</tt><tt class="descname">PanelBase</tt><big>(</big><em>parent=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase" title="Permalink to this definition">¶</a></dt>
63<dd><p>Defines the API for a panels to work with
64the ViewerFrame toolbar and menu bar</p>
65<dl class="method">
66<dt id="sans.guiframe.panel_base.PanelBase.get_bookmark_flag">
67<tt class="descname">get_bookmark_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_bookmark_flag" title="Permalink to this definition">¶</a></dt>
68<dd><p>Get the bookmark flag to update appropriately the tool bar</p>
69</dd></dl>
70
71<dl class="method">
72<dt id="sans.guiframe.panel_base.PanelBase.get_copy_flag">
73<tt class="descname">get_copy_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_copy_flag" title="Permalink to this definition">¶</a></dt>
74<dd><p>Get the copy flag to update appropriately the tool bar</p>
75</dd></dl>
76
77<dl class="method">
78<dt id="sans.guiframe.panel_base.PanelBase.get_data">
79<tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_data" title="Permalink to this definition">¶</a></dt>
80<dd><p>return list of current data</p>
81</dd></dl>
82
83<dl class="method">
84<dt id="sans.guiframe.panel_base.PanelBase.get_drag_flag">
85<tt class="descname">get_drag_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_drag_flag" title="Permalink to this definition">¶</a></dt>
86<dd><p>Get the drag flag to update appropriately the tool bar</p>
87</dd></dl>
88
89<dl class="method">
90<dt id="sans.guiframe.panel_base.PanelBase.get_manager">
91<tt class="descname">get_manager</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_manager" title="Permalink to this definition">¶</a></dt>
92<dd></dd></dl>
93
94<dl class="method">
95<dt id="sans.guiframe.panel_base.PanelBase.get_paste_flag">
96<tt class="descname">get_paste_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_paste_flag" title="Permalink to this definition">¶</a></dt>
97<dd><p>Get the copy flag to update appropriately the tool bar</p>
98</dd></dl>
99
100<dl class="method">
101<dt id="sans.guiframe.panel_base.PanelBase.get_preview_flag">
102<tt class="descname">get_preview_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_preview_flag" title="Permalink to this definition">¶</a></dt>
103<dd><p>Get the preview flag to update appropriately the tool bar</p>
104</dd></dl>
105
106<dl class="method">
107<dt id="sans.guiframe.panel_base.PanelBase.get_print_flag">
108<tt class="descname">get_print_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_print_flag" title="Permalink to this definition">¶</a></dt>
109<dd><p>Get the print flag to update appropriately the tool bar</p>
110</dd></dl>
111
112<dl class="method">
113<dt id="sans.guiframe.panel_base.PanelBase.get_redo_flag">
114<tt class="descname">get_redo_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_redo_flag" title="Permalink to this definition">¶</a></dt>
115<dd><p>Get the redo flag to update appropriately the tool bar</p>
116</dd></dl>
117
118<dl class="method">
119<dt id="sans.guiframe.panel_base.PanelBase.get_reset_flag">
120<tt class="descname">get_reset_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_reset_flag" title="Permalink to this definition">¶</a></dt>
121<dd><p>Get the reset flag to update appropriately the tool bar</p>
122</dd></dl>
123
124<dl class="method">
125<dt id="sans.guiframe.panel_base.PanelBase.get_save_flag">
126<tt class="descname">get_save_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_save_flag" title="Permalink to this definition">¶</a></dt>
127<dd><p>Get the save flag to update appropriately the tool bar</p>
128</dd></dl>
129
130<dl class="method">
131<dt id="sans.guiframe.panel_base.PanelBase.get_state">
132<tt class="descname">get_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_state" title="Permalink to this definition">¶</a></dt>
133<dd><p>return the current state</p>
134</dd></dl>
135
136<dl class="method">
137<dt id="sans.guiframe.panel_base.PanelBase.get_undo_flag">
138<tt class="descname">get_undo_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_undo_flag" title="Permalink to this definition">¶</a></dt>
139<dd><p>Get the undo flag to update appropriately the tool bar</p>
140</dd></dl>
141
142<dl class="method">
143<dt id="sans.guiframe.panel_base.PanelBase.get_zoom_flag">
144<tt class="descname">get_zoom_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_zoom_flag" title="Permalink to this definition">¶</a></dt>
145<dd><p>Get the zoom flag to update appropriately the tool bar</p>
146</dd></dl>
147
148<dl class="method">
149<dt id="sans.guiframe.panel_base.PanelBase.get_zoom_in_flag">
150<tt class="descname">get_zoom_in_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_zoom_in_flag" title="Permalink to this definition">¶</a></dt>
151<dd><p>Get the zoom in flag to update appropriately the tool bar</p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.guiframe.panel_base.PanelBase.get_zoom_out_flag">
156<tt class="descname">get_zoom_out_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.get_zoom_out_flag" title="Permalink to this definition">¶</a></dt>
157<dd><p>Get the zoom out flag to update appropriately the tool bar</p>
158</dd></dl>
159
160<dl class="method">
161<dt id="sans.guiframe.panel_base.PanelBase.has_changed">
162<tt class="descname">has_changed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.has_changed" title="Permalink to this definition">¶</a></dt>
163<dd></dd></dl>
164
165<dl class="method">
166<dt id="sans.guiframe.panel_base.PanelBase.on_batch_selection">
167<tt class="descname">on_batch_selection</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_batch_selection" title="Permalink to this definition">¶</a></dt>
168<dd><table class="docutils field-list" frame="void" rules="none">
169<col class="field-name" />
170<col class="field-body" />
171<tbody valign="top">
172<tr class="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>
173</tr>
174</tbody>
175</table>
176<p>the application is in Batch mode
177else the application is default mode(single mode)</p>
178</dd></dl>
179
180<dl class="method">
181<dt id="sans.guiframe.panel_base.PanelBase.on_bookmark">
182<tt class="descname">on_bookmark</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_bookmark" title="Permalink to this definition">¶</a></dt>
183<dd><p>The derivative class is on bookmark mode if implemented</p>
184</dd></dl>
185
186<dl class="method">
187<dt id="sans.guiframe.panel_base.PanelBase.on_copy">
188<tt class="descname">on_copy</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_copy" title="Permalink to this definition">¶</a></dt>
189<dd><p>The copy action if possible</p>
190</dd></dl>
191
192<dl class="method">
193<dt id="sans.guiframe.panel_base.PanelBase.on_drag">
194<tt class="descname">on_drag</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_drag" title="Permalink to this definition">¶</a></dt>
195<dd><p>The derivative class allows dragging motion if implemented</p>
196</dd></dl>
197
198<dl class="method">
199<dt id="sans.guiframe.panel_base.PanelBase.on_kill_focus">
200<tt class="descname">on_kill_focus</tt><big>(</big><em>event=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_kill_focus" title="Permalink to this definition">¶</a></dt>
201<dd><p>The  derivative class is on unfocus if implemented</p>
202</dd></dl>
203
204<dl class="method">
205<dt id="sans.guiframe.panel_base.PanelBase.on_paste">
206<tt class="descname">on_paste</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_paste" title="Permalink to this definition">¶</a></dt>
207<dd><p>The paste action if possible</p>
208</dd></dl>
209
210<dl class="method">
211<dt id="sans.guiframe.panel_base.PanelBase.on_preview">
212<tt class="descname">on_preview</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_preview" title="Permalink to this definition">¶</a></dt>
213<dd><p>Display a printable version of the class derivative</p>
214</dd></dl>
215
216<dl class="method">
217<dt id="sans.guiframe.panel_base.PanelBase.on_redo">
218<tt class="descname">on_redo</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_redo" title="Permalink to this definition">¶</a></dt>
219<dd><p>The previous action is restored if possible</p>
220</dd></dl>
221
222<dl class="method">
223<dt id="sans.guiframe.panel_base.PanelBase.on_reset">
224<tt class="descname">on_reset</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_reset" title="Permalink to this definition">¶</a></dt>
225<dd><p>The derivative class state is restored</p>
226</dd></dl>
227
228<dl class="method">
229<dt id="sans.guiframe.panel_base.PanelBase.on_save">
230<tt class="descname">on_save</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_save" title="Permalink to this definition">¶</a></dt>
231<dd><p>The state of the derivative class is restored</p>
232</dd></dl>
233
234<dl class="method">
235<dt id="sans.guiframe.panel_base.PanelBase.on_set_focus">
236<tt class="descname">on_set_focus</tt><big>(</big><em>event=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_set_focus" title="Permalink to this definition">¶</a></dt>
237<dd><p>The  derivative class is on focus if implemented</p>
238</dd></dl>
239
240<dl class="method">
241<dt id="sans.guiframe.panel_base.PanelBase.on_undo">
242<tt class="descname">on_undo</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_undo" title="Permalink to this definition">¶</a></dt>
243<dd><p>The current action is canceled</p>
244</dd></dl>
245
246<dl class="method">
247<dt id="sans.guiframe.panel_base.PanelBase.on_zoom">
248<tt class="descname">on_zoom</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_zoom" title="Permalink to this definition">¶</a></dt>
249<dd><p>The derivative class is on zoom mode (using pane)
250if zoom mode is implemented</p>
251</dd></dl>
252
253<dl class="method">
254<dt id="sans.guiframe.panel_base.PanelBase.on_zoom_in">
255<tt class="descname">on_zoom_in</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_zoom_in" title="Permalink to this definition">¶</a></dt>
256<dd><p>The derivative class is on zoom in mode if implemented</p>
257</dd></dl>
258
259<dl class="method">
260<dt id="sans.guiframe.panel_base.PanelBase.on_zoom_out">
261<tt class="descname">on_zoom_out</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.on_zoom_out" title="Permalink to this definition">¶</a></dt>
262<dd><p>The derivative class is on zoom out mode if implemented</p>
263</dd></dl>
264
265<dl class="method">
266<dt id="sans.guiframe.panel_base.PanelBase.save_project">
267<tt class="descname">save_project</tt><big>(</big><em>doc=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.save_project" title="Permalink to this definition">¶</a></dt>
268<dd><dl class="docutils">
269<dt>return an xml node containing state of the panel</dt>
270<dd>that guiframe can write to file</dd>
271</dl>
272</dd></dl>
273
274<dl class="method">
275<dt id="sans.guiframe.panel_base.PanelBase.set_manager">
276<tt class="descname">set_manager</tt><big>(</big><em>manager</em><big>)</big><a class="headerlink" href="#sans.guiframe.panel_base.PanelBase.set_manager" title="Permalink to this definition">¶</a></dt>
277<dd></dd></dl>
278
279</dd></dl>
280
281</div>
282</div>
283
284
285          </div>
286        </div>
287      </div>
288      <div class="sphinxsidebar">
289        <div class="sphinxsidebarwrapper">
290  <h3><a href="../index.html">Table Of Contents</a></h3>
291  <ul>
292<li><a class="reference internal" href="#">panel_base</a><ul>
293<li><a class="reference internal" href="#module-sans.guiframe.panel_base"><tt class="docutils literal"><span class="pre">sans.guiframe.panel_base</span></tt></a></li>
294</ul>
295</li>
296</ul>
297
298  <h4>Previous topic</h4>
299  <p class="topless"><a href="gui_toolbar.html"
300                        title="previous chapter">gui_toolbar</a></p>
301  <h4>Next topic</h4>
302  <p class="topless"><a href="pdfview.html"
303                        title="next chapter">pdfview</a></p>
304  <h3>This Page</h3>
305  <ul class="this-page-menu">
306    <li><a href="../_sources/api/panel_base.txt"
307           rel="nofollow">Show Source</a></li>
308  </ul>
309<div id="searchbox" style="display: none">
310  <h3>Quick search</h3>
311    <form class="search" action="../search.html" method="get">
312      <input type="text" name="q" size="18" />
313      <input type="submit" value="Go" />
314      <input type="hidden" name="check_keywords" value="yes" />
315      <input type="hidden" name="area" value="default" />
316    </form>
317    <p class="searchtip" style="font-size: 90%">
318    Enter search terms or a module, class or function name.
319    </p>
320</div>
321<script type="text/javascript">$('#searchbox').show(0);</script>
322        </div>
323      </div>
324      <div class="clearer"></div>
325    </div>
326    <div class="related">
327      <h3>Navigation</h3>
328      <ul>
329        <li class="right" style="margin-right: 10px">
330          <a href="../genindex.html" title="General Index"
331             >index</a></li>
332        <li class="right" >
333          <a href="../py-modindex.html" title="Python Module Index"
334             >modules</a> |</li>
335        <li class="right" >
336          <a href="pdfview.html" title="pdfview"
337             >next</a> |</li>
338        <li class="right" >
339          <a href="gui_toolbar.html" title="gui_toolbar"
340             >previous</a> |</li>
341        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
342          <li><a href="index.html" >Reference</a> &raquo;</li> 
343      </ul>
344    </div>
345    <div class="footer">
346        &copy; Copyright 2010, sans group.
347      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
348    </div>
349  </body>
350</html>
Note: See TracBrowser for help on using the repository browser.