source: sasview/guiframe/docs/sphinx/_build/html/api/dummyapp.html @ d955bf19

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 d955bf19 was d955bf19, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 11.3 KB
RevLine 
[d955bf19]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>dummyapp &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="gui_manager" href="gui_manager.html" />
28    <link rel="prev" title="dataFitting" href="dataFitting.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="gui_manager.html" title="gui_manager"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="dataFitting.html" title="dataFitting"
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="dummyapp">
57<h1>dummyapp<a class="headerlink" href="#dummyapp" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.dummyapp">
59<span id="sans-guiframe-dummyapp"></span><h2><a class="reference internal" href="#module-sans.guiframe.dummyapp"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.dummyapp</span></tt></a><a class="headerlink" href="#module-sans.guiframe.dummyapp" title="Permalink to this headline">¶</a></h2>
60<p>Dummy application.
61Allows the user to set an external data manager</p>
62<dl class="class">
63<dt id="sans.guiframe.dummyapp.SansView">
64<em class="property">class </em><tt class="descclassname">sans.guiframe.dummyapp.</tt><tt class="descname">SansView</tt><a class="headerlink" href="#sans.guiframe.dummyapp.SansView" title="Permalink to this definition">¶</a></dt>
65<dd></dd></dl>
66
67<dl class="class">
68<dt id="sans.guiframe.dummyapp.TestPlugin">
69<em class="property">class </em><tt class="descclassname">sans.guiframe.dummyapp.</tt><tt class="descname">TestPlugin</tt><big>(</big><em>name='Test_plugin'</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin" title="Permalink to this definition">¶</a></dt>
70<dd><p>Bases: <a class="reference internal" href="gui_manager.html#sans.guiframe.gui_manager.Plugin" title="sans.guiframe.gui_manager.Plugin"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.gui_manager.Plugin</span></tt></a></p>
71<dl class="method">
72<dt id="sans.guiframe.dummyapp.TestPlugin.get_context_menu">
73<tt class="descname">get_context_menu</tt><big>(</big><em>graph=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_context_menu" title="Permalink to this definition">¶</a></dt>
74<dd><p>This method is optional.</p>
75<p>When the context menu of a plot is rendered, the
76get_context_menu method will be called to give you a
77chance to add a menu item to the context menu.</p>
78<p>A ref to a Graph object is passed so that you can
79investigate the plot content and decide whether you
80need to add items to the context menu.</p>
81<p>This method returns a list of menu items.
82Each item is itself a list defining the text to
83appear in the menu, a tool-tip help text, and a
84call-back method.</p>
85<table class="docutils field-list" frame="void" rules="none">
86<col class="field-name" />
87<col class="field-body" />
88<tbody valign="top">
89<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
90<li><strong>graph</strong> &#8211; the Graph object to which we attach the context menu</li>
91</ul>
92</td>
93</tr>
94<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list of menu items with call-back function</p>
95</td>
96</tr>
97</tbody>
98</table>
99</dd></dl>
100
101<dl class="method">
102<dt id="sans.guiframe.dummyapp.TestPlugin.get_panels">
103<tt class="descname">get_panels</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_panels" title="Permalink to this definition">¶</a></dt>
104<dd><p>Create and return the list of wx.Panels for your plug-in.
105Define the plug-in perspective.</p>
106<p>Panels should inherit from DefaultPanel defined below,
107or should present the same interface. They must define
108&#8220;window_caption&#8221; and &#8220;window_name&#8221;.</p>
109<table class="docutils field-list" frame="void" rules="none">
110<col class="field-name" />
111<col class="field-body" />
112<tbody valign="top">
113<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
114<li><strong>parent</strong> &#8211; parent window</li>
115</ul>
116</td>
117</tr>
118<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">list of panels</p>
119</td>
120</tr>
121</tbody>
122</table>
123</dd></dl>
124
125<dl class="method">
126<dt id="sans.guiframe.dummyapp.TestPlugin.get_perspective">
127<tt class="descname">get_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_perspective" title="Permalink to this definition">¶</a></dt>
128<dd>Get the list of panel names for this perspective</dd></dl>
129
130<dl class="method">
131<dt id="sans.guiframe.dummyapp.TestPlugin.get_tools">
132<tt class="descname">get_tools</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_tools" title="Permalink to this definition">¶</a></dt>
133<dd>Returns a set of menu entries for tools</dd></dl>
134
135<dl class="method">
136<dt id="sans.guiframe.dummyapp.TestPlugin.on_perspective">
137<tt class="descname">on_perspective</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.on_perspective" title="Permalink to this definition">¶</a></dt>
138<dd><p>Call back function for the perspective menu item.
139We notify the parent window that the perspective
140has changed.</p>
141<table class="docutils field-list" frame="void" rules="none">
142<col class="field-name" />
143<col class="field-body" />
144<tbody valign="top">
145<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
146<li><strong>event</strong> &#8211; menu event</li>
147</ul>
148</td>
149</tr>
150</tbody>
151</table>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.guiframe.dummyapp.TestPlugin.populate_menu">
156<tt class="descname">populate_menu</tt><big>(</big><em>id</em>, <em>parent</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.populate_menu" title="Permalink to this definition">¶</a></dt>
157<dd><p>Create and return the list of application menu
158items for the plug-in.</p>
159<table class="docutils field-list" frame="void" rules="none">
160<col class="field-name" />
161<col class="field-body" />
162<tbody valign="top">
163<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
164<li><strong>id</strong> &#8211; deprecated. Un-used.</li>
165<li><strong>parent</strong> &#8211; parent window</li>
166</ul>
167</td>
168</tr>
169<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">plug-in menu</p>
170</td>
171</tr>
172</tbody>
173</table>
174</dd></dl>
175
176<dl class="method">
177<dt id="sans.guiframe.dummyapp.TestPlugin.post_init">
178<tt class="descname">post_init</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.post_init" title="Permalink to this definition">¶</a></dt>
179<dd>Post initialization call back to close the loose ends</dd></dl>
180
181<dl class="method">
182<dt id="sans.guiframe.dummyapp.TestPlugin.set_default_perspective">
183<tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.set_default_perspective" title="Permalink to this definition">¶</a></dt>
184<dd>Call back method that True to notify the parent that the current plug-in
185can be set as default  perspective.
186when returning False, the plug-in is not candidate for an automatic
187default perspective setting</dd></dl>
188
189</dd></dl>
190
191</div>
192</div>
193
194
195          </div>
196        </div>
197      </div>
198      <div class="sphinxsidebar">
199        <div class="sphinxsidebarwrapper">
200  <h3><a href="../index.html">Table Of Contents</a></h3>
201  <ul>
202<li><a class="reference internal" href="#">dummyapp</a><ul>
203<li><a class="reference internal" href="#module-sans.guiframe.dummyapp"><tt class="docutils literal"><span class="pre">sans.guiframe.dummyapp</span></tt></a></li>
204</ul>
205</li>
206</ul>
207
208  <h4>Previous topic</h4>
209  <p class="topless"><a href="dataFitting.html"
210                        title="previous chapter">dataFitting</a></p>
211  <h4>Next topic</h4>
212  <p class="topless"><a href="gui_manager.html"
213                        title="next chapter">gui_manager</a></p>
214  <h3>This Page</h3>
215  <ul class="this-page-menu">
216    <li><a href="../_sources/api/dummyapp.txt"
217           rel="nofollow">Show Source</a></li>
218  </ul>
219<div id="searchbox" style="display: none">
220  <h3>Quick search</h3>
221    <form class="search" action="../search.html" method="get">
222      <input type="text" name="q" size="18" />
223      <input type="submit" value="Go" />
224      <input type="hidden" name="check_keywords" value="yes" />
225      <input type="hidden" name="area" value="default" />
226    </form>
227    <p class="searchtip" style="font-size: 90%">
228    Enter search terms or a module, class or function name.
229    </p>
230</div>
231<script type="text/javascript">$('#searchbox').show(0);</script>
232        </div>
233      </div>
234      <div class="clearer"></div>
235    </div>
236    <div class="related">
237      <h3>Navigation</h3>
238      <ul>
239        <li class="right" style="margin-right: 10px">
240          <a href="../genindex.html" title="General Index"
241             >index</a></li>
242        <li class="right" >
243          <a href="../py-modindex.html" title="Python Module Index"
244             >modules</a> |</li>
245        <li class="right" >
246          <a href="gui_manager.html" title="gui_manager"
247             >next</a> |</li>
248        <li class="right" >
249          <a href="dataFitting.html" title="dataFitting"
250             >previous</a> |</li>
251        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
252          <li><a href="index.html" >Reference</a> &raquo;</li> 
253      </ul>
254    </div>
255    <div class="footer">
256        &copy; Copyright 2010, sans group.
257      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
258    </div>
259  </body>
260</html>
Note: See TracBrowser for help on using the repository browser.