source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slide_slice.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 11.0 KB
Line 
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>
9    <title>cw_slide_slice.pro (SAXO Documentation)</title>
10
11   
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" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="cw_slide_slice.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../../ToBeReviewed/WIDGET/COMPOUND_WIDGET//cw_slide_slice.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
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
74<a href="cw_pagelayout.html">&lt;&lt;prev file</a> | <a href="cw_slider_pm.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cw_slide_slice.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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</a></h1>
82      <h2 class="pro_file">cw_slide_slice.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92
93
94
95
96</div>
97
98     
99
100     
101
102     
103
104     
105      <div id="routine_summary">               
106        <h2>Routine summary</h2>
107       
108        <dl>
109         
110          <dt><p><a href="#_cw_slide_slice_set_value">cw_slide_slice_set_value<span class="result">, id, value</span></a></p><dt>
111          <dd> </dd>   
112         
113          <dt><p><a href="#_cw_slide_slice_event"><span class="result">result = </span>cw_slide_slice_event(<span class="result">event</span>)</a></p><dt>
114          <dd> </dd>   
115         
116          <dt><p><a href="#_cw_slide_slice"><span class="result">result = </span>cw_slide_slice(<span class="result">parent</span>, boxzoom=<span class="result">boxzoom</span>, UVALUE=<span class="result">UVALUE</span>, UNAME=<span class="result">UNAME</span>, FRAME=<span class="result">FRAME</span>, ROW=<span class="result">ROW</span>, COLUMN=<span class="result">COLUMN</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
117          <dd> </dd>   
118               
119        </dl>
120      </div>
121     
122
123      <div id="routine_details">
124       
125
126        <div class="routine_details" id="_cw_slide_slice_set_value">
127
128          <h2><a class="top" href="#container">top</a>cw_slide_slice_set_value <span class="categories">
129 Compound widget
130</span></h2>
131       
132          <p class="header">
133            cw_slide_slice_set_value<span class="result">, <a href="#_cw_slide_slice_set_value_param_id">id</a>, <a href="#_cw_slide_slice_set_value_param_value">value</a></span></p>
134       
135          <div class="comments">
136</div>
137
138          <h3>Return value</h3><div class="preformat">
139</div>
140
141         
142            <h3>Parameters</h3>
143       
144           
145            <h4 id="_cw_slide_slice_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146             
147             
148             
149             
150             
151             
152             
153             
154            </h4>
155       
156          <div class="comments">
157</div>
158           
159            <h4 id="_cw_slide_slice_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160             
161             
162             
163             
164             
165             
166             
167             
168            </h4>
169       
170          <div class="comments">
171 It is the default tick mark value (a floating-point number).
172</div>
173           
174
175         
176
177         
178
179          <h3>Examples</h3><div class="preformat">
180</div>
181          <h3>Version history</h3>
182         
183          <h4>Version</h4><div class="preformat">
184 $Id: cw_slide_slice.pro 232 2007-03-20 16:59:36Z pinsard $</div>
185          <h4>History</h4><div class="preformat">
186</div>
187         
188         
189          <h3>Known issues</h3>
190         
191         
192         
193          <h4>Restrictions</h4><div class="preformat">
194</div>
195       
196          <h3>Other attributes</h3>
197         
198         
199          <h4>Uses routines</h4><div class="preformat">
200</div>
201         
202         
203         
204       
205          <h3>Statistics</h3>
206          <table class="statistics">
207            <tr><td>McCabe cyclic</td><td>           4</td></tr>
208            <tr><td>McCabe essential</td><td>           1</td></tr>
209            <tr><td>McCabe modular design</td><td>           1</td></tr>
210          </table>
211         
212       
213        </div>
214       
215
216        <div class="routine_details" id="_cw_slide_slice_event">
217
218          <h2><a class="top" href="#container">top</a>cw_slide_slice_event <span class="categories">
219 Compound widget
220</span></h2>
221       
222          <p class="header">
223            <span class="result">result = </span>cw_slide_slice_event(<span class="result"><a href="#_cw_slide_slice_event_param_event">event</a></span>)</p>
224       
225          <div class="comments">
226</div>
227
228          <h3>Return value</h3><div class="preformat">
229</div>
230
231         
232            <h3>Parameters</h3>
233       
234           
235            <h4 id="_cw_slide_slice_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237             
238             
239             
240             
241             
242             
243             
244            </h4>
245       
246          <div class="comments">
247</div>
248           
249
250         
251
252         
253
254          <h3>Examples</h3><div class="preformat">
255</div>
256          <h3>Version history</h3>
257         
258          <h4>Version</h4><div class="preformat">
259 $Id: cw_slide_slice.pro 232 2007-03-20 16:59:36Z pinsard $</div>
260          <h4>History</h4><div class="preformat">
261</div>
262         
263         
264          <h3>Known issues</h3>
265         
266         
267         
268          <h4>Restrictions</h4><div class="preformat">
269</div>
270       
271          <h3>Other attributes</h3>
272         
273         
274          <h4>Uses routines</h4><div class="preformat">
275</div>
276         
277         
278         
279       
280          <h3>Statistics</h3>
281          <table class="statistics">
282            <tr><td>McCabe cyclic</td><td>           6</td></tr>
283            <tr><td>McCabe essential</td><td>           1</td></tr>
284            <tr><td>McCabe modular design</td><td>           1</td></tr>
285          </table>
286         
287       
288        </div>
289       
290
291        <div class="routine_details" id="_cw_slide_slice">
292
293          <h2><a class="top" href="#container">top</a>cw_slide_slice <span class="categories">
294 Compound widget
295</span></h2>
296       
297          <p class="header">
298            <span class="result">result = </span>cw_slide_slice(<span class="result"><a href="#_cw_slide_slice_param_parent">parent</a></span>, <a href="#_cw_slide_slice_keyword_boxzoom">boxzoom</a>=<span class="result">boxzoom</span>, <a href="#_cw_slide_slice_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_slide_slice_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_slide_slice_keyword_FRAME">FRAME</a>=<span class="result">FRAME</span>, <a href="#_cw_slide_slice_keyword_ROW">ROW</a>=<span class="result">ROW</span>, <a href="#_cw_slide_slice_keyword_COLUMN">COLUMN</a>=<span class="result">COLUMN</span>, <a href="#_cw_slide_slice_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
299       
300          <div class="comments">
301</div>
302
303          <h3>Return value</h3><div class="preformat">
304</div>
305
306         
307            <h3>Parameters</h3>
308       
309           
310            <h4 id="_cw_slide_slice_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
311              <span class="attr">in</span>
312             
313             
314              <span class="attr">required</span>
315             
316             
317             
318             
319            </h4>
320       
321          <div class="comments">
322 The widget ID of the parent widget.
323</div>
324           
325
326         
327
328         
329
330            <h3>Keywords</h3>
331           
332            <h4 id="_cw_slide_slice_keyword_boxzoom">boxzoom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
333             
334             
335             
336             
337             
338             
339             
340             
341            </h4>
342       
343            <div class="comments">
344 Vector indicating the geographic zone on which we want to cut the map.
345 If BOXZOOM has :
346   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
347   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
348   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
349   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
350   6 elements: The extraction is made on Boxzoom
351 Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
352</div>
353           
354            <h4 id="_cw_slide_slice_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
355             
356             
357             
358             
359             
360             
361             
362             
363            </h4>
364       
365            <div class="comments">
366 The user value to be associated with the widget.
367</div>
368           
369            <h4 id="_cw_slide_slice_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
370             
371             
372             
373             
374             
375             
376             
377             
378            </h4>
379       
380            <div class="comments">
381 The user name to be associated with the widget.
382</div>
383           
384            <h4 id="_cw_slide_slice_keyword_FRAME">FRAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
385             
386             
387             
388             
389             
390             
391             
392             
393            </h4>
394       
395            <div class="comments">
396 Specifies the width of the frame to be drawn around the base.
397</div>
398           
399            <h4 id="_cw_slide_slice_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
400             
401             
402             
403             
404             
405             
406             
407             
408            </h4>
409       
410            <div class="comments">
411 Buttons will be arranged in the number of rows
412 specified by this keyword.
413</div>
414           
415            <h4 id="_cw_slide_slice_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
416             
417             
418             
419             
420             
421             
422             
423             
424            </h4>
425       
426            <div class="comments">
427 Buttons will be arranged in the number of columns
428 specified by this keyword.
429</div>
430           
431            <h4 id="_cw_slide_slice_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
432             
433             
434             
435             
436             
437             
438             
439             
440            </h4>
441       
442            <div class="comments">
443 Used to pass keywords
444</div>
445           
446         
447
448          <h3>Examples</h3><div class="preformat">
449</div>
450          <h3>Version history</h3>
451         
452          <h4>Version</h4><div class="preformat">
453 $Id: cw_slide_slice.pro 232 2007-03-20 16:59:36Z pinsard $
454</div>
455          <h4>History</h4><div class="preformat">
456</div>
457         
458         
459          <h3>Known issues</h3>
460         
461         
462          <h4>Todo items</h4><div class="preformat">
463 seb: documenter
464</div>
465          <h4>Restrictions</h4><div class="preformat">
466</div>
467       
468          <h3>Other attributes</h3>
469         
470         
471          <h4>Uses routines</h4><div class="preformat">
472</div>
473         
474         
475         
476       
477          <h3>Statistics</h3>
478          <table class="statistics">
479            <tr><td>McCabe cyclic</td><td>           8</td></tr>
480            <tr><td>McCabe essential</td><td>           1</td></tr>
481            <tr><td>McCabe modular design</td><td>           1</td></tr>
482          </table>
483         
484       
485        </div>
486       
487      </div>
488
489     
490
491      <div id="tagline">Produced by IDLdoc 2.0.</div>
492
493    </div>
494
495  </body>
496</html>
Note: See TracBrowser for help on using the repository browser.