source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/xxx.html

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation

File size: 8.3 KB
RevLine 
[89]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
[104]9    <title>xxx.pro (SAXO Documentation)</title>
[89]10
11   
[191]12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="xxx.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../ToBeReviewed/WIDGET//xxx.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
[189]74<a href="xx.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="xxx.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/WIDGET/</a></h1>
[89]82      <h2 class="pro_file">xxx.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[151]89      <div id="file_comments">
[189]90 see <a href="../../../xmldoc/mini_notice.html">Mini Guide for Basic Commands in the XXX Program</a>
[157]91
92
[151]93 A maximum of possibilities with a minimum of clics
94</div>
[89]95
96     
97
98     
99
100     
101
102     
103      <div id="routine_summary">               
104        <h2>Routine summary</h2>
105       
106        <dl>
107         
108          <dt><p><a href="#_xxx_event">xxx_event<span class="result">, event</span></a></p><dt>
[234]109          <dd> </dd>   
[89]110         
111          <dt><p><a href="#_xxx">xxx<span class="result">, datafilename, idlfile, argspro</span>, CALLERWIDID=<span class="result">CALLERWIDID</span>, REDRAW=<span class="result">REDRAW</span>, SEPARATE=<span class="result">SEPARATE</span>, UVALUE=<span class="result">UVALUE</span>, RESTORE=<span class="result">RESTORE</span>, _EXTRA=<span class="result">_EXTRA</span></a></p><dt>
[151]112          <dd> </dd>   
[89]113               
114        </dl>
115      </div>
116     
117
118      <div id="routine_details">
119       
120
121        <div class="routine_details" id="_xxx_event">
122
[157]123          <h2><a class="top" href="#container">top</a>xxx_event <span class="categories">
[234]124</span></h2>
[89]125       
126          <p class="header">
127            xxx_event<span class="result">, <a href="#_xxx_event_param_event">event</a></span></p>
128       
[234]129          <div class="comments">
130</div>
[89]131
[157]132          <h3>Return value</h3><div class="preformat">
[234]133</div>
[89]134
135         
136            <h3>Parameters</h3>
137       
138           
139            <h4 id="_xxx_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140             
141             
142             
143             
144             
145             
146             
147             
148            </h4>
149       
[157]150          <div class="comments">
151</div>
[89]152           
153
154         
155
156         
157
[157]158          <h3>Examples</h3><div class="preformat">
[234]159</div>
[157]160          <h3>Version history</h3>
[89]161         
[234]162          <h4>Version</h4><div class="preformat">
[402]163 $Id: xxx.pro 370 2008-08-07 07:59:15Z pinsard $
[338]164</div>
[157]165          <h4>History</h4><div class="preformat">
[234]166</div>
[89]167         
168         
[157]169          <h3>Known issues</h3>
[89]170         
171         
172         
[157]173          <h4>Restrictions</h4><div class="preformat">
[234]174</div>
[89]175       
[157]176          <h3>Other attributes</h3>
[89]177         
178         
[157]179          <h4>Uses routines</h4><div class="preformat">
[234]180</div>
[89]181         
182         
183         
184       
[163]185          <h3>Statistics</h3>
186          <table class="statistics">
187            <tr><td>McCabe cyclic</td><td>          25</td></tr>
188            <tr><td>McCabe essential</td><td>           1</td></tr>
189            <tr><td>McCabe modular design</td><td>           1</td></tr>
190          </table>
[89]191         
192       
193        </div>
194       
195
196        <div class="routine_details" id="_xxx">
197
[151]198          <h2><a class="top" href="#container">top</a>xxx <span class="categories">
[157]199 Widget
[234]200</span></h2>
[89]201       
202          <p class="header">
203            xxx<span class="result">, <a href="#_xxx_param_datafilename">datafilename</a>, <a href="#_xxx_param_idlfile">idlfile</a>, <a href="#_xxx_param_argspro">argspro</a></span>, <a href="#_xxx_keyword_CALLERWIDID">CALLERWIDID</a>=<span class="result">CALLERWIDID</span>, <a href="#_xxx_keyword_REDRAW">REDRAW</a>=<span class="result">REDRAW</span>, <a href="#_xxx_keyword_SEPARATE">SEPARATE</a>=<span class="result">SEPARATE</span>, <a href="#_xxx_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_xxx_keyword_RESTORE">RESTORE</a>=<span class="result">RESTORE</span>, <a href="#_xxx_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
204       
[151]205          <div class="comments">
206</div>
[89]207
208         
209
210         
211            <h3>Parameters</h3>
212       
213           
214            <h4 id="_xxx_param_datafilename">datafilename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215             
216             
217             
218             
219             
220             
221             
222             
223            </h4>
224       
[151]225          <div class="comments">
226</div>
[89]227           
228            <h4 id="_xxx_param_idlfile">idlfile&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
229             
230             
231             
232             
233             
234             
235             
236             
237            </h4>
238       
[151]239          <div class="comments">
240</div>
[89]241           
242            <h4 id="_xxx_param_argspro">argspro&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
243             
244             
245             
246             
247             
248             
249             
250             
251            </h4>
252       
[151]253          <div class="comments">
254</div>
[89]255           
256
257         
258
259         
260
261            <h3>Keywords</h3>
262           
263            <h4 id="_xxx_keyword_CALLERWIDID">CALLERWIDID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
264             
265             
266             
267             
268             
269             
270             
271             
272            </h4>
273       
[163]274            <div class="comments">
275</div>
[89]276           
277            <h4 id="_xxx_keyword_REDRAW">REDRAW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
278             
279             
280             
281             
282             
283             
284             
285             
286            </h4>
287       
[163]288            <div class="comments">
[234]289
[163]290</div>
[89]291           
292            <h4 id="_xxx_keyword_SEPARATE">SEPARATE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
293             
294             
295             
296             
297             
298             
299             
300             
301            </h4>
302       
[151]303            <div class="comments">
304 To separate the button part and the drawing part in 2 windows.
[234]305 Useful for small screens, but be careful to do not saturate the
[151]306 video memory of some antiquated Tx.
[163]307
308
309
[151]310</div>
[89]311           
312            <h4 id="_xxx_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
313             
314             
315             
316             
317             
318             
319             
320             
321            </h4>
322       
[234]323            <div class="comments">
[163]324 The user value to be associated with the widget.
325</div>
[89]326           
327            <h4 id="_xxx_keyword_RESTORE">RESTORE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
328             
329             
330             
331             
332             
333             
334             
335             
336            </h4>
337       
[151]338            <div class="comments">
[234]339 'toto.dat' or toto.dat is a file created at the time of a precedent
[151]340 use of xxx thanks to the command "Widget" of the menu "save as".
[234]341</div>
[89]342           
343            <h4 id="_xxx_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
344             
345             
346             
347             
348             
349             
350             
351             
352            </h4>
353       
[151]354            <div class="comments">
[234]355 Used to pass keywords
[151]356</div>
[89]357           
358         
359
360         
[151]361          <h3>Version history</h3>
[89]362         
[151]363          <h4>Version</h4><div class="preformat">
[402]364 $Id: xxx.pro 370 2008-08-07 07:59:15Z pinsard $
[151]365</div>
[157]366          <h4>History</h4><div class="preformat">
367 Sebastien Masson (smasson@lodyc.jussieu.fr)
368</div>
[89]369         
370         
[151]371          <h3>Known issues</h3>
[89]372         
373         
[151]374          <h4>Todo items</h4><div class="preformat">
375 seb: documenter le reste des keywords
376</div>
[89]377         
378       
[151]379          <h3>Other attributes</h3>
[89]380         
381         
[151]382          <h4>Uses routines</h4><div class="preformat">
[402]383 <a href="../..//Obsolete/common.html">common</a>
[151]384</div>
[89]385         
386         
387         
388       
[163]389          <h3>Statistics</h3>
390          <table class="statistics">
391            <tr><td>McCabe cyclic</td><td>          33</td></tr>
392            <tr><td>McCabe essential</td><td>           1</td></tr>
393            <tr><td>McCabe modular design</td><td>           1</td></tr>
394          </table>
[89]395         
396       
397        </div>
398       
399      </div>
400
401     
402
403      <div id="tagline">Produced by IDLdoc 2.0.</div>
404
405    </div>
406
407  </body>
[249]408</html>
Note: See TracBrowser for help on using the repository browser.